Get upcoming orders
Retrieves upcoming/scheduled billing attempts for shop, contract, or customer. Returns future orders that haven’t been processed yet.
Query Options:
- No params: All upcoming orders for shop
- contractId: Upcoming orders for specific contract
- customerId: Upcoming orders for specific customer
Use Cases:
- Display next delivery dates in portal
- Show upcoming charges
- Allow order modifications before processing
Authentication: Requires API key authentication via X-API-Key header or api_key parameter
Headers
Query Parameters
API Key (Deprecated - Use Header X-API-Key instead)
Filter by subscription contract ID
Filter by customer ID
Response
Upcoming orders retrieved successfully
Shop domain identifier
"my-store.myshopify.com"
Number of billing retry attempts
1
Shopify billing attempt ID
Scheduled billing date for this attempt
Associated subscription contract ID
67890
Unique identifier of the billing attempt record
12345
Total order amount
29.99
Shopify order ID if billing was successful
Shopify order name/number
"#1001"
Order note or special instructions
SENT, UNSENT, FAILED, EMAIL_SETTINGS_DISABLED, CONTRACT_CANCELLED 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 SENT, UNSENT, FAILED, EMAIL_SETTINGS_DISABLED, CUSTOMER_PAYMENT_EMPTY, CONTRACT_CANCELLED SENT, UNSENT, FAILED, SMS_SETTINGS_DISABLED, CUSTOMER_PAYMENT_EMPTY, CONTRACT_CANCELLED, PHONE_NUMBER_EMPTY SENT, UNSENT, FAILED, EMAIL_SETTINGS_DISABLED, CUSTOMER_PAYMENT_EMPTY, CONTRACT_CANCELLED, STOP_FROM_CONTRACT, CONTRACT_PAUSED SENT, UNSENT, FAILED, SMS_SETTINGS_DISABLED, CUSTOMER_PAYMENT_EMPTY, CONTRACT_CANCELLED, STOP_FROM_CONTRACT, CONTRACT_PAUSED, PHONE_NUMBER_EMPTY SUCCESS, FAILED, TO_BE_TRIED