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

bearerAuth

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

application/json

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.

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

404

Subscription not found for renewal.

502

Bad Gateway — an upstream service returned an unexpected response. This typically indicates an issue with the request payload (e.g. invalid field values, missing required fields) or a transient infrastructure error. Retry the request, and if the issue persists, verify the request body matches the expected schema.

application/json

post/admin/checkout/initiate/renew

HTTPcURLJavaScriptPython

POST /api/admin/checkout/initiate/renew HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "order": {
    "external_id": "renewal-2024-001",
    "subId": "text",
    "subRef": "text",
    "order_type": "renew",
    "verify": {
      "customerDetails": {
        "email": "[e-mail]"
      },
      "address": {}
    }
  },
  "expiresAfter": {
    "seconds": 1,
    "minutes": 1,
    "hours": 1,
    "days": 1
  }
}

{
  "id": "basket-a1b2c3d4e5f6",
  "segments": [
    "text"
  ],
  "order": {
    "external_id": "text",
    "order_type": "renew",
    "subId": "text",
    "subRef": "text",
    "customerDetails": {
      "firstName": "text",
      "lastName": "text",
      "email": "text"
    },
    "country": "text",
    "renewalDetails": {
      "subscription": {},
      "attributes": {}
    },
    "tracking": {},
    "hideEmailField": true,
    "hidePriceField": true
  }
}