Skip to main content
GET
List subscriptions

Authorizations

x-api-key
string
header
required

API key for authentication (required)

x-merchant-id
string
header
required

Merchant ID for identifying the merchant (required)

Query Parameters

limit
integer
default:20

Number of subscriptions to return per page (max 100)

Required range: 1 <= x <= 100
page
integer
default:1

Page number (starts from 1)

Required range: x >= 1
customerId
string<uuid>

Filter by customer ID

planId
string<uuid>

Filter by plan ID

status
enum<string>

Filter by subscription status

Available options:
TRIALING,
ACTIVE,
PAST_DUE,
CANCELED,
UNPAID

Response

Subscriptions retrieved successfully

data
object[]
required

List of subscriptions

pagination
object
required