Fetch upgrade profiles

This endpoint allows you to fetch all active upgrade profiles applicable to a subscription contract.

Token scope - Read Subscriptions

Rate limit - Global pool (i.e. 50 requests per second per domain)

Path param explained :

  • subscriptionId Id of the subscription. This can be passed in the following format :
    • {id} - where id is the Loop internal id of the subscription contract. This is the default path param format.
    • loop-{id} - where id is the Loop internal id of the subscription contract.
    • shopify-${id} - Where id is the shopifySubscriptionId of the subscription contract.

Key points to consider:

Single-Line Subscription

  • If the upgrade profile has multiple products mapped as upgrade options, all the available upgrade options will be returned.

Multi-Line Subscription

  • Upgrade offers are evaluated at the line-item level.
  • If a line item has an applicable SKU upgrade offer, only that SKU upgrade offer will be shown for that line item.
  • Other upgrade types are not applicable to multi-line subscriptions and will not be shown.
Path Params
int32
required

The unique identifier of the subscription in Loop.

Response

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