Update a subscription

Update a subscription's details.

You can update a subscription and specific parameters based on the value of the state parameter:

State parameter value	Modifiable parameters
pending, active, overdue, paused	You can modify all listed parameters.
cancelled, finished	You cannot modify parameters. These are final states.

Common use cases:

• Update external reference: When you need to sync with updated customer records in your system, correct an initial reference value, or re-map the subscription to a different internal tracking ID to maintain consistency with your database.

Request​

Path parameters

Path parameters

The ID of the subscription.

Header parameters

Header parameters

Example: "Bearer sk_1234567890ABCdefGHIjklMNOpqrSTUvwxYZ_1234567890-Ab_cdeFGHijkLMNopq"

This parameter accepts the Merchant API Secret key to authorise requests coming from the merchant's backend.

It ensures that ensures that each request is authenticated and authorised by verifying the secret key. The secret key should be included in all request headers as a Bearer token.

Info

For more information, see: Authentication

Possible values: [2023-09-01, 2024-05-01, 2024-09-01, 2025-10-16]
Example: "2025-10-16"

The version of the Merchant API, specified in YYYY-MM-DD format.

If not specified, you will receive an error.

Info

For more information about API versioning, see: API versions.

Request body

Body object

Possible length: <= 1024 characters

Optional external reference for the subscription.

Use this field to store your own system's identifier for easy tracking and correlation.

Response​

Subscription updated successfully

Response body

Body object

Unique identifier for the subscription.

Possible length: <= 1024 characters

Optional external reference for the subscription.

Use this field to store your own system's identifier for easy tracking and correlation.

Possible values: [pending, active, overdue, paused, cancelled, finished]

The state of the subscription.

State	Description
pending	The subscription has been created but is not yet active. This typically occurs when awaiting the first payment or setup completion.
active	The subscription is currently active and billing cycles are processing normally.
overdue	The subscription has a failed payment and is awaiting resolution.
paused	The subscription has been temporarily paused and no billing will occur.
cancelled	The subscription has been cancelled and will not renew.
finished	The subscription has completed all billing cycles (for limited-duration subscriptions).

Unique identifier for the customer.

Unique identifier for the subscription plan.

Unique identifier for the subscription plan variation.

Possible values: [automatic, manual]

The type of payment method used for the subscription.

Type	Description
automatic	Payments are automatically charged to the customer's saved payment method.
manual	Payments require manual processing by the customer.

Unique identifier for the payment method.

The date and time the subscription was created in ISO 8601 format.

The date and time the subscription was last updated in ISO 8601 format.

The date and time the subscription started in ISO 8601 format.

This field is null until the subscription becomes active.

Unique identifier for the subscription cycle.

The ID of the order created for handling the setup payment for the subscription.

Use the Retrieve an order endpoint with this ID to get order details, including the checkout_url for redirecting customers to the Hosted Payment Page or the token for widget integration.

Note

The order is created in parallel to the subscription and is used to collect the initial payment and save the customer's payment method for future billing cycles.