Updates the maximum number of billing cycles (orders) after which a subscription will automatically terminate. This creates a fixed-duration subscription that ends after a specific number of orders.
What are Maximum Cycles? Maximum cycles define subscription duration limits where:
Key Features:
Current Cycle Calculation:
Common Use Cases:
What Happens at Maximum: When a subscription reaches its maximum cycles:
Interaction with Min Cycles:
Queue Management: After updating max cycles:
Important Notes:
Authentication: Requires valid X-API-Key header
curl --request PUT \
--url https://subscription-admin.appstle.com/api/external/v2/subscription-contracts-update-max-cycles{
"id": "gid://shopify/SubscriptionContract/123456789",
"status": "ACTIVE",
"nextBillingDate": "2024-04-01T00:00:00Z",
"createdAt": "2024-01-01T00:00:00Z",
"customer": {
"id": "gid://shopify/Customer/987654321",
"email": "customer@example.com",
"displayName": "John Doe"
},
"billingPolicy": {
"interval": "MONTH",
"intervalCount": 1,
"minCycles": 3,
"maxCycles": 12,
"anchors": [
{
"type": "MONTHDAY",
"day": 15
}
]
},
"deliveryPolicy": {
"interval": "MONTH",
"intervalCount": 1
},
"lastBillingAttemptDate": "2024-03-01T00:00:00Z",
"orders": {
"edges": [
{
"node": {
"id": "gid://shopify/Order/5678901234",
"createdAt": "2024-03-01T00:00:00Z",
"fulfillmentStatus": "FULFILLED",
"financialStatus": "PAID"
}
},
{
"node": {
"id": "gid://shopify/Order/5678901233",
"createdAt": "2024-02-01T00:00:00Z",
"fulfillmentStatus": "FULFILLED",
"financialStatus": "PAID"
}
},
{
"node": {
"id": "gid://shopify/Order/5678901232",
"createdAt": "2024-01-01T00:00:00Z",
"fulfillmentStatus": "FULFILLED",
"financialStatus": "PAID"
}
}
]
},
"lines": {
"edges": [
{
"node": {
"id": "gid://shopify/SubscriptionLine/111111",
"quantity": 1,
"variantId": "gid://shopify/ProductVariant/42549172011164",
"title": "12-Month Subscription Box",
"currentPrice": {
"amount": "39.99",
"currencyCode": "USD"
}
}
}
]
}
}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.
Contract ID
API Key (Deprecated - Use Header X-API-Key instead)
Maximum Cycles. The total number of orders after which the subscription will automatically terminate. Must be greater than or equal to the current cycle count and any configured minimum cycles. Common values:
1 <= x <= 9999Maximum cycles updated successfully
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-update-max-cycles{
"id": "gid://shopify/SubscriptionContract/123456789",
"status": "ACTIVE",
"nextBillingDate": "2024-04-01T00:00:00Z",
"createdAt": "2024-01-01T00:00:00Z",
"customer": {
"id": "gid://shopify/Customer/987654321",
"email": "customer@example.com",
"displayName": "John Doe"
},
"billingPolicy": {
"interval": "MONTH",
"intervalCount": 1,
"minCycles": 3,
"maxCycles": 12,
"anchors": [
{
"type": "MONTHDAY",
"day": 15
}
]
},
"deliveryPolicy": {
"interval": "MONTH",
"intervalCount": 1
},
"lastBillingAttemptDate": "2024-03-01T00:00:00Z",
"orders": {
"edges": [
{
"node": {
"id": "gid://shopify/Order/5678901234",
"createdAt": "2024-03-01T00:00:00Z",
"fulfillmentStatus": "FULFILLED",
"financialStatus": "PAID"
}
},
{
"node": {
"id": "gid://shopify/Order/5678901233",
"createdAt": "2024-02-01T00:00:00Z",
"fulfillmentStatus": "FULFILLED",
"financialStatus": "PAID"
}
},
{
"node": {
"id": "gid://shopify/Order/5678901232",
"createdAt": "2024-01-01T00:00:00Z",
"fulfillmentStatus": "FULFILLED",
"financialStatus": "PAID"
}
}
]
},
"lines": {
"edges": [
{
"node": {
"id": "gid://shopify/SubscriptionLine/111111",
"quantity": 1,
"variantId": "gid://shopify/ProductVariant/42549172011164",
"title": "12-Month Subscription Box",
"currentPrice": {
"amount": "39.99",
"currencyCode": "USD"
}
}
}
]
}
}