List subscriptions

This endpoint returns a list of all subscriptions for an account as a paginated list, ordered starting from the most recently created subscription. For a full discussion of the subscription resource, see Subscription.

Subscriptions can be filtered to a single customer by passing in the customer_id query parameter or the external_customer_id query parameter.

Query Parameters

limit integer

Default value: 20

cursor string
customer_id string
external_customer_id string
status string

Possible values: [active, ended, upcoming]

created_at[gte] date-time
created_at[gt] date-time
created_at[lt] date-time
created_at[lte] date-time

Responses

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

---

OK

Response Headers

application/json

Schema

Example (from schema)

---

Schema

data object[] required
Array [
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
customer object required
A customer is a buyer of your products, and the other party to the billing relationship.
In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an external_customer_id with your own identifier. See Customer ID Aliases for further information about how these aliases work in Orb.
In addition to having an identifier in your system, a customer may exist in a payment provider solution like Stripe. Use the payment_provider_id and the payment_provider enum field to express this mapping.
A customer also has a timezone (from the standard IANA timezone database), which defaults to your account's timezone. See Timezone localization for information on what this timezone parameter influences within Orb.
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
external_customer_id string nullable required
An optional user-defined ID for this customer resource, used throughout the system as an alias for this Customer. Use this field to identify a customer by an existing identifier in your system.
name string required
The full name of the customer
email string required
A valid customer email, to be used for notifications. When Orb triggers payment through a payment gateway, this email will be used for any automatically issued receipts.
timezone string required
A timezone identifier from the IANA timezone database, such as "America/Los_Angeles". This "defaults to your account's timezone if not set. This cannot be changed after customer creation.
payment_provider_id string nullable required
The ID of this customer in an external payments solution, such as Stripe. This is used for creating charges or invoices in the external system via Orb.
payment_provider string nullable required
Possible values: [quickbooks, bill.com, stripe_charge, stripe_invoice, netsuite]
This is used for creating charges or invoices in an external system via Orb. When not in test mode, the connection must first be configured in the Orb webapp.
created_at date-time required
shipping_address object nullable
line1 string nullable required
line2 string nullable required
city string nullable required
state string nullable required
postal_code string nullable required
country string nullable required
billing_address object nullable
line1 string nullable required
line2 string nullable required
city string nullable required
state string nullable required
postal_code string nullable required
country string nullable required
balance string required
The customer's current balance in their currency.
currency string nullable required
tax_id object nullable
Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices.
Supported Tax ID Countries and Types
Country	Type	Description
Andorra	ad_nrt	Andorran NRT number
Australia	au_abn	Australian Business Number (AU ABN)
Australia	au_arn	Australian Taxation Office Reference Number
Austria	eu_vat	European VAT number
Belgium	eu_vat	European VAT number
Brazil	br_cnpj	Brazilian CNPJ number
Brazil	br_cpf	Brazilian CPF number
Bulgaria	bg_uic	Bulgaria Unified Identification Code
Bulgaria	eu_vat	European VAT number
Canada	ca_bn	Canadian BN
Canada	ca_gst_hst	Canadian GST/HST number
Canada	ca_pst_bc	Canadian PST number (British Columbia)
Canada	ca_pst_mb	Canadian PST number (Manitoba)
Canada	ca_pst_sk	Canadian PST number (Saskatchewan)
Canada	ca_qst	Canadian QST number (Québec)
Chile	cl_tin	Chilean TIN
Croatia	eu_vat	European VAT number
Cyprus	eu_vat	European VAT number
Czech Republic	eu_vat	European VAT number
Denmark	eu_vat	European VAT number
Egypt	eg_tin	Egyptian Tax Identification Number
Estonia	eu_vat	European VAT number
EU	eu_oss_vat	European One Stop Shop VAT number for non-Union scheme
Finland	eu_vat	European VAT number
France	eu_vat	European VAT number
Georgia	ge_vat	Georgian VAT
Germany	eu_vat	European VAT number
Greece	eu_vat	European VAT number
Hong Kong	hk_br	Hong Kong BR number
Hungary	eu_vat	European VAT number
Hungary	hu_tin	Hungary tax number (adószám)
Iceland	is_vat	Icelandic VAT
India	in_gst	Indian GST number
Indonesia	id_npwp	Indonesian NPWP number
Ireland	eu_vat	European VAT number
Israel	il_vat	Israel VAT
Italy	eu_vat	European VAT number
Japan	jp_cn	Japanese Corporate Number (Hōjin Bangō)
Japan	jp_rn	Japanese Registered Foreign Businesses' Registration Number (Tōroku Kokugai Jigyōsha no Tōroku Bangō)
Japan	jp_trn	Japanese Tax Registration Number (Tōroku Bangō)
Kenya	ke_pin	Kenya Revenue Authority Personal Identification Number
Latvia	eu_vat	European VAT number
Liechtenstein	li_uid	Liechtensteinian UID number
Lithuania	eu_vat	European VAT number
Luxembourg	eu_vat	European VAT number
Malaysia	my_frp	Malaysian FRP number
Malaysia	my_itn	Malaysian ITN
Malaysia	my_sst	Malaysian SST number
Malta	eu_vat	European VAT number
Mexico	mx_rfc	Mexican RFC number
Netherlands	eu_vat	European VAT number
New Zealand	nz_gst	New Zealand GST number
Norway	no_vat	Norwegian VAT number
Philippines	ph_tin	Philippines Tax Identification Number
Poland	eu_vat	European VAT number
Portugal	eu_vat	European VAT number
Romania	eu_vat	European VAT number
Russia	ru_inn	Russian INN
Russia	ru_kpp	Russian KPP
Saudi Arabia	sg_gst	Singaporean GST
Singapore	sg_uen	Singaporean UEN
Slovakia	eu_vat	European VAT number
Slovenia	eu_vat	European VAT number
Slovenia	si_tin	Slovenia tax number (davčna številka)
South Africa	za_vat	South African VAT number
South Korea	kr_brn	Korean BRN
Spain	es_cif	Spanish NIF number (previously Spanish CIF number)
Spain	eu_vat	European VAT number
Sweden	eu_vat	European VAT number
Switzerland	ch_vat	Switzerland VAT number
Taiwan	tw_vat	Taiwanese VAT
Thailand	th_vat	Thai VAT
Turkey	tr_tin	Turkish Tax Identification Number
Ukraine	ua_vat	Ukrainian VAT
United Arab Emirates	ae_trn	United Arab Emirates TRN
United Kingdom	eu_vat	Northern Ireland VAT number
United Kingdom	gb_vat	United Kingdom VAT number
United States	us_ein	United States EIN
country string required
Possible values: [AD, AE, AT, AU, BE, BG, BR, CA, CH, CL, CY, CZ, DE, DK, EE, EG, ES, EU, FI, FR, GB, GE, GR, HK, HR, HU, ID, IE, IL, IN, IS, IT, JP, KE, KR, LI, LT, LU, LV, MT, MX, MY, NL, NO, NZ, PH, PL, PT, RO, RU, SA, SE, SG, SI, SK, TH, TR, TW, UA, US, ZA]
type string required
Possible values: [ad_nrt, ae_trn, eu_vat, au_abn, au_arn, bg_uic, br_cnpj, br_cpf, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, ch_vat, cl_tin, eg_tin, es_cif, eu_oss_vat, gb_vat, ge_vat, hk_br, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kr_brn, li_uid, mx_rfc, my_frp, my_itn, my_sst, no_vat, nz_gst, ph_tin, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, th_vat, tr_tin, tw_vat, ua_vat, us_ein, za_vat]
value string required
auto_collection boolean required
email_delivery boolean required
additional_emails string[] required
portal_url string nullable required
accounting_sync_configuration object nullable
excluded boolean required
accounting_providers object[] required
Array [
provider_type string required
Possible values: [quickbooks, netsuite]
external_provider_id string nullable required
]
reporting_configuration object nullable
exempt boolean required
plan object required
The Plan resource represents a plan that can be subscribed to by a customer. Plans define the billing behavior of the subscription. You can see more about how to configure prices in the Price resource.
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, 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 required
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
---
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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 nullable
An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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.
]
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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
]
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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
]
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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
]
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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
]
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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
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, annual]
billable_metric object nullable
id string required
fixed_price_quantity number nullable required
plan_phase_order integer nullable required
currency string 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
]
start_date date-time required
The date Orb starts billing for this subscription.
end_date date-time nullable required
The date Orb stops billing for this subscription.
created_at date-time required
current_billing_period_start_date date-time nullable required
The start date of the current billing period. This is an inclusive timestamp; the instant returned is exactly the beginning of the billing period. Set to null if the subscription is not currently active.
current_billing_period_end_date date-time nullable required
The end of the current billing period. This is an exclusive timestamp, such that the instant returned is not part of the billing period. Set to null for subscriptions that are not currently active.
status string required
Possible values: [active, ended, upcoming]
trial_info object required
end_date date-time nullable required
active_plan_phase_order integer nullable required
The current plan phase that is active, only if the subscription's plan has phases.
fixed_fee_quantity_schedule object[] required
Array [
price_id string required
start_date date-time required
end_date date-time nullable required
quantity number required
]
default_invoice_memo string nullable required
Determines the default memo on this subscriptions' invoices. Note that if this is not provided, it is determined by the plan configuration.
auto_collection boolean nullable required
Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date. This property defaults to the plan's behavior.
net_terms integer required
Determines the difference between the invoice issue date for subscription invoices as the date that they are due. A value of 0 here represents that the invoice is due on issue, whereas a value of 30 represents that the customer has a month to pay the invoice.
redeemed_coupon object nullable
coupon_id string required
start_date date-time required
end_date date-time nullable required
billing_cycle_day integer required
Possible values: >= 1 and <= 31
The day of the month on which the billing cycle is anchored. If the maximum number of days in a month is greater than this value, the last day of the month is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing period begins on the 30th.
invoicing_threshold string nullable required
price_intervals object[] required
The price intervals for this subscription.
Array [
id string required
start_date date-time required
The start date of the price interval. This is the date that Orb starts billing for this price.
end_date date-time nullable required
The end date of the price interval. This is the date that Orb stops billing for this price.
price object required
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
oneOf
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
---
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
object
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
Unit pricing
With unit pricing, each unit costs a fixed amount.
{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}
Tiered pricing
In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.
{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...
Bulk pricing
Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).
{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}
Package pricing
Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}
BPS pricing
BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.
{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }
Bulk BPS pricing
Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.
    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Tiered BPS pricing
Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.
    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}
Matrix pricing
Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.
{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}
Fixed fees
Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.
{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}
billing_cycle_day integer required
The day of the month that Orb bills for this price
fixed_fee_quantity_transitions object[] nullable required
The fixed fee quantity transitions for this price interval. This is only relevant for fixed fees.
Array [
price_id string required
effective_date date-time required
quantity integer required
]
current_billing_period_start_date date-time nullable required
The start date of the current billing period. This is an inclusive timestamp; the instant returned is exactly the beginning of the billing period. Set to null if this price interval is not currently active.
current_billing_period_end_date date-time nullable required
The end of the current billing period. This is an exclusive timestamp, such that the instant returned is exactly the end of the billing period. Set to null if this price interval is not currently active.
]
discount_intervals object[] required
The discount intervals for this subscription.
Array [
oneOf
AmountDiscountInterval
PercentageDiscountInterval
UsageDiscountInterval
---
discount_type string required
Possible values: [amount]
amount_discount string required
Only available if discount_type is amount.
start_date date-time required
The start date of the discount interval.
end_date date-time nullable required
The end date of the discount interval.
applies_to_price_ids string[] required
The price ids that this discount interval applies to.
applies_to_price_interval_ids string[] required
The price interval ids that this discount interval applies to.
discount_type string required
Possible values: [percentage]
percentage_discount number required
Only available if discount_type is percentage.This is a number between 0 and 1.
start_date date-time required
The start date of the discount interval.
end_date date-time nullable required
The end date of the discount interval.
applies_to_price_ids string[] required
The price ids that this discount interval applies to.
applies_to_price_interval_ids string[] required
The price interval ids that this discount interval applies to.
discount_type string required
Possible values: [usage]
usage_discount number required
Only available if discount_type is usage. Number of usage units that this discount is for
start_date date-time required
The start date of the discount interval.
end_date date-time nullable required
The end date of the discount interval.
applies_to_price_ids string[] required
The price ids that this discount interval applies to.
applies_to_price_interval_ids string[] required
The price interval ids that this discount interval applies to.
]
minimum_intervals object[] required
The minimum intervals for this subscription.
Array [
start_date date-time required
The start date of the minimum interval.
end_date date-time nullable required
The end date of the minimum interval.
applies_to_price_ids string[] required
The price ids that this minimum interval applies to.
applies_to_price_interval_ids string[] required
The price interval ids that this minimum interval applies to.
minimum_amount string required
The minimum amount to charge in a given billing period for the price intervals this minimum applies to.
]
maximum_intervals object[] required
The maximum intervals for this subscription.
Array [
start_date date-time required
The start date of the maximum interval.
end_date date-time nullable required
The end date of the maximum interval.
applies_to_price_ids string[] required
The price ids that this maximum interval applies to.
applies_to_price_interval_ids string[] required
The price interval ids that this maximum interval applies to.
maximum_amount string required
The maximum amount to charge in a given billing period for the price intervals this transform applies to.
]
]
pagination_metadata object required
has_more boolean required
next_cursor string nullable required

{
  "data": [
    {
      "metadata": {},
      "id": "string",
      "customer": {
        "metadata": {},
        "id": "string",
        "external_customer_id": "string",
        "name": "string",
        "email": "string",
        "timezone": "string",
        "payment_provider_id": "string",
        "payment_provider": "quickbooks",
        "created_at": "2024-04-19T21:08:11.615Z",
        "shipping_address": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "state": "string",
          "postal_code": "string",
          "country": "string"
        },
        "billing_address": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "state": "string",
          "postal_code": "string",
          "country": "string"
        },
        "balance": "string",
        "currency": "string",
        "tax_id": {
          "country": "AD",
          "type": "ad_nrt",
          "value": "string"
        },
        "auto_collection": true,
        "email_delivery": true,
        "additional_emails": [
          "string"
        ],
        "portal_url": "string",
        "accounting_sync_configuration": {
          "excluded": true,
          "accounting_providers": [
            {
              "provider_type": "quickbooks",
              "external_provider_id": "string"
            }
          ]
        },
        "reporting_configuration": {
          "exempt": true
        }
      },
      "plan": {
        "metadata": {},
        "id": "string",
        "name": "string",
        "description": "string",
        "maximum_amount": "string",
        "minimum_amount": "string",
        "created_at": "2024-04-19T21:08:11.618Z",
        "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-04-19T21:08:11.618Z",
          "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",
        "currency": "string",
        "invoicing_currency": "string",
        "net_terms": 0,
        "default_invoice_memo": "string",
        "prices": [
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {},
          {}
        ]
      },
      "start_date": "2024-04-19T21:08:11.621Z",
      "end_date": "2024-04-19T21:08:11.621Z",
      "created_at": "2024-04-19T21:08:11.621Z",
      "current_billing_period_start_date": "2024-04-19T21:08:11.621Z",
      "current_billing_period_end_date": "2024-04-19T21:08:11.621Z",
      "status": "active",
      "trial_info": {
        "end_date": "2024-04-19T21:08:11.621Z"
      },
      "active_plan_phase_order": 0,
      "fixed_fee_quantity_schedule": [
        {
          "price_id": "string",
          "start_date": "2024-04-19T21:08:11.621Z",
          "end_date": "2024-04-19T21:08:11.621Z",
          "quantity": 0
        }
      ],
      "default_invoice_memo": "string",
      "auto_collection": true,
      "net_terms": 0,
      "redeemed_coupon": {
        "coupon_id": "string",
        "start_date": "2024-04-19T21:08:11.621Z",
        "end_date": "2024-04-19T21:08:11.621Z"
      },
      "billing_cycle_day": 0,
      "invoicing_threshold": "string",
      "price_intervals": [
        {
          "id": "string",
          "start_date": "2024-04-19T21:08:11.628Z",
          "end_date": "2024-04-19T21:08:11.628Z",
          "price": {
            "id": "string",
            "name": "string",
            "external_price_id": "string",
            "price_type": "usage_price",
            "model_type": "unit",
            "created_at": "2024-04-19T21:08:11.628Z",
            "cadence": "one_time",
            "billable_metric": {
              "id": "string"
            },
            "fixed_price_quantity": 0,
            "plan_phase_order": 0,
            "currency": "string",
            "item": {
              "id": "string",
              "name": "string"
            },
            "credit_allocation": {
              "currency": "string",
              "allows_rollover": true
            },
            "discount": {
              "discount_type": "percentage",
              "applies_to_price_ids": [
                "h74gfhdjvn7ujokd",
                "7hfgtgjnbvc3ujkl"
              ],
              "reason": "string",
              "percentage_discount": 0.15
            },
            "minimum": {
              "minimum_amount": "string",
              "applies_to_price_ids": [
                "string"
              ]
            },
            "minimum_amount": "string",
            "maximum": {
              "maximum_amount": "string",
              "applies_to_price_ids": [
                "string"
              ]
            },
            "maximum_amount": "string",
            "unit_config": {
              "unit_amount": "string"
            }
          },
          "billing_cycle_day": 0,
          "fixed_fee_quantity_transitions": [
            {
              "price_id": "string",
              "effective_date": "2024-04-19T21:08:11.629Z",
              "quantity": 0
            }
          ],
          "current_billing_period_start_date": "2024-04-19T21:08:11.629Z",
          "current_billing_period_end_date": "2024-04-19T21:08:11.629Z"
        }
      ],
      "discount_intervals": [
        {},
        {},
        {}
      ],
      "minimum_intervals": [
        {
          "start_date": "2024-04-19T21:08:11.629Z",
          "end_date": "2024-04-19T21:08:11.629Z",
          "applies_to_price_ids": [
            "string"
          ],
          "applies_to_price_interval_ids": [
            "string"
          ],
          "minimum_amount": "string"
        }
      ],
      "maximum_intervals": [
        {
          "start_date": "2024-04-19T21:08:11.629Z",
          "end_date": "2024-04-19T21:08:11.629Z",
          "applies_to_price_ids": [
            "string"
          ],
          "applies_to_price_interval_ids": [
            "string"
          ],
          "maximum_amount": "string"
        }
      ]
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "string"
  }
}

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