GET
/
subscriptions

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json
id
string

Unique identifier for the subscription

plan
enum<string>

The subscription plan

Available options:
FREE,
PRO,
CUSTOM
billingCycleStart
string | null

The start date of the billing cycle

stripeId
string

Stripe customer ID

domainsLimit
integer

Limit of domains allowed

interval
string

Billing interval

projectsLimit
integer

Limit of workspaces allowed

usersLimit
integer

Limit of users allowed

stockageLimit
integer

Storage limit in bytes

clicksLimit
integer

Limit of clicks allowed

shortLinksLimit
integer

Limit of short links allowed

qrCodeLinksLimit
integer

Limit of QR code links allowed

retentionLimit
string

Data retention limit

fileAvailabilityLimit
string

File availability limit

isCanceledAtPeriodEnd
boolean

Indicates if the subscription is canceled at the period end

subscriptionScheduleId
string | null

Subscription schedule ID

periodEnd
string

Period end date

isCancelAt
string | null

Indicates if the subscription is set to cancel

amount
number

Amount charged for the subscription

isPaymentFailed
boolean

Indicates if the payment has failed

isPaid
boolean

Indicates if the subscription is paid

schedulePlan
string | null

Scheduled plan