Partner Subscriptions

Partner endpoints for subscription management — list subscriptions, view subscription details, manage self-service checkout flows, and handle subscription updates within the partner context.

Retrieve existing subscription update checkout basket (Partner)

get

Partner endpoint to fetch existing basket by basketId from landing state cookie. Used to retrieve current checkout state after page refresh or navigation.

Requires partner authentication.

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>

Header parameters

CookiestringRequired

Landing state cookie containing basketId

Responses

200

Basket retrieved successfully

application/json

completedbooleanOptional

Whether the checkout is completed

401

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

application/json

404

No basket found in landing state

application/json

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

get

/partner/checkout/subscription

HTTPcURLJavaScriptPython

GET /api/partner/checkout/subscription HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Cookie: text
Accept: */*

{
  "order": {
    "checkoutId": "basket-12345-uuid",
    "external_id": "text",
    "order_type": "update_subscription",
    "forSubscription": {
      "id": "text",
      "name": "text"
    },
    "forSubscriptionOffer": {
      "offerId": "text"
    },
    "orderItems": [
      {
        "id": "text",
        "orderItemActionType": "add",
        "type": "offer",
        "offerId": "text",
        "quantity": 1,
        "price": {},
        "orderLineItem": {},
        "effective_date": "2026-03-24T22:08:28.111Z"
      }
    ],
    "country": "US",
    "source": "shop",
    "effectiveDate": "2026-03-24T22:08:28.111Z",
    "total": {
      "currency": "USD",
      "orderSubtotal": 1,
      "orderTotal": 1,
      "totalOrderDiscounts": 1,
      "amount": 1
    }
  },
  "nextActions": {
    "upgrades": [
      {
        "id": "offer_premium_monthly",
        "name": "Premium Monthly Plan",
        "description": "text",
        "price": {
          "currency": "USD",
          "amount": 29.99
        },
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "downgrades": [
      {
        "id": "offer_premium_monthly",
        "name": "Premium Monthly Plan",
        "description": "text",
        "price": {
          "currency": "USD",
          "amount": 29.99
        },
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "crossSells": [
      {
        "id": "offer_premium_monthly",
        "name": "Premium Monthly Plan",
        "description": "text",
        "price": {
          "currency": "USD",
          "amount": 29.99
        },
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "subscriptionAddOns": [
      {
        "id": "offer_premium_monthly",
        "name": "Premium Monthly Plan",
        "description": "text",
        "price": {
          "currency": "USD",
          "amount": 29.99
        },
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "selectOffer": true
  },
  "completed": true,
  "context": {
    "client_ip": "text",
    "requestId": "text",
    "identity_id": "text"
  },
  "journey": {
    "referrer": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Initiate subscription update checkout (Partner)

post

Partner endpoint to create a new basket for subscription updates with available upgrade/downgrade options. This is the first step in updating a subscription - it creates a basket and returns available actions.

Returns:

• Basket with available upgrades, downgrades, cross-sells, and add-ons

• Sets landing state cookie with basketId for subsequent requests

Status 423: Subscription has pending change (locked until date passes)

Requires partner authentication.

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>

Header parameters

xLimioRecaptchastringRequired

reCAPTCHA token for bot prevention

xForwardedForstringOptional

Client IP address

refererstringOptional

Referrer URL for journey tracking

Body

application/json

trackingobjectOptional

Optional tracking data for analytics and reporting

Responses

200

Checkout basket created successfully

application/json

400

Invalid request body or missing required fields

application/json

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

application/json

423

Subscription has pending change, checkout locked

application/json

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

/partner/checkout/subscription

HTTPcURLJavaScriptPython

POST /api/partner/checkout/subscription HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
xLimioRecaptcha: text
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "order": {
    "external_id": "ext-12345",
    "forSubscription": {
      "id": "sub_abc123"
    },
    "order_type": "update_subscription"
  }
}

Basic subscription checkout initiationInitiate by subscription nameWith tracking and external IDPre-select target offer

{
  "order": {
    "checkoutId": "basket-12345-uuid",
    "external_id": "text",
    "order_type": "update_subscription",
    "forSubscription": {
      "id": "text",
      "name": "text"
    },
    "forSubscriptionOffer": {
      "offerId": "text"
    },
    "orderItems": [
      {
        "id": "text",
        "orderItemActionType": "add",
        "type": "offer",
        "offerId": "text",
        "quantity": 1,
        "price": {},
        "orderLineItem": {},
        "effective_date": "2026-03-24T22:08:28.111Z"
      }
    ],
    "country": "US",
    "source": "shop",
    "effectiveDate": "2026-03-24T22:08:28.111Z",
    "total": {
      "currency": "USD",
      "orderSubtotal": 1,
      "orderTotal": 1,
      "totalOrderDiscounts": 1,
      "amount": 1
    }
  },
  "nextActions": {
    "upgrades": [
      {
        "id": "offer_premium_monthly",
        "name": "Premium Monthly Plan",
        "description": "text",
        "price": {
          "currency": "USD",
          "amount": 29.99
        },
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "downgrades": [
      {
        "id": "offer_premium_monthly",
        "name": "Premium Monthly Plan",
        "description": "text",
        "price": {
          "currency": "USD",
          "amount": 29.99
        },
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "crossSells": [
      {
        "id": "offer_premium_monthly",
        "name": "Premium Monthly Plan",
        "description": "text",
        "price": {
          "currency": "USD",
          "amount": 29.99
        },
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "subscriptionAddOns": [
      {
        "id": "offer_premium_monthly",
        "name": "Premium Monthly Plan",
        "description": "text",
        "price": {
          "currency": "USD",
          "amount": 29.99
        },
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "selectOffer": true
  },
  "completed": true,
  "context": {
    "client_ip": "text",
    "requestId": "text",
    "identity_id": "text"
  },
  "journey": {
    "referrer": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Update subscription checkout basket (Partner)

put

Partner endpoint to update existing basket with order items (add/remove offers and add-ons).

Business Logic:

• Only 1 add offer allowed per request

• System auto-adds remove action for current subscription offer when adding new offer

• System auto-removes incompatible add-ons when switching subscription offers

• System calculates prices, line items, and effective dates

• Cross-sells are recalculated based on updated basket

Requirements:

• basketId must be present in landing state cookie (from POST response)

• Basket must be accessible by partner

Requires partner authentication.

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>

Header parameters

xLimioRecaptchastringRequired

reCAPTCHA token for bot prevention

CookiestringRequired

Landing state cookie containing basketId

Body

application/json

Responses

200

Basket updated successfully

application/json

completedbooleanOptional

Whether the checkout is completed

400

Invalid request or multiple add offers provided

application/json

401

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

application/json

404

Basket not found in landing state

application/json

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

put

/partner/checkout/subscription

HTTPcURLJavaScriptPython

PUT /api/partner/checkout/subscription HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
xLimioRecaptcha: text
Cookie: text
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "order": {
    "forSubscription": {
      "id": "sub_abc123"
    },
    "order_type": "update_subscription",
    "orderItems": [
      {
        "orderItemActionType": "add",
        "type": "offer",
        "offerId": "offer_premium_annual",
        "quantity": 1
      }
    ]
  }
}

Upgrade to premium subscriptionAdd subscription add-onAdd multiple add-ons

{
  "order": {
    "checkoutId": "basket-12345-uuid",
    "external_id": "text",
    "order_type": "update_subscription",
    "forSubscription": {
      "id": "text",
      "name": "text"
    },
    "forSubscriptionOffer": {
      "offerId": "text"
    },
    "orderItems": [
      {
        "id": "text",
        "orderItemActionType": "add",
        "type": "offer",
        "offerId": "text",
        "quantity": 1,
        "price": {},
        "orderLineItem": {},
        "effective_date": "2026-03-24T22:08:28.111Z"
      }
    ],
    "country": "US",
    "source": "shop",
    "effectiveDate": "2026-03-24T22:08:28.111Z",
    "total": {
      "currency": "USD",
      "orderSubtotal": 1,
      "orderTotal": 1,
      "totalOrderDiscounts": 1,
      "amount": 1
    }
  },
  "nextActions": {
    "upgrades": [
      {
        "id": "offer_premium_monthly",
        "name": "Premium Monthly Plan",
        "description": "text",
        "price": {
          "currency": "USD",
          "amount": 29.99
        },
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "downgrades": [
      {
        "id": "offer_premium_monthly",
        "name": "Premium Monthly Plan",
        "description": "text",
        "price": {
          "currency": "USD",
          "amount": 29.99
        },
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "crossSells": [
      {
        "id": "offer_premium_monthly",
        "name": "Premium Monthly Plan",
        "description": "text",
        "price": {
          "currency": "USD",
          "amount": 29.99
        },
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "subscriptionAddOns": [
      {
        "id": "offer_premium_monthly",
        "name": "Premium Monthly Plan",
        "description": "text",
        "price": {
          "currency": "USD",
          "amount": 29.99
        },
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "selectOffer": true
  },
  "completed": true,
  "context": {
    "client_ip": "text",
    "requestId": "text",
    "identity_id": "text"
  },
  "journey": {
    "referrer": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get Partner Self-Service Checkout

get

Retrieve the current self-service checkout state for a partner-managed subscription update. Returns the basket with available actions.

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>

Responses

200

Self-service checkout state retrieved.

application/json

objectOptional

401

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

application/json

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

get

/partner/mma/checkout

HTTPcURLJavaScriptPython

GET /api/partner/mma/checkout HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Initiate Partner Self-Service Checkout

post

Create a self-service checkout session for updating a partner-managed subscription. Returns available upgrade, downgrade, and add-on options.

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

objectOptional

Responses

200

Self-service checkout session created.

application/json

objectOptional

401

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

application/json

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

/partner/mma/checkout

HTTPcURLJavaScriptPython

POST /api/partner/mma/checkout HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{}

Update Partner Self-Service Checkout

put

Update the self-service checkout basket for a partner-managed subscription. Add or remove offers and add-ons from the basket.

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

objectOptional

Responses

200

Self-service checkout updated.

application/json

objectOptional

401

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

application/json

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

put

/partner/mma/checkout

HTTPcURLJavaScriptPython

PUT /api/partner/mma/checkout HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{}

List Partner Subscriptions

get

Retrieve subscriptions visible to the authenticated partner organisation. Can optionally filter by owner ID to list subscriptions for a specific customer within the partner 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>

Query parameters

ownerIdstringOptional

Filter subscriptions by owner (customer) ID.

Responses

200

List of subscriptions.

application/json

itemsobject[]Optional

Subscription objects.

queryMorestringOptional

Pagination token for the next page of results.

401

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

application/json

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

get

/partner/mma/subscriptions

HTTPcURLJavaScriptPython

GET /api/partner/mma/subscriptions HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {}
  ],
  "queryMore": "text"
}

Get Partner Subscription Detail

get

Retrieve a single subscription with its related objects (schedule, offers, add-ons) within the partner organisation context. Verifies the partner has access to the requested subscription.

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>

Path parameters

idstring · max: 64Required

The subscription ID.

Responses

200

Subscription detail with related objects.

application/json

subscriptionobjectOptional

The subscription object with related data.

scheduleobject[]Optional

The subscription's billing schedule.

offersobject[]Optional

Offers associated with the subscription.

addOnsobject[]Optional

Add-ons associated with the subscription.

401

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

application/json

403

Partner does not have access to this subscription.

404

Subscription not found.

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

get

/partner/mma/subscriptions/{id}

HTTPcURLJavaScriptPython

GET /api/partner/mma/subscriptions/{id} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "subscription": {},
  "schedule": [
    {}
  ],
  "offers": [
    {}
  ],
  "addOns": [
    {}
  ]
}