PUT
/
prices
/
{price_id}
curl --request PUT \
  --url https://api.withorb.com/v1/prices/{price_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": {}
}'
{
  "metadata": {},
  "id": "<string>",
  "name": "<string>",
  "external_price_id": "<string>",
  "price_type": "usage_price",
  "model_type": "unit",
  "created_at": "2023-11-07T05:31:56Z",
  "cadence": "one_time",
  "billing_cycle_configuration": {
    "duration": 123,
    "duration_unit": "day"
  },
  "invoicing_cycle_configuration": {
    "duration": 123,
    "duration_unit": "day"
  },
  "billable_metric": {
    "id": "<string>"
  },
  "dimensional_price_configuration": {
    "dimensional_price_group_id": "<string>",
    "dimension_values": [
      "<string>"
    ]
  },
  "fixed_price_quantity": 123,
  "plan_phase_order": 123,
  "currency": "<string>",
  "conversion_rate": 123,
  "item": {
    "id": "<string>",
    "name": "<string>"
  },
  "credit_allocation": {
    "currency": "<string>",
    "allows_rollover": true
  },
  "discount": {
    "discount_type": "percentage",
    "applies_to_price_ids": [
      "h74gfhdjvn7ujokd",
      "7hfgtgjnbvc3ujkl"
    ],
    "reason": "<string>",
    "percentage_discount": 0.15
  },
  "minimum": {
    "minimum_amount": "<string>",
    "applies_to_price_ids": [
      "<string>"
    ]
  },
  "minimum_amount": "<string>",
  "maximum": {
    "maximum_amount": "<string>",
    "applies_to_price_ids": [
      "<string>"
    ]
  },
  "maximum_amount": "<string>",
  "unit_config": {
    "unit_amount": "<string>"
  }
}

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
OK

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

​
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.

​
id
string
required
​
name
string
required
​
external_price_id
string | null
required
​
price_type
enum<string>
required
Available options:
usage_price,
fixed_price
​
model_type
enum<string>
required
Available options:
unit
​
created_at
string
required
​
cadence
enum<string>
required
Available options:
one_time,
monthly,
quarterly,
semi_annual,
annual,
custom
​
billing_cycle_configuration
object
required
​
invoicing_cycle_configuration
object | null
required
​
billable_metric
object | null
required
​
fixed_price_quantity
number | null
required
​
plan_phase_order
integer | null
required
​
currency
string
required
​
conversion_rate
number | null
required
​
item
object
required
​
credit_allocation
object | null
required
​
discount
object | null
required
​
minimum
object | null
required
​
minimum_amount
string | null
required
​
maximum
object | null
required
​
maximum_amount
string | null
required
​
unit_config
object
required
​
dimensional_price_configuration
object | null

Was this page helpful?