Query Subscriptions

Return a paginated list of matching subscriptions.

SecurityMarketplace Api Key | Merchant Secret Token | Admin JWT | Marketplace JWT | Merchant JWT

Request

query Parameters

limit	integer <int32> Maximum results per page. Default to 20, must be between 1 and 500.
page	integer <int32> Page number of results to show (starting at page 1).
sort	string Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.
state	Array of strings (SubscriptionState) The state of the subscription Items Enum: "created" "active" "inactive" "paused" "cancelled" "charging"
subscriptionId	Array of strings The subscription IDs
merchantId	Array of strings The merchant that owns the subscription. Defaults to your own merchantId
customerId	Array of strings The customer that the subscription was created with
referenceCustomerId	Array of strings The internal customer reference ID set on the subscription
orderId	Array of strings The merchant order used to create the subscription

Responses

200

Matching items sorted as specified

400

401

403

404

405

406

409

422

429

500

503

get/subscriptions

Request samples

Curl
JavaScript

Response samples

application/json

[{"subscriptionId": "subs_ZqCNpNcm_22WeZ_B",
"merchantId": "mcht_ZqCNoNcm_22WeZ-i",
"customerId": "cust_ZqCNoNcm_22WeZ-j",
"referenceCustomerId": "string",
"orderId": "ordr_ZqCNoNcm_22WeZ-m",
"subscriptionAmount": 0,
"subscriptionCurrency": "AUD",
"paymentMethodDescription": "string",
"state": "created",
"stateUpdates": [{"state": "created",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"frequency": "weekly",
"nextPaymentScheduledAt": "2019-08-24T14:15:22Z",
"cancelScheduledAt": "2019-08-24T14:15:22Z",
"transactions": [{"transactionId": "tran_ZqCNoNcm_22WeZ-l",
"status": "accepted",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"communications": {"emailOnSuccess": "lucy.diamond@star.com",
"emailOnFailure": "lucy.diamond@star.com",
"emailCustomerOnSuccess": "lucy.diamond@star.com",
"emailCustomerOnFailure": "lucy.diamond@star.com"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]