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.
Key Features:
Use Cases:
Authentication: Requires valid X-API-Key header
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>'[
{
"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"
}
]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 one-time products for Must be a valid contract ID that belongs to the authenticated shop
x >= 1Successfully retrieved one-time products
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/subscription-contract-one-offs-by-contractId \
--header 'X-API-Key: <x-api-key>'[
{
"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"
}
]