Retrieves one-time products that will be included in the next scheduled order for a subscription contract. This endpoint specifically returns products associated with the earliest queued billing attempt, making it ideal for showing customers what additional items will be in their next delivery.
Key Differences from /subscription-contract-one-offs-by-contractId:
Use Cases:
Business Logic:
Authentication: Requires valid X-API-Key header that identifies the shop
curl --request GET \
--url https://subscription-admin.appstle.com/api/external/v2/upcoming-subscription-contract-one-offs-by-contractId \
--header 'X-API-Key: <x-api-key>'[
{
"id": 12345,
"shop": "example-store.myshopify.com",
"subscriptionContractId": 98765,
"billingAttemptId": 54321,
"variantId": 42549172011164,
"variantHandle": "premium-coffee-blend-500g",
"quantity": 2,
"price": 19.99
},
{
"id": 12346,
"shop": "example-store.myshopify.com",
"subscriptionContractId": 98765,
"billingAttemptId": 54321,
"variantId": 42549172011165,
"variantHandle": "coffee-filters-pack-100",
"quantity": 1,
"price": 8.99
}
]Documentation Index
Fetch the complete documentation index at: https://appstleinc-aeca3e0a.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
API Key for authentication. This key identifies your shop and must be included in the X-API-Key header.
API Key (Deprecated - Use X-API-Key header instead)
The unique identifier of the subscription contract to retrieve upcoming one-time products for Must be a valid contract ID that belongs to the authenticated shop
x >= 1Successfully retrieved one-time products for the next order
The Shopify store domain that owns this subscription
^[a-zA-Z0-9][a-zA-Z0-9-]*\.myshopify\.com$"example-store.myshopify.com"
Unique identifier of the one-time product record
12345
The billing attempt ID this one-time product is associated with. This determines which upcoming order will include this product.
x >= 154321
The subscription contract ID this one-time product belongs to
x >= 198765
The Shopify product variant ID for this one-time product
x >= 142549172011164
The handle/slug of the product variant for URL-friendly identification
^[a-z0-9]+(?:-[a-z0-9]+)*$"premium-coffee-blend-500g"
The quantity of this product to include in the order
1 <= x <= 9992
The price per unit of this product in the shop's base currency. This may include any applicable discounts.
0 <= x <= 999999.9919.99
curl --request GET \
--url https://subscription-admin.appstle.com/api/external/v2/upcoming-subscription-contract-one-offs-by-contractId \
--header 'X-API-Key: <x-api-key>'[
{
"id": 12345,
"shop": "example-store.myshopify.com",
"subscriptionContractId": 98765,
"billingAttemptId": 54321,
"variantId": 42549172011164,
"variantHandle": "premium-coffee-blend-500g",
"quantity": 2,
"price": 19.99
},
{
"id": 12346,
"shop": "example-store.myshopify.com",
"subscriptionContractId": 98765,
"billingAttemptId": 54321,
"variantId": 42549172011165,
"variantHandle": "coffee-filters-pack-100",
"quantity": 1,
"price": 8.99
}
]