Skip to content
BoxBilling

Simulate plan pricing

POST
/v1/plans/{plan_id}/simulate

Simulate pricing for a plan given a number of usage units.

Parameters

Section titled “ Parameters ”

Path Parameters

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

Request Body required

Section titled “Request Body required ”
PlanSimulateRequest

Request body for pricing simulation.

object
units
required
Units

Number of usage units to simulate

number

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

PlanSimulateResponse

Response for pricing simulation.

object
plan_id
required
Plan Id
string format: uuid
base_amount_cents
required
Base Amount Cents
integer
currency
required
Currency
string
charges
required
Charges
Array<object>
ChargeSimulationResult

Result of simulating a single charge.

object
charge_id
required
Charge 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
units
required
Units
number
amount_cents
required
Amount Cents
integer
properties
required
Properties
object
key
additional properties
any
total_amount_cents
required
Total Amount Cents
integer

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