Create a subscription
Creates a subscription that bills a customer on a recurring cadence, in the live or test mode of the API key used. Each item defines its price through price_data, referencing an existing product (product) or defining one inline (product_data). All items must share a compatible currency (CLF items bill alongside CLP) and the same recurring interval and interval_count. A subscription can have up to 10 items. The collection_method decides how Fintoc collects every invoice the subscription generates. With charge_automatically, the default, Fintoc charges payment_method on every billing cycle, so the payment method is required. With send_invoice, Fintoc leaves each invoice open for you to collect, and payment_method is optional. A payment_method must be active and have a type of pac or card; subscriptions do not support bank_transfer. Without trial_end or billing_cycle_anchor, Fintoc anchors the billing cycle at the creation time and finalizes an initial invoice immediately. With charge_automatically, the subscription starts incomplete and becomes active once that first payment succeeds. With send_invoice, the subscription starts active and the initial invoice stays open. For a zero-amount subscription, Fintoc marks the initial invoice paid and the subscription starts active. With trial_end, the subscription’s status is trialing. Fintoc sets the billing_cycle_anchor to the trial end and generates the first invoice when the trial ends. With billing_cycle_anchor, the subscription starts active. Fintoc issues no invoice until the anchor, then generates the first invoice for the full billing period that starts there. The anchor must be in the future and cannot be combined with trial_end.
Authorizations
Body
ID of the customer to bill.
"cus_2c4mDe9NJyGmMzvCqLkXqAtjnRu"
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.
10Show child attributes
Show child attributes
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.
charge_automatically, send_invoice "send_invoice"
Payment method to associate with the subscription. Required when collection_method is charge_automatically; optional with send_invoice. Must belong to the specified customer.
"pm_2c4mDhAbCdEfGhIjKlMnOpQrStu"
Set of key-value pairs to attach to the subscription. Nested objects and arrays are not allowed as values.
{ "internal_id": "12345" }
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.
"2030-07-08T00:00:00Z"
ISO 8601 timestamp in UTC of the first invoice and the start of every following billing period. Must be in the future. Fintoc issues no invoice before the anchor and does not charge for the time until then. Cannot be combined with trial_end. Omit to anchor the cycle at the creation time.
"2030-07-01T00:00:00Z"
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.
Show child attributes
Show child attributes
Response
Subscription created. Without trial_end or billing_cycle_anchor, Fintoc generates and finalizes the initial invoice immediately. Otherwise, Fintoc issues the first invoice at the trial end or at the anchor.
Unique identifier of the subscription.
"sub_2c4mDcMaVxDx7nT3o5GbPMQbS2v"
Type of the object. Always subscription.
ISO 8601 timestamp that anchors the billing cycle. Fintoc measures every billing period from this anchor. Unless you set the anchor when creating the subscription, Fintoc uses the creation time, or trial_end when a trial applies. Fintoc issues no invoice before the anchor.
"2026-06-01T15:00:00Z"
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).
charge_automatically, send_invoice "charge_automatically"
ISO 8601 timestamp of when the subscription was created.
"2026-06-01T15:00:00Z"
ID of the customer the subscription bills.
"cus_2c4mDe9NJyGmMzvCqLkXqAtjnRu"
Items the subscription bills for on every billing cycle.
Show child attributes
Show child attributes
Set of key-value pairs attached to the subscription.
{ "order_id": "12345" }
Mode of the object. One of live or test. test subscriptions use fake data for integration testing and do not collect real money.
live, test "live"
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.
"pm_2c4mDhAbCdEfGhIjKlMnOpQrStu"
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).
active, canceled, incomplete, trialing "active"
ISO 8601 timestamp at which the trial period ends, or null if the subscription has no trial.
null
Was this page helpful?