Skip to main content
GET
Get past orders report with detailed filtering

Headers

X-API-Key
string

Query Parameters

api_key
string

API Key (Deprecated - Use Header X-API-Key instead)

contractId
integer<int64>

Filter by contract Id

status
enum<string>
required

Filter by status

Available options:
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
includeShopifyException
boolean
default:false

Include Shopify Exception in case of Failure

fromDay
string<date-time>

Filter date range from

toDay
string<date-time>

Filter by date range to

attemptCount
integer<int32>

Filter by retry attempts

contractStatus
string

Filter by Contract Status

pageable
object
required

Pagination parameters (page number and size)

Response

Successfully retrieved report

subscriptionBillingAttempt
object
subscriptionContractDetails
object