Skip to main content
GET
/
api
/
v1
/
businesses
/
{businessId}
/
stripe
/
subscriptions
Error
A valid request URL is required to generate request examples
{}

Authorizations

​
Authorization
string
header
required

API key prefixed with sk-ak-. Pass as Authorization: Bearer sk-ak-...

Path Parameters

​
businessId
string<uuid>
required

The business ID

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
​
status
string

Filter by subscription status (active, canceled, past_due, trialing)

​
stripeCustomerId
string

Filter by Stripe customer ID

​
sort
enum<string>
default:-startDate

Sort field

Available options:
startDate,
-startDate,
amount,
-amount,
currentPeriodEnd,
-currentPeriodEnd

Response

Paginated list of subscriptions

The response is of type object.