LOloopwork

Fetch upgrade profiles

Changed on

This endpoint allows you to fetch all the applicable active upgrade profile for the subscription contract.

get/subscription/{subscriptionId}/upgrade

Request

  • Base URL
    https://api.loopsubscriptions.com/storefront
  • URL
    https://api.loopsubscriptions.com/storefront/subscription/{subscriptionId}/upgrade
  • Auth
    API key in header Authorization

Path parameters

subscriptionIdinteger required

The unique identifier of the subscription in Loop.

Response

200

successboolean
messagestring
codestring
pageInfounknown

Example response

{
  "success": true,
  "message": "Fetched applicable upgrade profiles successfully",
  "data": [
    {
      "id": 86,
      "name": "upgrade",
      "priority": 9,
      "shortDescription": "abcd",
      "bannerTexts": [
        {
          "fieldKey": "upgradeFlowProfileBannerBody",
          "value": "<p>abcd</p>"
        }
      ],
      "drawerTexts": [
        {
          "fieldKey": "upgradeFlowProfileDrawerHeader",
          "value": "Upgrade"
        }
      ],
      "existingProductInformation": {
        "name": "All-in-one Superfood Shake - Chocolate Mint",
        "imageUrl": "https://cdn.shopify.com/s/files/1/0570/1196/2009/files/DALL_E2024-10-2313.18.17-Asleek_moderndesignforaproteinpowdercontainerbrandedas_Loopy._Thecontaineriscylindrical_withamattewhitesurfaceandbold_minimalis.webp?v=1729669717",
        "productHandle": "all-in-one-superfood-shake-chocolate-mint-3",
        "quantity": 1,
        "basePrice": 40,
        "subscriptionDiscountedPrice": 32,
        "finalPrice": 32,
        "sellingPlanShopifyId": 2111111321,
        "sellingPlanName": "Deliver every month",
        "deliveryInterval": "MONTH",
        "deliveryIntervalCount": 1,
        "variantShopifyId": 43525066522777
      },
      "newProductInformation": {
        "name": "Apple Cinnamon Pack (Child Product 1)",
        "imageUrl": "https://cdn.shopify.com/s/files/1/0570/1196/2009/files/AppleCinnamonBar.png?v=1697020167",
        "productHandle": "apple-cinnamon-pack",
        "basePrice": 40,
        "subscriptionDiscountedPrice": 32,
        "finalPrice": 32,
        "quantity": 1,
        "sellingPlanShopifyId": 2111111321,
        "sellingPlanName": "Deliver every month",
        "deliveryInterval": "MONTH",
        "deliveryIntervalCount": 1,
        "variantShopifyId": 43485355868313
      }
    }
  ],
  "code": "SUCCESS"
}

Changes