v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Fetch upgrade profiles

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

get/2023-10/subscription/{subscriptionId}/upgrade

Path parameters

subscriptionIdinteger required

The unique identifier of the subscription in Loop.

Response

200

successboolean

Indicates whether the request was completed successfully.

messagestring

Provides additional context about the API response.

codestring

Response status code returned by Loop. For a successful request, this is usually SUCCESS.

pageInfostring

Pagination information for the response. This is null when there are no additional pages.

Example response

{
  "success": true,
  "message": "Fetched applicable upgrade profiles successfully",
  "data": [
    {
      "id": 587,
      "name": "Membership upgrade",
      "priority": 6,
      "shortDescription": "Membership Upgrade",
      "bannerTexts": [
        {
          "fieldKey": "upgradeFlowProfileBannerBody",
          "value": "Upgrade your subscription to get additional benefits!"
        }
      ],
      "drawerTexts": [
        {
          "fieldKey": "upgradeFlowProfileDrawerHeader",
          "value": "Membership Upgrade"
        }
      ],
      "existingProductInformation": {
        "name": "Best Kit membership",
        "imageUrl": "https://cdn.shopify.com/s/files/1/0676/9973/6730/files/Kit223.webp?v=1759934252",
        "productHandle": "best-kit",
        "quantity": 1,
        "basePrice": 100,
        "subscriptionDiscountedPrice": 100,
        "finalPrice": 100,
        "sellingPlanShopifyId": 202065543322,
        "sellingPlanName": "Deliver every 2 months",
        "deliveryInterval": "MONTH",
        "deliveryIntervalCount": 2,
        "variantShopifyId": 46646938730650
      },
      "newProductInformation": {
        "name": "5 star",
        "imageUrl": "https://cdn.shopify.com/s/files/1/0676/9973/6730/files/5star.webp?v=1751489337",
        "productHandle": "5-star",
        "basePrice": 200,
        "subscriptionDiscountedPrice": 200,
        "finalPrice": 200,
        "quantity": 1,
        "sellingPlanShopifyId": 303512682650,
        "sellingPlanName": "Deliver every 3 months",
        "deliveryInterval": "MONTH",
        "deliveryIntervalCount": 3,
        "variantShopifyId": 45914230128794
      },
      "newProductsInformation": [
        {
          "name": "Large kit membership",
          "imageUrl": "https://cdn.shopify.com/s/files/1/0676/9973/6730/files/5star.webp?v=1751489337",
          "productHandle": "Large kit membership",
          "basePrice": 200,
          "subscriptionDiscountedPrice": 200,
          "finalPrice": 200,
          "quantity": 1,
          "sellingPlanShopifyId": 303512682650,
          "sellingPlanName": "Deliver every 3 months",
          "deliveryInterval": "MONTH",
          "deliveryIntervalCount": 3,
          "variantShopifyId": 45914230128794
        }
      ],
      "membershipUpgradeInformation": {
        "amountPayableToday": 27.26,
        "amountPayableTodayCurrencyCode": "USD",
        "nextBillingDate": "2026-07-02T20:35:00.000Z"
      }
    }
  ],
  "code": "SUCCESS"
}