Get variant contextual pricing

Retrieves contextual pricing information for a product variant based on currency and country. This endpoint provides localized pricing data for international subscriptions and multi-currency support.

Full behavior, validation rules, and side effects

Pricing Information Returned:

• Base price in specified currency
• Compare-at price (if applicable)
• Country-specific pricing adjustments
• Tax information for the region
• Currency conversion data

Parameters:

• variantId - Shopify variant ID (required)
• currencyCode - ISO 4217 currency code (e.g., USD, EUR, GBP) (required)
• countryCode - ISO 3166-1 country code (e.g., US, GB, CA) (optional)

Use Cases:

• Display localized pricing in customer portal
• Calculate subscription totals for international customers
• Support multi-currency subscriptions
• Show accurate pricing based on customer location
• Validate pricing before subscription creation

Important Notes:

• Requires Shopify Markets or multi-currency setup
• Prices are returned in the requested currency
• Country-specific pricing takes precedence over currency-only pricing
• Returns 404 if variant doesn’t exist or isn’t available in specified market

Authentication: Requires valid api_key parameter

GET /subscriptions/cp/api/data/variant-contextual-pricing

Get variant contextual pricing

cURL

curl --request GET \
  --url https://www.myshop.com/apps/subscriptions/cp/api/data/variant-contextual-pricing

200

{
  "get__typename": "<string>",
  "id": "<string>",
  "title": "<string>",
  "media": {
    "get__typename": "<string>",
    "nodes": [
      {
        "get__typename": "<string>",
        "id": "<string>",
        "sellingPlanId": "<string>",
        "sellingPlanName": "<string>",
        "productId": "<string>",
        "sku": "<string>",
        "title": "<string>",
        "variantId": "<string>",
        "quantity": 123,
        "customAttributes": [
          {
            "get__typename": "<string>",
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "lineDiscountedPrice": {
          "get__typename": "<string>",
          "amount": {}
        },
        "variantImage": {
          "get__typename": "<string>",
          "transformedSrc": {}
        },
        "variantTitle": "<string>",
        "currentPrice": {
          "get__typename": "<string>",
          "amount": {}
        },
        "discountAllocations": [
          {
            "get__typename": "<string>",
            "amount": {
              "get__typename": "<string>",
              "amount": {}
            },
            "discount": {
              "get__typename": "<string>"
            }
          }
        ],
        "pricingPolicy": {
          "get__typename": "<string>",
          "basePrice": {
            "get__typename": "<string>",
            "amount": {}
          },
          "cycleDiscounts": [
            {
              "get__typename": "<string>",
              "afterCycle": 123,
              "computedPrice": {
                "get__typename": "<string>",
                "amount": {}
              },
              "adjustmentValue": {
                "get__typename": "<string>"
              }
            }
          ]
        },
        "taxable": true
      }
    ]
  },
  "product": {
    "get__typename": "<string>",
    "id": "<string>",
    "title": "<string>",
    "handle": "<string>"
  },
  "price": {},
  "contextualPricing": {
    "get__typename": "<string>",
    "price": {
      "get__typename": "<string>",
      "amount": {}
    }
  },
  "sku": "<string>"
}

Query Parameters

variantId · integer<int64> · required

countryCode · string

currencyCode · string · required

Response

200

*/*

Contextual pricing retrieved successfully

get__typename · string

id · string

title · string

media · object

Show child attributes

product · object

Show child attributes

price · object

contextualPricing · object

Show child attributes

sku · string