Skips a scheduled billing attempt, preventing the order from being processed. The next billing date is automatically recalculated based on the subscription frequency.
Key Features:
How It Works:
Use Cases:
Authentication: Requires API key authentication via X-API-Key header or api_key parameter
curl --request PUT \
--url https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/skip-order/{id}{
"shop": "my-store.myshopify.com",
"retryingNeeded": true,
"id": 12345,
"billingAttemptId": "<string>",
"billingDate": "2023-11-07T05:31:56Z",
"contractId": 67890,
"attemptCount": 1,
"attemptTime": "2023-11-07T05:31:56Z",
"graphOrderId": "<string>",
"orderId": 123,
"orderAmount": 29.99,
"orderName": "#1001",
"applyUsageCharge": true,
"recurringChargeId": 123,
"transactionRate": 123,
"billingAttemptResponseMessage": "<string>",
"progressAttemptCount": 123,
"orderNote": "<string>",
"variantList": [
{
"variantId": 123,
"quantity": 123,
"title": "<string>",
"image": "<string>",
"productTitle": "<string>",
"productId": "<string>",
"sellingPlanId": "<string>"
}
],
"orderAmountUSD": 123,
"upgradeDowngradeBilling": true
}Documentation Index
Fetch the complete documentation index at: https://developers.appstle.com/llms.txt
Use this file to discover all available pages before exploring further.
Billing attempt ID to skip
API Key (Deprecated - Use Header X-API-Key instead)
Subscription contract ID
Whether this is a prepaid subscription
Order successfully skipped, returns updated billing attempt
Shop domain identifier
"my-store.myshopify.com"
Unique identifier of the billing attempt record
12345
Shopify billing attempt ID
Current status of the billing attempt
SUCCESS, FAILURE, REQUESTING, PROGRESS, QUEUED, SKIPPED, SOCIAL_CONNECTION_NULL, CONTRACT_CANCELLED, CONTRACT_ENDED, CONTRACT_PAUSED, AUTO_CHARGE_DISABLED, SKIPPED_DUNNING_MGMT, SECURITY_CHALLENGE, SHOPIFY_EXCEPTION Scheduled billing date for this attempt
Associated subscription contract ID
67890
Number of billing retry attempts
1
Shopify order ID if billing was successful
Total order amount
29.99
Shopify order name/number
"#1001"
SENT, UNSENT, FAILED, EMAIL_SETTINGS_DISABLED, CUSTOMER_PAYMENT_EMPTY, CONTRACT_CANCELLED SENT, UNSENT, FAILED, EMAIL_SETTINGS_DISABLED, CUSTOMER_PAYMENT_EMPTY, CONTRACT_CANCELLED, STOP_FROM_CONTRACT, CONTRACT_PAUSED SUCCESS, FAILED, TO_BE_TRIED SENT, UNSENT, FAILED, SMS_SETTINGS_DISABLED, CUSTOMER_PAYMENT_EMPTY, CONTRACT_CANCELLED, PHONE_NUMBER_EMPTY SENT, UNSENT, FAILED, SMS_SETTINGS_DISABLED, CUSTOMER_PAYMENT_EMPTY, CONTRACT_CANCELLED, STOP_FROM_CONTRACT, CONTRACT_PAUSED, PHONE_NUMBER_EMPTY Order note or special instructions
Show child attributes
SENT, UNSENT, FAILED, EMAIL_SETTINGS_DISABLED, CONTRACT_CANCELLED curl --request PUT \
--url https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/skip-order/{id}{
"shop": "my-store.myshopify.com",
"retryingNeeded": true,
"id": 12345,
"billingAttemptId": "<string>",
"billingDate": "2023-11-07T05:31:56Z",
"contractId": 67890,
"attemptCount": 1,
"attemptTime": "2023-11-07T05:31:56Z",
"graphOrderId": "<string>",
"orderId": 123,
"orderAmount": 29.99,
"orderName": "#1001",
"applyUsageCharge": true,
"recurringChargeId": 123,
"transactionRate": 123,
"billingAttemptResponseMessage": "<string>",
"progressAttemptCount": 123,
"orderNote": "<string>",
"variantList": [
{
"variantId": 123,
"quantity": 123,
"title": "<string>",
"image": "<string>",
"productTitle": "<string>",
"productId": "<string>",
"sellingPlanId": "<string>"
}
],
"orderAmountUSD": 123,
"upgradeDowngradeBilling": true
}