Skip to main content
GET
retrieve Subscription information

Authorizations

Authorization
string
header
required

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

Response

Subscription details retrieved successfully

id
string

Unique identifier for the subscription

Example:

"1110580a82031111aaa01111"

plan
enum<string>

The subscription plan

Available options:
FREE,
PRO,
CUSTOM
Example:

"FREE"

billingCycleStart
string | null

The start date of the billing cycle

Example:

null

stripeId
string

Stripe customer ID

domainsLimit
integer

Limit of domains allowed

Example:

1000

interval
string

Billing interval

Example:

"month"

projectsLimit
integer

Limit of workspaces allowed

Example:

100

usersLimit
integer

Limit of users allowed

Example:

100

stockageLimit
integer

Storage limit in bytes

Example:

5368709120

clicksLimit
integer

Limit of clicks allowed

Example:

1000000

Limit of short links allowed

Example:

100

Limit of QR code links allowed

Example:

100

retentionLimit
string

Data retention limit

Example:

"RE_30_DAY"

fileAvailabilityLimit
string

File availability limit

Example:

"FA_7_DAY"

isCanceledAtPeriodEnd
boolean

Indicates if the subscription is canceled at the period end

Example:

false

subscriptionScheduleId
string | null

Subscription schedule ID

Example:

null

periodEnd
string<date-time>

Period end date

Example:

"2024-08-04T20:17:33.000Z"

isCancelAt
string | null

Indicates if the subscription is set to cancel

Example:

null

amount
number<float>

Amount charged for the subscription

Example:

0

isPaymentFailed
boolean

Indicates if the payment has failed

Example:

false

isPaid
boolean

Indicates if the subscription is paid

Example:

true

schedulePlan
string | null

Scheduled plan

Example:

null