Aller au contenu

Retrieve current plan subscription + addons

GET
/v1/billing/me/subscription
curl --request GET \
--url http://localhost:8080/v1/billing/me/subscription

Souscription en cours.

Media type application/json
object
status
required
string
Allowed value: success
code
required
string
data
required
object
unmetered
required
boolean
plan
required
object
id
required
string
planId
required
string
planSlug
required
string
planName
required
string
pinnedRevisionId
required
string | null
billingCycle
required
string
Allowed values: monthly yearly
status
required
string
Allowed values: trial active past_due suspended cancelled
startedAt
required
string format: date-time
trialEndsAt
required
string | null format: date-time
currentPeriodStart
required
string format: date-time
currentPeriodEnd
required
string format: date-time
nextBillingAt
required
string | null format: date-time
cancelAtPeriodEnd
required
boolean
addons
required
Array<object>
object
id
required
string
addonId
required
string
addonSlug
required
string
addonName
required
string
billingCycle
required
string
Allowed values: monthly yearly
status
required
string
Allowed values: trial active past_due suspended cancelled
startedAt
required
string format: date-time
currentPeriodStart
required
string format: date-time
currentPeriodEnd
required
string format: date-time
nextBillingAt
required
string | null format: date-time
cancelAtPeriodEnd
required
boolean
reason
string
Allowed values: no_active_plan
cache
object
hit
required
boolean
key
string
ageSeconds
integer
expiresAt
string format: date-time
timing
object
totalMs
required
integer
dbMs
integer
externalMs
integer
deprecation
object
sunset
required
string format: date-time
successor
string
note
string
Example
{
"status": "success",
"data": {
"plan": {
"billingCycle": "monthly",
"status": "trial"
},
"addons": [
{
"billingCycle": "monthly",
"status": "trial"
}
],
"reason": "no_active_plan"
}
}

Authentification manquante ou invalide.

Media type application/json
object
status
required
string
Allowed value: error
code
required
string
error
required
object
message
string
requestId
required
string
details
Array<object>
object
path
string
code
string
message
string
key
additional properties
Example
{
"status": "error"
}

Scope insuffisant (forbidden, no_active_plan, service_disabled_on_plan).

Media type application/json
object
status
required
string
Allowed value: error
code
required
string
error
required
object
message
string
requestId
required
string
details
Array<object>
object
path
string
code
string
message
string
key
additional properties
Example
{
"status": "error"
}