Skip to content
BoxBilling

List available plans

GET
/portal/plans

List all available plans for the organization.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
token
required
Token
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Response List Portal Plans
Array<object>
PortalPlanResponse

Plan info suitable for portal display.

object
id
required
Id
string format: uuid
name
required
Name
string
code
required
Code
string
description
required
Any of:
string
interval
required
Interval
string
amount_cents
required
Amount Cents
integer
currency
required
Currency
string

401

Section titled “401 ”

Invalid or expired portal token

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object