Update a subscription

patch

https://api.fintoc.com/v2/subscriptions/{id}

Updates a subscription. Provide at least one of trial_end or payment_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 be active, belong to the subscription's customer, and be a pac or card. 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.

Canceled subscriptions cannot be updated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The 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.

400Invalid request: provide trial_end, payment_method, or both. trial_end must be a valid ISO 8601 datetime and at least one day in the future.

401Invalid or missing API key.

404The subscription does not exist, belongs to another organization, or belongs to a different API key mode. The payment_method does not exist or belongs to a different customer.

409The subscription cannot be updated in its current state, for example because it is canceled.

422The payment_method cannot be used for this subscription. The payment method is inactive or has an unsupported type. Subscriptions accept pac or card, not bank_transfer.