Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

The id of the subscription to update.

Body

application/json
trial_end
string<date-time>
required

ISO 8601 datetime, in UTC, when the trial ends and the first paid billing period begins. Must be at least one day in the future. Fintoc sets the subscription's billing_cycle_anchor to this time.

Example:

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

payment_method
string

Payment method ID to charge every next payment against, including any invoice that is already open. Must belong to the subscription's customer, be one of pac or card, and be active.

Example:

"pm_2c4mDhAbCdEfGhIjKlMnOpQrStu"

collection_method
enum<string>

The way Fintoc collects every invoice the subscription generates. One of charge_automatically or send_invoice. With charge_automatically, Fintoc charges payment_method on every billing cycle. With send_invoice, Fintoc leaves each invoice open for you to collect, through hosted_invoice_url or outside Fintoc. Switching to charge_automatically requires a payment method.

Available options:
charge_automatically,
send_invoice
Example:

"charge_automatically"

Response

The updated subscription. When you set trial_end, status is trialing until the trial ends. When you set payment_method, the subscription points to the new payment method. When you set collection_method, the subscription uses the new collection method from the next billing cycle.

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 leaves each invoice open for you to collect).

Available options:
charge_automatically,
send_invoice
Example:

"charge_automatically"

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 associated with the subscription, or null if it has none. Fintoc charges it on every billing cycle when collection_method is charge_automatically.

Example:

"pm_2c4mDhAbCdEfGhIjKlMnOpQrStu"

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