Skip to main content
GET
List of subscriptions

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

page
integer
default:1

Page number for pagination

per_page
integer
default:25

Number of records per page

status
enum<string>

Filter subscriptions by status. Can be comma-separated for multiple values. Use 'inactive' to filter for inactive statuses (pending, paused, cancelled, past_due), or 'active' to filter for active statuses (active).

Available options:
pending,
active,
paused,
past_due,
cancelled,
inactive
subscription_plan_id
integer

Filter subscriptions by subscription plan ID

customer_id
integer

Filter subscriptions by customer ID

within_days
integer

Filter subscriptions within number of days (e.g., last 7 days)

frequency
enum<string>

Filter subscriptions by billing frequency. Supported values: day, week, month, year

Available options:
day,
week,
month,
year
subscription_number_min
integer

Minimum subscription number for filtering

subscription_number_max
integer

Maximum subscription number for filtering

amount_min
number

Minimum amount for filtering

amount_max
number

Maximum amount for filtering

created_start
string<date>

Start date for created date range filter (format: YYYY-MM-DD)

created_end
string<date>

End date for created date range filter (format: YYYY-MM-DD)

next_bill_start
string<date>

Start date for next bill date range filter (format: YYYY-MM-DD)

next_bill_end
string<date>

End date for next bill date range filter (format: YYYY-MM-DD)

last_bill_start
string<date>

Start date for last bill date range filter (format: YYYY-MM-DD)

last_bill_end
string<date>

End date for last bill date range filter (format: YYYY-MM-DD)

next_ship_start
string<date>

Start date for next ship date range filter (format: YYYY-MM-DD)

next_ship_end
string<date>

End date for next ship date range filter (format: YYYY-MM-DD)

last_ship_start
string<date>

Start date for last ship date range filter (format: YYYY-MM-DD)

last_ship_end
string<date>

End date for last ship date range filter (format: YYYY-MM-DD)

last_failed_start
string<date>

Start date for last failed date range filter (format: YYYY-MM-DD)

last_failed_end
string<date>

End date for last failed date range filter (format: YYYY-MM-DD)

cancelled_start
string<date>

Start date for cancelled date range filter (format: YYYY-MM-DD)

cancelled_end
string<date>

End date for cancelled date range filter (format: YYYY-MM-DD)

sort_by
enum<string>

Sort field for subscriptions

Available options:
created_at,
id,
next_bill_date,
customer,
last_bill_date,
product,
amount,
status,
frequency
sort_direction
enum<string>
default:desc

Sort direction

Available options:
asc,
desc

Search term for subscriptions(searches across subscription plan names, customer details, and product titles)

Response

Success

meta
object
required
subscriptions
object[]
required