Update a subscription
Updates a subscription. Provide at least one of trial_end, payment_method, or collection_method.
Provide trial_end to set when the trial ends and the first paid billing period begins. trial_end must be at least one day in the future. Fintoc aligns the subscription’s billing_cycle_anchor to trial_end and sets its status to trialing until then.
Provide payment_method to swap the payment method the subscription charges against. The payment method must belong to the subscription’s customer, be a pac or card, and be active. After the swap, Fintoc charges every next payment against the new payment method, including any invoice that is already open. Swapping does not charge the subscription immediately.
Provide collection_method to change the way Fintoc collects the invoices the subscription generates. Switching to charge_automatically requires a payment method Fintoc can charge, either in the same request or already associated. The change applies from the next billing cycle. Invoices that are already open keep their existing collection method.
Canceled subscriptions cannot be updated.
Autorizaciones
Parámetros de ruta
The id of the subscription to update.
Cuerpo
- Option 1
- Option 2
- Option 3
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.
"2026-07-01T15:00:00Z"
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.
"pm_2c4mDhAbCdEfGhIjKlMnOpQrStu"
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.
charge_automatically, send_invoice "charge_automatically"
Respuesta
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.
Unique identifier of the subscription.
"sub_2c4mDcMaVxDx7nT3o5GbPMQbS2v"
Type of the object. Always subscription.
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.
"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.
Set of key-value pairs attached to the subscription.
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