For the complete documentation index, see llms.txt. This page is also available as Markdown.

Renew Subscription

Create checkout baskets to renew an existing subscription. The basket is pre-populated with the subscription's renewal context.

Create checkout basket to renew subscription

post

Create a checkout basket for renewing an existing subscription. Looks up the subscription by ID or reference, retrieves the customer's renewal details, and creates a basket pre-populated with the renewal context.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Body
Responses
200

Renewal checkout basket created successfully.

application/json
idstringRequired

The unique ID of the created renewal basket.

Example: basket-a1b2c3d4e5f6
segmentsstring[]Optional

Customer segments applicable to the renewal.

post/admin/checkout/initiate/renew

Last updated

Was this helpful?