PUT
/
prices
/
{price_id}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

​
price_id
string
required

Body

application/json
​
metadata
object | null

User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

Response

200 - application/json

The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.

Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.

For more on the types of prices, see the core concepts documentation

​
billable_metric
object | null
required
​
billing_cycle_configuration
object
required
​
cadence
enum<string>
required
Available options:
one_time,
monthly,
quarterly,
semi_annual,
annual,
custom
​
conversion_rate
number | null
required
​
created_at
string
required
​
credit_allocation
object | null
required
​
currency
string
required
​
discount
object | null
required
​
external_price_id
string | null
required
​
fixed_price_quantity
number | null
required
​
id
string
required
​
invoicing_cycle_configuration
object | null
required
​
item
object
required
​
maximum
object | null
required
​
maximum_amount
string | null
required
​
metadata
object
required

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

​
minimum
object | null
required
​
minimum_amount
string | null
required
​
model_type
enum<string>
required
Available options:
unit
​
name
string
required
​
plan_phase_order
integer | null
required
​
price_type
enum<string>
required
Available options:
usage_price,
fixed_price
​
unit_config
object
required

Was this page helpful?

Fetch priceEvaluate price