Skip to content
Bottle

List what the plans cost

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

Each plan anyone can buy, with its current price and any discount every new checkout carries. A plan with nothing set here is sold at the price the environment names.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Plans

Media typeapplication/json
object
items
required
Array<object>
object
plan
required
string
Allowed values: starter round depot
monthlyPence
required
integer | null
stripePriceId
required
string | null
discount
required
object
percentOff
required
integer
>= 1 <= 100
months
required
integer | null
> 0
setAt
required
string | null format: date-time
setByName
required
string | null
Example
{
  "items": [
    {
      "plan": "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 Bottle staff, no two-step sign-in, or a console role too low for this

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

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}

503

Section titled “503”

Billing is not configured on this deployment

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