Update existing subscription


When updating a subscription, the nextDueDate parameter is used to indicate the due date of the next installment to be generated, meaning it does not update the due date of the already generated installment.

Additionally, when updating the subscription amount or payment method, only future installments will be affected. To update existing installments with the new payment method and/or amount, you need to pass the updatePendingPayments: true parameter.

📘

You can suspend the subscription by setting the status to INACTIVE. This will stop new billings from being generated until it is set to ACTIVE again. When resuming a subscription, it is mandatory to inform the nextDueDate of the next generated subscription.

Path Params
string
required
Body Params
string
enum
Allowed:
string
enum
Allowed:
date
discount
object
interest
object
fine
object
string
enum
Allowed:
string
date
boolean
string
split
array of objects
split
callback
object
Responses

404

Not found

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