Skip to content
BoxBilling

Get plan

GET
/v1/plans/{plan_id}

Get a plan by ID.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
plan_id
required
Plan Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

PlanResponse
object
id
required
Id
string format: uuid
code
required
Code
string
name
required
Name
string
description
required
Any of:
string
interval
required
PlanInterval
string
Allowed values: weekly monthly quarterly yearly
amount_cents
required
Amount Cents
integer
currency
required
Currency
string
trial_period_days
required
Trial Period Days
integer
charges
Charges
Array<object>
ChargeOutput

Charge output in plan responses.

object
id
required
Id
string format: uuid
plan_id
required
Plan Id
string format: uuid
billable_metric_id
required
Billable Metric Id
string format: uuid
charge_model
required
ChargeModel
string
Allowed values: standard graduated volume package percentage graduated_percentage custom dynamic
properties
required
Properties
object
key
additional properties
any
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

401

Section titled “401 ”

Unauthorized – invalid or missing API key

404

Section titled “404 ”

Plan not found

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