Get all one-time products for a subscription contract

Retrieves all one-time products (add-ons) associated with a specific subscription contract across all billing attempts. One-time products are additional items that customers can add to their subscription orders on a non-recurring basis. Each one-time product is tied to a specific billing attempt and will only be included in that particular order.

Full behavior, validation rules, and side effects

Key Features:

• Returns ALL one-time products across all queued billing attempts
• Each product includes the billing attempt ID to identify which order it belongs to
• Includes product details: variant ID, quantity, title, image, and price
• Products are automatically removed after the associated billing attempt is processed

Use Cases:

• Display all one-time products added to a subscription across all upcoming orders
• Allow customers to review their one-time add-ons in customer portal
• Enable merchants to see all one-time products for a contract
• Integrate with external systems to manage subscription add-ons

Authentication: Requires valid X-API-Key header

GET /api/external/v2/subscription-contract-one-offs-by-contractId

Get all one-time products for a subscription contract

cURL

curl --request GET \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-contract-one-offs-by-contractId \
  --header 'X-API-Key: <x-api-key>'

200

[
  {
    "id": 12345,
    "shop": "example-shop.myshopify.com",
    "contractId": 67890,
    "billingAttemptId": 11111,
    "variantId": 22222,
    "quantity": 2,
    "productTitle": "Coffee Filters - Pack of 100",
    "variantTitle": "Standard Size",
    "image": "https://cdn.shopify.com/s/files/1/0000/0000/products/filter.jpg",
    "price": "9.99",
    "currencyCode": "USD",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  },
  {
    "id": 12346,
    "shop": "example-shop.myshopify.com",
    "contractId": 67890,
    "billingAttemptId": 11112,
    "variantId": 33333,
    "quantity": 1,
    "productTitle": "Coffee Scoop",
    "variantTitle": "Stainless Steel",
    "image": "https://cdn.shopify.com/s/files/1/0000/0000/products/scoop.jpg",
    "price": "14.99",
    "currencyCode": "USD",
    "createdAt": "2024-01-16T14:20:00Z",
    "updatedAt": "2024-01-16T14:20:00Z"
  }
]

Headers

X-API-Key · string · required

API Key for authentication. This key identifies your shop and must be included in the X-API-Key header.

Query Parameters

api_key · string

API Key (Deprecated - Use X-API-Key header instead)

contractId · integer<int64> · required

The unique identifier of the subscription contract to retrieve one-time products for Must be a valid contract ID that belongs to the authenticated shop

Required range: x >= 1

Response

200

application/json

Successfully retrieved one-time products

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