Retrieves paginated list of past (processed) billing attempts for a subscription contract or customer. Includes successful orders, failed attempts, and skipped orders.
Filter Options:
Order Information:
Authentication: Requires valid X-API-Key header
curl --request GET \
--url https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/past-orders[
{
"shop": "<string>",
"retryingNeeded": true,
"id": 123,
"billingAttemptId": "<string>",
"billingDate": "2023-11-07T05:31:56Z",
"contractId": 123,
"attemptCount": 123,
"attemptTime": "2023-11-07T05:31:56Z",
"graphOrderId": "<string>",
"orderId": 123,
"orderAmount": 123,
"orderName": "<string>",
"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>",
"variantTitle": "<string>",
"swapId": 123
}
],
"orderAmountUSD": 123,
"orderCancelledAt": "2023-11-07T05:31:56Z",
"orderClosed": true,
"orderClosedAt": "2023-11-07T05:31:56Z",
"orderConfirmed": true,
"orderProcessedAt": "2023-11-07T05:31:56Z",
"lastShippingUpdatedAt": "2023-11-07T05:31:56Z",
"inventorySkippedAttemptCount": 123,
"inventorySkippedRetryingNeeded": true,
"orderAttributes": [
{
"key": "<string>",
"value": "<string>"
}
],
"orderAmountShopCurrency": 123,
"orderAmountContractCurrency": 123
}
]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.
Successfully retrieved past orders
SUCCESS, FAILURE, REQUESTING, PROGRESS, QUEUED, SKIPPED, SOCIAL_CONNECTION_NULL, CONTRACT_CANCELLED, CONTRACT_ENDED, CONTRACT_PAUSED, AUTO_CHARGE_DISABLED, SHOPIFY_EXCEPTION, SKIPPED_DUNNING_MGMT, SKIPPED_INVENTORY_MGMT, IMMEDIATE_TRIGGERED, SECURITY_CHALLENGE, CONTRACT_PAUSED_MAX_CYCLES, REFUNDED, SKIPPED_DEMO_SHOP, SKIPPED_SHOP_INFO_NOT_FOUND, SKIPPED_BILLING_DATE_STALE, SKIPPED_DUNNING_NOT_CONFIGURED, PENDING_CONSOLIDATION 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 Show child attributes
SENT, UNSENT, FAILED, EMAIL_SETTINGS_DISABLED, CONTRACT_CANCELLED CUSTOMER, DECLINED, FRAUD, INVENTORY, STAFF, OTHER, $UNKNOWN PENDING, AUTHORIZED, PARTIALLY_PAID, PARTIALLY_REFUNDED, VOIDED, PAID, REFUNDED, EXPIRED, $UNKNOWN UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED, REQUEST_DECLINED, $UNKNOWN Show child attributes
INVENTORY_MANAGEMENT, MANUAL curl --request GET \
--url https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/past-orders[
{
"shop": "<string>",
"retryingNeeded": true,
"id": 123,
"billingAttemptId": "<string>",
"billingDate": "2023-11-07T05:31:56Z",
"contractId": 123,
"attemptCount": 123,
"attemptTime": "2023-11-07T05:31:56Z",
"graphOrderId": "<string>",
"orderId": 123,
"orderAmount": 123,
"orderName": "<string>",
"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>",
"variantTitle": "<string>",
"swapId": 123
}
],
"orderAmountUSD": 123,
"orderCancelledAt": "2023-11-07T05:31:56Z",
"orderClosed": true,
"orderClosedAt": "2023-11-07T05:31:56Z",
"orderConfirmed": true,
"orderProcessedAt": "2023-11-07T05:31:56Z",
"lastShippingUpdatedAt": "2023-11-07T05:31:56Z",
"inventorySkippedAttemptCount": 123,
"inventorySkippedRetryingNeeded": true,
"orderAttributes": [
{
"key": "<string>",
"value": "<string>"
}
],
"orderAmountShopCurrency": 123,
"orderAmountContractCurrency": 123
}
]