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. Fintoc charges each subscription automatically using payment_method, so the collection_method is always charge_automatically. Without trial_end, Fintoc sets the billing_cycle_anchor to the creation time and finalizes an initial invoice immediately. The subscription starts incomplete and becomes active once that first payment succeeds. 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

ID of the customer to bill.

string
required

Payment method to charge automatically on every billing cycle. Must belong to the specified customer.

items
array of objects
required
length ≤ 10

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.

items*
metadata
object

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

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.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json