---
title: "Fetch upgrade profiles"
method: GET
path: "/2023-10/subscription/{subscriptionId}/upgrade"
---

# Fetch upgrade profiles

`GET /2023-10/subscription/{subscriptionId}/upgrade`

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

## Path parameters

- `subscriptionId` integer, required

## Response `200`

200

- object
  - `success` boolean — Indicates whether the request was completed successfully.
  - `message` string — Provides additional context about the API response.
  - `data` object[] — List of all active upgrade profiles applicable to the subscription.
    - `id` integer — Unique identifier of the upgrade profile.
    - `name` string — Name of the upgrade profile configured in Loop.
    - `priority` integer — Priority assigned to the upgrade profile. Profiles with higher priority can be used to control which upgrade option is shown first.
    - `shortDescription` string — Short description configured for the upgrade profile. This can be used to explain the upgrade offer to the customer.
    - `bannerTexts` object[] — List of text fields configured for the upgrade banner. These can be used to render custom upgrade messaging on the storefront or customer portal.
      - `fieldKey` string — Unique key identifying the banner text field.
      - `value` string — Text value configured for the corresponding banner field.
    - `drawerTexts` object[] — List of text fields configured for the upgrade drawer. These can be used to render custom messaging inside the upgrade drawer.
      - `fieldKey` string — Unique key identifying the drawer text field.
      - `value` string — Text value configured for the corresponding drawer field.
    - `existingProductInformation` object — Details of the current product and selling plan on the subscription before the upgrade is applied.
      - `name` string — Name of the product.
      - `imageUrl` string — Product image URL.
      - `productHandle` string — Shopify product handle.
      - `quantity` integer — Product quantity in the subscription.
      - `basePrice` integer — Original product price before subscription discounts.
      - `subscriptionDiscountedPrice` integer — Product price after applying the subscription discount.
      - `finalPrice` integer — Final price applicable for the subscription after all relevant discounts or adjustments.
      - `sellingPlanShopifyId` integer — Shopify selling plan identifier associated with the product.
      - `sellingPlanName` string — Name of the selling plan.
      - `deliveryInterval` string — Delivery interval unit, such as DAY, WEEK, MONTH, or YEAR.
      - `deliveryIntervalCount` integer — Number of intervals between deliveries. For example, 3 with MONTH means delivery every 3 months.
      - `variantShopifyId` integer — Shopify variant identifier of the product variant.
    - `newProductInformation` object — Details of the primary product and selling plan that the subscription will be upgraded to.
      - `name` string — Name of the product.
      - `imageUrl` string — Product image URL.
      - `productHandle` string — Shopify product handle.
      - `basePrice` integer — Original product price before subscription discounts.
      - `subscriptionDiscountedPrice` integer — Product price after applying the subscription discount.
      - `finalPrice` integer — Final price applicable for the subscription after all relevant discounts or adjustments.
      - `quantity` integer — Product quantity in the subscription.
      - `sellingPlanShopifyId` integer — Shopify selling plan identifier associated with the product.
      - `sellingPlanName` string — Name of the selling plan.
      - `deliveryInterval` string — Delivery interval unit, such as DAY, WEEK, MONTH, or YEAR.
      - `deliveryIntervalCount` integer — Number of intervals between deliveries. For example, 3 with MONTH means delivery every 3 months.
      - `variantShopifyId` integer — Shopify variant identifier of the product variant.
    - `newProductsInformation` object[] — List of available products for the upgrade profile. This is useful when the profile supports product selection or multiple upgrade options.
      - `name` string — Name of the product.
      - `imageUrl` string — Product image URL.
      - `productHandle` string — Shopify product handle.
      - `basePrice` integer — Original product price before subscription discounts.
      - `subscriptionDiscountedPrice` integer — Product price after applying the subscription discount.
      - `finalPrice` integer — Final price applicable for the subscription after all relevant discounts or adjustments.
      - `quantity` integer — Product quantity in the subscription.
      - `sellingPlanShopifyId` integer — Shopify selling plan identifier associated with the product.
      - `sellingPlanName` string — Name of the selling plan.
      - `deliveryInterval` string — Delivery interval unit, such as DAY, WEEK, MONTH, or YEAR.
      - `deliveryIntervalCount` integer — Number of intervals between deliveries. For example, 3 with MONTH means delivery every 3 months.
      - `variantShopifyId` integer — Shopify variant identifier of the product variant.
    - `membershipUpgradeInformation` object — Contains additional pricing and billing details for membership upgrade profiles. This object can be null when the upgrade profile is not a membership upgrade or membership upgrade with frequency change.
      - `amountPayableToday` number — Amount the customer needs to pay immediately to complete the membership upgrade.
      - `amountPayableTodayCurrencyCode` string — Currency code for the amount payable today, such as USD.
      - `nextBillingDate` string — Next billing date for the subscription after the membership upgrade is applied.
  - `code` string — Response status code returned by Loop. For a successful request, this is usually SUCCESS.
  - `pageInfo` string — Pagination information for the response. This is null when there are no additional pages.

## Other responses

- `400` — 400

---

[API](https://skmtc.net/loopwork/apis/storefront-api.md) · [All operations](https://skmtc.net/loopwork/apis/storefront-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/loopwork/storefront-api/versions/1524500daa02/schema)