Fetch plan

This endpoint is used to fetch plan details given a plan identifier. It returns information about the prices included in the plan and their configuration, as well as the product that the plan is attached to.

Serialized prices

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. A detailed explanation of price types can be found in the Price schema.

Phases

Orb supports plan phases, also known as contract ramps. For plans with phases, the serialized prices refer to all prices across all phases.

Path Parameters

plan_id string required

Responses

• 200
• 400
• 401
• 404
• 409
• 413
• 429
• 500

---

OK

Response Headers

application/json

Schema

Example (from schema)

---

Schema

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.
property name* string
id string required
name string required
description string required
maximum_amount string nullable required
minimum_amount string nullable required
created_at date-time required
status string required

Possible values: [active, archived, draft]

maximum object nullable

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.

minimum object nullable

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.

discount object nullable

oneOf

PercentageDiscount

TrialDiscount

UsageDiscount

AmountDiscount

---

discount_type string required

Possible values: [percentage]

applies_to_price_ids string[] required

List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.

reason string nullable

percentage_discount number required

Possible values: <= 1

Only available if discount_type is percentage. This is a number between 0 and 1.

discount_type string required

Possible values: [trial]

applies_to_price_ids string[] required

List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.

reason string nullable

trial_amount_discount string nullable

Only available if discount_type is trial

trial_percentage_discount number nullable

Only available if discount_type is trial

discount_type string required

Possible values: [usage]

applies_to_price_ids string[] required

List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.

reason string nullable

usage_discount number required

Only available if discount_type is usage. Number of usage units that this discount is for

discount_type string required

Possible values: [amount]

applies_to_price_ids string[] required

List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.

reason string nullable

amount_discount string required

Only available if discount_type is amount.

product object required
created_at date-time required
id string required
name string required
version integer required
trial_config object required

trial_period integer nullable required

trial_period_unit string required

Possible values: [days]

plan_phases object[] nullable required
Array [
id string required
description string nullable required
duration integer nullable required
How many terms of length duration_unit this phase is active for. If null, this phase is evergreen and active indefinitely
duration_unit string nullable required
Possible values: [daily, monthly, quarterly, semi_annual, annual]
name string required
order integer required
Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
minimum_amount string nullable required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
]
base_plan object nullable
id string nullable required
external_plan_id string nullable required
An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system.
name string nullable required
base_plan_id string nullable required

The parent plan id if the given plan was created by overriding one or more of the parent's prices

external_plan_id string nullable required

An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system.

currency string deprecated

An ISO 4217 currency string or custom pricing unit (credits) for this plan's prices.

invoicing_currency string required

An ISO 4217 currency string for which this plan is billed in. Matches currency unless currency is a custom pricing unit.

net_terms integer nullable required

Determines the difference between the invoice issue date and the due date. A value of "0" here signifies that invoices are due on issue, whereas a value of "30" means that the customer has a month to pay the invoice before its overdue. Note that individual subscriptions or invoices may set a different net terms configuration.

default_invoice_memo string nullable required

The default memo text on the invoices corresponding to subscriptions on this plan. Note that each subscription may configure its own memo.

prices object[] required
Prices for this plan. If the plan has phases, this includes prices across all phases of the plan.
Array [
oneOf
UnitPrice
PackagePrice
MatrixPrice
TieredPrice
TieredBpsPrice
BpsPrice
BulkBpsPrice
BulkPrice
ThresholdTotalAmountPrice
TieredPackagePrice
GroupedTieredPrice
TieredWithMinimumPrice
TieredPackageWithMinimumPrice
PackageWithAllocationPrice
UnitWithPercentPrice
MatrixWithAllocationPrice
TieredWithProrationPrice
UnitWithProrationPrice
GroupedAllocationPrice
GroupedWithProratedMinimumPrice
GroupedWithMeteredMinimumPrice
MatrixWithDisplayNamePrice
BulkWithProrationPrice
GroupedTieredPackagePrice
---
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [unit]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
unit_config object required
unit_amount string required
Rate per unit of usage
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [package]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
package_config object required
package_amount string required
A currency amount to rate usage by
package_size integer required
An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [matrix]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
matrix_config object required
dimensions string[] required
One or two event property values to evaluate matrix groups by
default_unit_amount string required
Default per unit rate for any usage not bucketed into a specified matrix_value
matrix_values object[] required
Matrix values for specified matrix grouping keys
Array [
unit_amount string required
Unit price for the specified dimension_values
dimension_values string[] required
One or two matrix keys to filter usage to this Matrix value by. For example, ["region", "tier"] could be used to filter cloud usage by a cloud region and an instance tier.
]
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [tiered]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
tiered_config object required
tiers object[] required
Tiers for rating based on total usage quantities into the specified tier
Array [
first_unit number required
Inclusive tier starting value
last_unit number nullable
Exclusive tier ending value. If null, this is treated as the last tier
unit_amount string required
Amount per unit
]
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [tiered_bps]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
tiered_bps_config object required
tiers object[] required
Tiers for a Graduated BPS pricing model, where usage is bucketed into specified tiers
Array [
minimum_amount string required
Inclusive tier starting value
maximum_amount string nullable
Exclusive tier ending value
bps number required
Per-event basis point rate
per_unit_maximum string nullable
Per unit maximum to charge
]
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [bps]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
bps_config object required
bps number required
Basis point take rate per event
per_unit_maximum string nullable
Optional currency amount maximum to cap spend per event
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [bulk_bps]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
bulk_bps_config object required
tiers object[] required
Tiers for a bulk BPS pricing model where all usage is aggregated to a single tier based on total volume
Array [
maximum_amount string nullable
Upper bound for tier
bps number required
Basis points to rate on
per_unit_maximum string nullable
The maximum amount to charge for any one event
]
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [bulk]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
bulk_config object required
tiers object[] required
Bulk tiers for rating based on total usage volume
Array [
maximum_units number nullable
Upper bound for this tier
unit_amount string required
Amount per unit
]
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [threshold_total_amount]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
threshold_total_amount_config object required
property name* any
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [tiered_package]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
tiered_package_config object required
property name* any
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [grouped_tiered]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
grouped_tiered_config object required
property name* any
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [tiered_with_minimum]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
tiered_with_minimum_config object required
property name* any
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [tiered_package_with_minimum]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
tiered_package_with_minimum_config object required
property name* any
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [package_with_allocation]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
package_with_allocation_config object required
property name* any
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [unit_with_percent]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
unit_with_percent_config object required
property name* any
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [matrix_with_allocation]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
matrix_with_allocation_config object required
dimensions string[] required
One or two event property values to evaluate matrix groups by
default_unit_amount string required
Default per unit rate for any usage not bucketed into a specified matrix_value
matrix_values object[] required
Matrix values for specified matrix grouping keys
Array [
unit_amount string required
Unit price for the specified dimension_values
dimension_values string[] required
One or two matrix keys to filter usage to this Matrix value by. For example, ["region", "tier"] could be used to filter cloud usage by a cloud region and an instance tier.
]
allocation number required
Allocation to be used to calculate the price
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [tiered_with_proration]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
tiered_with_proration_config object required
property name* any
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [unit_with_proration]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
unit_with_proration_config object required
property name* any
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [grouped_allocation]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
grouped_allocation_config object required
property name* any
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [grouped_with_prorated_minimum]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
grouped_with_prorated_minimum_config object required
property name* any
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [grouped_with_metered_minimum]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
grouped_with_metered_minimum_config object required
property name* any
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [matrix_with_display_name]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
matrix_with_display_name_config object required
property name* any
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [bulk_with_proration]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
bulk_with_proration_config object required
property name* any
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.
property name* string
id string required
name string required
external_price_id string nullable required
price_type string required
Possible values: [usage_price, fixed_price]
model_type string required
Possible values: [grouped_tiered_package]
created_at date-time required
cadence string required
Possible values: [one_time, monthly, quarterly, semi_annual, annual, custom]
billing_cycle_configuration object required
duration integer required
duration_unit string required
Possible values: [day, month]
invoicing_cycle_configuration object nullable
duration integer required
duration_unit string required
Possible values: [day, month]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string required
conversion_rate number nullable required
item object required
id string required
name string required
credit_allocation object nullable
currency string required
allows_rollover boolean required
discount object nullable
oneOf
PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount
---
discount_type string required
Possible values: [percentage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
percentage_discount number required
Possible values: <= 1
Only available if discount_type is percentage. This is a number between 0 and 1.
discount_type string required
Possible values: [trial]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
trial_amount_discount string nullable
Only available if discount_type is trial
trial_percentage_discount number nullable
Only available if discount_type is trial
discount_type string required
Possible values: [usage]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
discount_type string required
Possible values: [amount]
applies_to_price_ids string[] required
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
reason string nullable
amount_discount string required
Only available if discount_type is amount.
minimum object nullable
minimum_amount string required
Minimum amount applied
applies_to_price_ids string[] required
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
minimum_amount string nullable required
maximum object nullable
maximum_amount string required
Maximum amount applied
applies_to_price_ids string[] required
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
maximum_amount string nullable required
grouped_tiered_package_config object required
property name* any
]

{
  "metadata": {},
  "id": "string",
  "name": "string",
  "description": "string",
  "maximum_amount": "string",
  "minimum_amount": "string",
  "created_at": "2024-11-15T18:11:34.951Z",
  "status": "active",
  "maximum": {
    "maximum_amount": "string",
    "applies_to_price_ids": [
      "string"
    ]
  },
  "minimum": {
    "minimum_amount": "string",
    "applies_to_price_ids": [
      "string"
    ]
  },
  "discount": {
    "discount_type": "percentage",
    "applies_to_price_ids": [
      "h74gfhdjvn7ujokd",
      "7hfgtgjnbvc3ujkl"
    ],
    "reason": "string",
    "percentage_discount": 0.15
  },
  "product": {
    "created_at": "2024-11-15T18:11:34.951Z",
    "id": "string",
    "name": "string"
  },
  "version": 0,
  "trial_config": {
    "trial_period": 0,
    "trial_period_unit": "days"
  },
  "plan_phases": [
    {
      "id": "string",
      "description": "string",
      "duration": 0,
      "duration_unit": "daily",
      "name": "string",
      "order": 0,
      "minimum": {
        "minimum_amount": "string",
        "applies_to_price_ids": [
          "string"
        ]
      },
      "maximum": {
        "maximum_amount": "string",
        "applies_to_price_ids": [
          "string"
        ]
      },
      "maximum_amount": "string",
      "minimum_amount": "string",
      "discount": {
        "discount_type": "percentage",
        "applies_to_price_ids": [
          "h74gfhdjvn7ujokd",
          "7hfgtgjnbvc3ujkl"
        ],
        "reason": "string",
        "percentage_discount": 0.15
      }
    }
  ],
  "base_plan": {
    "id": "m2t5akQeh2obwxeU",
    "external_plan_id": "m2t5akQeh2obwxeU",
    "name": "Example plan"
  },
  "base_plan_id": "string",
  "external_plan_id": "string",
  "invoicing_currency": "string",
  "net_terms": 0,
  "default_invoice_memo": "string",
  "prices": [
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {}
  ]
}

Bad Request

Response Headers

application/json

Schema

Example (from schema)

---

Schema

oneOf
ConstraintViolationError
DuplicateResourceCreationError
RequestValidationError
---
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#400-constraint-violation]
status integer required
Possible values: [400]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation]
status integer required
Possible values: [400]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#400-request-validation-errors]
status integer required
Possible values: [400]
detail string nullable
title string nullable
validation_errors undefined[] required

{}

Unauthorized

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#401-authentication-error]

status integer required

Possible values: [401]

detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#401-authentication-error",
  "status": 401,
  "detail": "string",
  "title": "string"
}

Not Found

Response Headers

application/json

Schema

Example (from schema)

---

Schema

oneOf
FeatureNotAvailableError
ResourceNotFoundError
URLNotFound
---
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#404-feature-not-available]
status integer required
Possible values: [400]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#404-resource-not-found]
status integer required
Possible values: [404]
detail string nullable
title string required
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#404-url-not-found]
status integer required
Possible values: [404]
detail string nullable
title string nullable

{}

Conflict

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#409-resource-conflict]

status integer required

Possible values: [409]

detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#409-resource-conflict",
  "status": 409,
  "detail": "string",
  "title": "string"
}

Request Entity Too Large

Response Headers

application/json

Schema

Example (from schema)

---

Schema

oneOf
RequestTooLargeError
ResourceTooLargeError
TooManyResultsError
---
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#413-request-too-large]
status integer required
Possible values: [413]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#413-resource-too-large]
status integer required
Possible values: [413]
detail string nullable
title string nullable
type string required
Possible values: [https://docs.withorb.com/reference/error-responses#413-too-many-results]
status integer required
Possible values: [413]
detail string nullable
title string nullable

{}

Too Many Requests

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#429-too-many-requests]

status integer required

Possible values: [429]

detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#429-too-many-requests",
  "status": 429,
  "detail": "string",
  "title": "string"
}

Internal Server Error

Response Headers

application/json

Schema

Example (from schema)

---

Schema

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#500-internal-server-error]

status integer required
detail string nullable
title string nullable

{
  "type": "https://docs.withorb.com/reference/error-responses#500-internal-server-error",
  "status": 0,
  "detail": "string",
  "title": "string"
}

Loading...