Skip to content
Bottle

Get the subscription

GET
/billing
curl --request GET \
  --url https://example.com/billing \
  --cookie bottle.session_token=<bottle.session_token>

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The subscription

Media typeapplication/json
object
plan
required
string
Allowed values: starter round depot
status
required
string
Allowed values: trialing active past_due unpaid canceled incomplete incomplete_expired paused none
inGoodStanding
required
boolean
manageable
required
boolean
trialEndsAt
required
string | null format: date-time
currentPeriodEnd
required
string | null format: date-time
cancelAt
required
string | null format: date-time
pendingPlan
required
string | null
Allowed values: starter round depot
pendingPlanAt
required
string | null format: date-time
rateLimits
required
object
requestsPerMinute
required
integer
> 0
heavyPerMinute
required
integer
> 0
discount
required
object
percentOff
required
integer
>= 1 <= 100
until
required
string | null format: date-time
customPrice
required
object
monthlyPence
required
integer
from
required
string | null format: date-time
vehiclesUsed
required
integer
Example
{
  "plan": "starter",
  "status": "trialing",
  "pendingPlan": "starter"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not allowed to manage billing, or asking for a key to do it

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}