Skip to main content
GET
GET /subscription returns a paginated list of your subscriptions. Filter by status, customer email or name, plan, card brand, or creation date range to narrow results. Results are returned in reverse-chronological order by creation date. Filter and paginate with the query parameters in the panel above (created_from/created_to are inclusive ISO 8601 date bounds on createdAt). Response shape:
Combine created_from and created_to with status=past_due to identify subscribers who became overdue within a specific window — useful for targeted recovery campaigns.

Authorizations

​
Authorization
string
header
required

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Query Parameters

​
merchantCode
string
required

Your merchant account identifier.

​
status
string

Filter by status: pending, trialing, active, past_due, suspended, cancelled, paused, completed.

​
email
string

Partial, case-insensitive match on customer email.

​
customer_name
string

Partial, case-insensitive match on customer name.

​
plan_id
string

Filter to one plan ID.

​
card_brand
string

Filter by card brand, e.g. visa, mastercard, amex.

​
created_from
string

ISO 8601 date lower bound (inclusive) on creation date.

​
created_to
string

ISO 8601 date upper bound (inclusive) on creation date.

​
page
integer

Page number, starting at 1. Default 1.

​
per_page
integer

Results per page. Default 20, max 200.

Response

200 - application/json

List of subscriptions

​
data
object[]
​
total
integer

Total subscriptions matching the filters, across all pages.

​
page
integer

Current page number.

​
per_page
integer

Page size applied.