Skip to main content
POST
Cancel a subscription
v2 · Base URL https://api.fintoc.com/v2

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

The id of the subscription to cancel.

Response

The canceled subscription, with status set to canceled.

id
string
required

Unique identifier of the subscription.

Example:

"sub_2c4mDcMaVxDx7nT3o5GbPMQbS2v"

object
any
required

Type of the object. Always subscription.

billing_cycle_anchor
string<date-time>
required

ISO 8601 timestamp that anchors the billing cycle. Fintoc sets this anchor to the subscription's creation time, or to trial_end when a trial applies. Fintoc measures every billing period from this anchor.

Example:

"2026-06-01T15:00:00Z"

collection_method
enum<string>
required

Method Fintoc uses to collect the invoices the subscription generates. One of charge_automatically (Fintoc charges the saved payment method) or send_invoice (Fintoc sends the invoice for the customer to pay). Subscriptions created through the API always use send_invoice.

Available options:
charge_automatically,
send_invoice
Example:

"send_invoice"

created_at
string<date-time>
required

ISO 8601 timestamp of when the subscription was created.

Example:

"2026-06-01T15:00:00Z"

customer
string
required

ID of the customer the subscription bills.

Example:

"cus_2c4mDe9NJyGmMzvCqLkXqAtjnRu"

items
object[]
required

Items the subscription bills for on every billing cycle.

metadata
object
required

Set of key-value pairs attached to the subscription.

Example:
mode
enum<string>
required

Mode of the object. One of live or test. test subscriptions use fake data for integration testing and do not collect real money.

Available options:
live,
test
Example:

"live"

payment_method
string | null
required

ID of the payment method charged when collection_method is charge_automatically. Always null for subscriptions created through the API.

Example:

null

status
enum<string>
required

Current status of the subscription. One of active, incomplete (the first invoice payment has not yet succeeded), trialing (the trial period has not ended), or canceled (the subscription stopped generating invoices).

Available options:
active,
canceled,
incomplete,
trialing
Example:

"active"

trial_end
string<date-time> | null
required

ISO 8601 timestamp at which the trial period ends, or null if the subscription has no trial.

Example:

null