Adds a new product line item with a custom price override to an existing subscription contract. This endpoint bypasses standard pricing and selling plans to set an exact price.
Key Features:
Custom Pricing Behavior:
Shop-Level Discount Application: Despite the method name, this endpoint MAY apply discounts:
Common Use Cases:
Differences from Standard Add:
One-Time Products:
When isOneTimeProduct=true:
Price Validation:
Important Considerations:
Post-Addition Effects:
Authentication: Requires valid X-API-Key header
curl --request PUT \
--url https://subscription-admin.appstle.com/api/external/v2/subscription-contract-add-line-item \
--header 'X-API-Key: <x-api-key>'{
"id": "gid://shopify/SubscriptionContract/123456789",
"status": "ACTIVE",
"nextBillingDate": "2024-04-01T00:00:00Z",
"customer": {
"id": "gid://shopify/Customer/987654321",
"email": "customer@example.com"
},
"lines": {
"edges": [
{
"node": {
"id": "gid://shopify/SubscriptionLine/111111",
"quantity": 1,
"variantId": "gid://shopify/ProductVariant/42549172011164",
"title": "Premium Coffee - Dark Roast",
"currentPrice": {
"amount": "29.99",
"currencyCode": "USD"
},
"sellingPlanId": null,
"sellingPlanName": null
}
},
{
"node": {
"id": "gid://shopify/SubscriptionLine/222222",
"quantity": 1,
"variantId": "gid://shopify/ProductVariant/98765432101",
"title": "Special Edition Box",
"currentPrice": {
"amount": "19.99",
"currencyCode": "USD"
},
"sellingPlanId": null,
"sellingPlanName": null,
"discountAllocations": [
{
"discount": {
"__typename": "SubscriptionManualDiscount",
"id": "gid://shopify/SubscriptionManualDiscount/333333",
"title": "PRODUCT_DISCOUNT_222222",
"type": "MANUAL",
"value": {
"percentage": 10
}
}
}
]
}
}
]
}
}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
Subscription contract ID to add product to
API Key (Deprecated - Use X-API-Key header instead)
Quantity of product to add
Shopify variant ID of the product to add
Custom price for the product (in store currency). This exact price will be charged regardless of the product's normal price, selling plans, or frequency. If the shop has 'applySubscriptionDiscount' enabled, an additional discount may be applied on top of this price.
0.01 <= x <= 999999.99When true, product will only be included in the next order; when false, in all future orders
Product successfully added to subscription with custom price
ACTIVE, PAUSED, CANCELLED, EXPIRED, FAILED, $UNKNOWN Show child attributes
SUCCEEDED, FAILED, $UNKNOWN Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
curl --request PUT \
--url https://subscription-admin.appstle.com/api/external/v2/subscription-contract-add-line-item \
--header 'X-API-Key: <x-api-key>'{
"id": "gid://shopify/SubscriptionContract/123456789",
"status": "ACTIVE",
"nextBillingDate": "2024-04-01T00:00:00Z",
"customer": {
"id": "gid://shopify/Customer/987654321",
"email": "customer@example.com"
},
"lines": {
"edges": [
{
"node": {
"id": "gid://shopify/SubscriptionLine/111111",
"quantity": 1,
"variantId": "gid://shopify/ProductVariant/42549172011164",
"title": "Premium Coffee - Dark Roast",
"currentPrice": {
"amount": "29.99",
"currencyCode": "USD"
},
"sellingPlanId": null,
"sellingPlanName": null
}
},
{
"node": {
"id": "gid://shopify/SubscriptionLine/222222",
"quantity": 1,
"variantId": "gid://shopify/ProductVariant/98765432101",
"title": "Special Edition Box",
"currentPrice": {
"amount": "19.99",
"currencyCode": "USD"
},
"sellingPlanId": null,
"sellingPlanName": null,
"discountAllocations": [
{
"discount": {
"__typename": "SubscriptionManualDiscount",
"id": "gid://shopify/SubscriptionManualDiscount/333333",
"title": "PRODUCT_DISCOUNT_222222",
"type": "MANUAL",
"value": {
"percentage": 10
}
}
}
]
}
}
]
}
}