v1
latestOpenAPI 3.0.02026-07-24103118224.7 KBSubscription
Get user subscriptions
Retrieves a paginated list of subscriptions for the authenticated user
get/subscription
Query parameters
status'INITIATION' | 'ACTIVE' | 'TRIAL' | 'PAST_DUE' | 'UNPAID' | 'INACTIVE' | 'PENDING_CANCELLATION' | 'CANCELED'
The status of the subscription
currencystring
The currency of the subscription
interval'day' | 'week' | 'month' | 'year'
The billing interval of the subscription
merchantIdstring
Filter by merchant ID (admin only)
subscriptionOfferIdstring
Filter by subscription offer ID
waitlistStatus'pending_waitlist' | 'approved' | 'failed_capture' | 'active' | 'declined'
Filter by waitlist status
includeAllWaitlistStatusesboolean
When true, include all waitlist statuses (for waitlist tab). When false or undefined, only show approved or non-waitlisted subscriptions (for subscriptions tab).
pagenumber
The page number
limitnumber
The number of items per page
Response
Example response
{
"data": [
{
"trialPeriodDays": 14
}
]
}