List prices

GET

prices

Authorizations

Authorization

string

header

required

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

Query Parameters

limit

integer

default:

The number of items to fetch. Defaults to 20.

Required range: 1 < x < 1000

cursor

string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

Response

200 - application/json

data

object[]

required

data.billable_metric

object | null

required

data.billing_cycle_configuration

object

required

data.cadence

enum<string>

required

Available options:

one_time,

monthly,

quarterly,

semi_annual,

annual,

custom

data.conversion_rate

number | null

required

data.created_at

string

required

data.credit_allocation

object | null

required

data.currency

string

required

data.discount

object | null

required

data.external_price_id

string | null

required

data.fixed_price_quantity

number | null

required

data.id

string

required

data.invoicing_cycle_configuration

object | null

required

data.item

object

required

data.maximum

object | null

required

data.maximum_amount

string | null

required

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

data.minimum

object | null

required

data.minimum_amount

string | null

required

data.model_type

enum<string>

required

Available options:

unit

data.name

string

required

data.plan_phase_order

integer | null

required

data.price_type

enum<string>

required

Available options:

usage_price,

fixed_price

data.unit_config

object

required

pagination_metadata

object

required

Was this page helpful?

Update plan by id Create price

API Documentation

Alert

Coupon

Credit note

Customer

Credit

Dimensional Price Group

Event

Invoice

Item

Metric

Availability

Plan

Price

Subscription

Price interval

List prices

Authorizations

Query Parameters

Response