Skip to main content
POST

Authorizations

Authorization
string
header
required

Body

application/json
customer
string
required

ID of the customer to bill.

Example:

"cus_2c4mDe9NJyGmMzvCqLkXqAtjnRu"

items
object[]
required

Items the subscription bills for on every billing cycle. All items must share a compatible currency (CLF bills alongside CLP) and the same recurring cadence. Up to 10 items.

Maximum array length: 10
collection_method
enum<string>

The way Fintoc collects every invoice the subscription generates. One of charge_automatically (Fintoc charges payment_method on every billing cycle) or send_invoice (Fintoc leaves each invoice open for you to collect). Defaults to charge_automatically.

Available options:
charge_automatically,
send_invoice
Example:

"send_invoice"

payment_method
string

Payment method to associate with the subscription. Required when collection_method is charge_automatically; optional with send_invoice. Must belong to the specified customer.

Example:

"pm_2c4mDhAbCdEfGhIjKlMnOpQrStu"

metadata
object

Set of key-value pairs to attach to the subscription. Nested objects and arrays are not allowed as values.

Example:
trial_end
string<date-time>

ISO 8601 timestamp in UTC at which the trial ends, at least one day in the future. During the trial the subscription's status is trialing and Fintoc issues no invoice; Fintoc generates the first invoice when the trial ends. Omit for no trial.

Example:

"2030-07-08T00:00:00Z"

business_profile
object

Business on whose behalf you collect the payment, for payment aggregators. Applied to every automatic charge of the subscription. Required if your organization identifies a business profile per payment.

Response

Subscription created. Fintoc generates and finalizes the initial invoice for the first billing period immediately.

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