Creates and applies a custom manual discount to an existing subscription contract. This powerful endpoint supports multiple discount types and configurations for flexible pricing strategies.
Discount Types:
Key Features:
Application Methods:
Cycle Limits:
Retention Campaigns: This endpoint integrates with cancellation retention workflows:
Important Notes:
Authentication: Requires valid X-API-Key header
curl --request PUT \
--url https://subscription-admin.appstle.com/api/external/v2/subscription-contracts-add-discount \
--header 'X-API-Key: <x-api-key>'{
"id": "gid://shopify/SubscriptionContract/123456789",
"status": "ACTIVE",
"nextBillingDate": "2024-04-01T12: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",
"currentPrice": {
"amount": "29.99",
"currencyCode": "USD"
}
}
}
]
},
"discounts": {
"edges": [
{
"node": {
"id": "gid://shopify/SubscriptionManualDiscount/555555",
"title": "Loyalty Discount",
"targetType": "ALL_LINES",
"type": "MANUAL",
"recurringCycleLimit": 3,
"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 apply discount to. Provide the numeric ID without the gid:// prefix
x >= 1API Key (Deprecated - Use X-API-Key header instead)
Discount percentage (1-100). Required when discountType is PERCENTAGE
1 <= x <= 100Custom title for the discount. If not provided, a default title will be generated
255Number of billing cycles the discount applies to. Leave null for unlimited duration
1 <= x <= 9999Application method: true = apply to each line item individually, false = apply to order subtotal
Fixed discount amount in store currency. Required when discountType is FIXED or PRICE
0.01 <= x <= 999999.99Type of discount to apply
PERCENTAGE, FIXED, PRICE Discount successfully added
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-contracts-add-discount \
--header 'X-API-Key: <x-api-key>'{
"id": "gid://shopify/SubscriptionContract/123456789",
"status": "ACTIVE",
"nextBillingDate": "2024-04-01T12: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",
"currentPrice": {
"amount": "29.99",
"currencyCode": "USD"
}
}
}
]
},
"discounts": {
"edges": [
{
"node": {
"id": "gid://shopify/SubscriptionManualDiscount/555555",
"title": "Loyalty Discount",
"targetType": "ALL_LINES",
"type": "MANUAL",
"recurringCycleLimit": 3,
"value": {
"percentage": 10
}
}
}
]
}
}