List one-time add-on products for a contract

GET /subscriptions/cp/api/subscription-contract-one-offs-by-contractId

List one-time add-on products for a contract

cURL

curl --request GET \
  --url https://www.myshop.com/apps/subscriptions/cp/api/subscription-contract-one-offs-by-contractId

200

[
  {
    "shop": "example-store.myshopify.com",
    "id": 12345,
    "billingAttemptId": 54321,
    "subscriptionContractId": 98765,
    "variantId": 42549172011164,
    "variantHandle": "premium-coffee-blend-500g",
    "quantity": 2,
    "price": 19.99
  }
]

Query Parameters

contractId · integer<int64> · required

Response

200 - */*

OK

shop · string · required

The Shopify store domain that owns this subscription

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*\.myshopify\.com$

Example:

"example-store.myshopify.com"

id · integer<int64> · read-only

Unique identifier of the one-time product record

Example:

12345

billingAttemptId · integer<int64>

The billing attempt ID this one-time product is associated with. This determines which upcoming order will include this product.

Required range: x >= 1

Example:

54321

subscriptionContractId · integer<int64>

The subscription contract ID this one-time product belongs to

Required range: x >= 1

Example:

98765

variantId · integer<int64>

The Shopify product variant ID for this one-time product

Required range: x >= 1

Example:

42549172011164

variantHandle · string

The handle/slug of the product variant for URL-friendly identification

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Example:

"premium-coffee-blend-500g"

quantity · integer<int32>

The quantity of this product to include in the order

Required range: 1 <= x <= 999

Example:

2

price · number<double>

The price per unit of this product in the shop's base currency. This may include any applicable discounts.

Required range: 0 <= x <= 999999.99

Example:

19.99