Skip to main content
GET
List subscriptions

Authorizations

X-Suby-Api-Key
string
header
required

API key authentication

Query Parameters

status
enum<string>

Filter by subscription status:

  • ACTIVE — customer has access
  • INACTIVE — access removed (expired)
  • PENDING — renewal payment due (within 24h of expiry, no payment received). Customer still has access until expiresAt
  • CANCELLED — cancelled by customer or merchant
  • NOT_PAID — subscription created but no successful payment yet (e.g. checkout not completed)
Available options:
ACTIVE,
INACTIVE,
PENDING,
CANCELLED,
NOT_PAID
customerEmail
string<email>
page
integer
default:1

Page number (starts at 1)

Required range: x >= 1
limit
integer
default:25

Results per page (max 25)

Required range: 1 <= x <= 25

Response

Subscriptions retrieved

success
boolean
Example:

true

data
object