--- title: "List invoices" method: GET path: "/invoices" tags: ["Invoice"] --- # List invoices `GET /invoices` This endpoint returns a list of all [`Invoice`](/core-concepts#invoice)s for an account in a list format. The list of invoices is ordered starting from the most recently issued invoice date. The response also includes [`pagination_metadata`](/api-reference/pagination), which lets the caller retrieve the next page of results if they exist. By default, this only returns invoices that are `issued`, `paid`, or `synced`. When fetching any `draft` invoices, this returns the last-computed invoice values for each draft invoice, which may not always be up-to-date since Orb regularly refreshes invoices asynchronously. If you don't need line item details, minimums, maximums, or discounts, prefer the [list invoices summary](/api-reference/invoice/list-invoices-summary) endpoint for better performance. ## Query parameters - `customer_id` string, nullable - `external_customer_id` string, nullable - `subscription_id` string, nullable - `status` 'draft' | 'issued' | 'paid' | 'synced' | 'void', nullable - `status[]` string[], nullable - `due_date_window` string, nullable — Filters invoices by their due dates within a specific time range in the past. Specify the range as a number followed by 'd' (days) or 'm' (months). For example, '7d' filters invoices due in the last 7 days, and '2m' filters those due in the last 2 months. - `date_type` 'due_date' | 'invoice_date', nullable - `due_date` string, date, nullable - `due_date[gt]` string, date, nullable - `due_date[lt]` string, date, nullable - `amount` string, nullable - `amount[gt]` string, nullable - `amount[lt]` string, nullable - `is_recurring` boolean, nullable - `limit` integer — The number of items to fetch. Defaults to 20. - `cursor` string, nullable — Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request. - `invoice_date[gte]` string, date-time, nullable - `invoice_date[gt]` string, date-time, nullable - `invoice_date[lt]` string, date-time, nullable - `invoice_date[lte]` string, date-time, nullable ## Response `200` OK - Invoices - `data` Invoice[], required - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `voided_at` string, date-time, nullable, required — If the invoice has a status of `void`, this gives a timestamp when the invoice was voided. - `paid_at` string, date-time, nullable, required — If the invoice has a status of `paid`, this gives a timestamp when the invoice was paid. - `issued_at` string, date-time, nullable, required — If the invoice has been issued, this will be the time it transitioned to `issued` (even if it is now in a different state.) - `scheduled_issue_at` string, date-time, nullable, required — If the invoice is in draft, this timestamp will reflect when the invoice is scheduled to be issued. - `auto_collection` AutoCollection, required - `next_attempt_at` string, date-time, nullable, required — If the invoice is scheduled for auto-collection, this field will reflect when the next attempt will occur. If dunning has been exhausted, or auto-collection is not enabled for this invoice, this field will be `null`. - `previously_attempted_at` string, date-time, nullable, required — If Orb has ever attempted payment auto-collection for this invoice, this field will reflect when that attempt occurred. In conjunction with `next_attempt_at`, this can be used to tell whether the invoice is currently in dunning (that is, `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or if dunning has been exhausted (`previously_attempted_at` is non-null, but `next_attempt_time` is null). - `enabled` boolean, nullable, required — True only if auto-collection is enabled for this invoice. - `num_attempts` integer, nullable, required — Number of auto-collection payment attempts. - `issue_failed_at` string, date-time, nullable, required — If the invoice failed to issue, this will be the last time it failed to issue (even if it is now in a different state.) - `sync_failed_at` string, date-time, nullable, required — If the invoice failed to sync, this will be the last time an external invoicing provider sync was attempted. This field will always be `null` for invoices using Orb Invoicing. - `payment_failed_at` string, date-time, nullable, required — If payment was attempted on this invoice but failed, this will be the time of the most recent attempt. - `payment_started_at` string, date-time, nullable, required — If payment was attempted on this invoice, this will be the start time of the most recent attempt. This field is especially useful for delayed-notification payment mechanisms (like bank transfers), where payment can take 3 days or more. - `amount_due` string, required — This is the final amount required to be charged to the customer and reflects the application of the customer balance to the `total` of the invoice. - `created_at` string, date-time, required — The creation time of the resource in Orb. - `currency` string, required — An ISO 4217 currency string or `credits` - `customer` CustomerMinified, required - `id` string, required - `external_customer_id` string, nullable, required - `due_date` string, date-time, nullable, required — When the invoice payment is due. The due date is null if the invoice is not yet finalized. - `id` string, required - `invoice_pdf` string, nullable, required — The link to download the PDF representation of the `Invoice`. - `invoice_number` string, required — Automatically generated invoice number to help track and reconcile invoices. Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per account or customer. - `subscription` SubscriptionMinified, required - `id` string, required - `total` string, required — The total after any minimums and discounts have been applied. - `customer_balance_transactions` CustomerBalanceTransaction[], required - `id` string, required — A unique id for this transaction. - `created_at` string, date-time, required — The creation time of this transaction. - `starting_balance` string, required — The original value of the customer's balance prior to the transaction, in the customer's currency. - `ending_balance` string, required — The new value of the customer's balance prior to the transaction, in the customer's currency. - `amount` string, required — The value of the amount changed in the transaction. - `action` 'applied_to_invoice' | 'manual_adjustment' | 'prorated_refund' | 'revert_prorated_refund' | 'return_from_voiding' | 'credit_note_applied' | 'credit_note_voided' | 'overpayment_refund' | 'external_payment' | 'small_invoice_carryover', required - `description` string, nullable, required — An optional description provided for manual customer balance adjustments. - `invoice` InvoiceTiny, required - `id` string, required — The Invoice id - `type` 'increment' | 'decrement', required - `credit_note` CreditNoteTiny, required - `id` string, required — The id of the Credit note - `status` 'issued' | 'paid' | 'synced' | 'void' | 'draft', required - `invoice_source` 'subscription' | 'partial' | 'one_off', required - `shipping_address` Address, required - `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` Address, required - `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 - `hosted_invoice_url` string, nullable, required — A URL for the customer-facing invoice portal. This URL expires 60 days after the link is generated, or 30 days after the invoice's due date — whichever is later. - `will_auto_issue` boolean, required — This is true if the invoice will be automatically issued in the future, and false otherwise. - `eligible_to_issue_at` string, date-time, nullable, required — If the invoice has a status of `draft`, this will be the time that the invoice will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is true, the invoice will automatically begin issuing at this time. - `customer_tax_id` CustomerTaxId, required — 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 | |---------|------|-------------| | Albania | `al_tin` | Albania Tax Identification Number | | Andorra | `ad_nrt` | Andorran NRT Number | | Angola | `ao_tin` | Angola Tax Identification Number | | Argentina | `ar_cuit` | Argentinian Tax ID Number | | Armenia | `am_tin` | Armenia Tax Identification Number | | Aruba | `aw_tin` | Aruba Tax Identification Number | | Australia | `au_abn` | Australian Business Number (AU ABN) | | Australia | `au_arn` | Australian Taxation Office Reference Number | | Austria | `eu_vat` | European VAT Number | | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number | | Bahamas | `bs_tin` | Bahamas Tax Identification Number | | Bahrain | `bh_vat` | Bahraini VAT Number | | Bangladesh | `bd_bin` | Bangladesh Business Identification Number | | Barbados | `bb_tin` | Barbados Tax Identification Number | | Belarus | `by_tin` | Belarus TIN Number | | Belgium | `eu_vat` | European VAT Number | | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) | | Bolivia | `bo_tin` | Bolivian Tax ID | | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification 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 | | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) | | Cambodia | `kh_tin` | Cambodia Tax Identification Number | | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) | | 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) | | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) | | Chile | `cl_tin` | Chilean TIN | | China | `cn_tin` | Chinese Tax ID | | Colombia | `co_nit` | Colombian NIT Number | | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) | | Costa Rica | `cr_tin` | Costa Rican Tax ID | | Croatia | `eu_vat` | European VAT Number | | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) | | Cyprus | `eu_vat` | European VAT Number | | Czech Republic | `eu_vat` | European VAT Number | | Denmark | `eu_vat` | European VAT Number | | Dominican Republic | `do_rcn` | Dominican RCN Number | | Ecuador | `ec_ruc` | Ecuadorian RUC Number | | Egypt | `eg_tin` | Egyptian Tax Identification Number | | El Salvador | `sv_nit` | El Salvadorian NIT Number | | Estonia | `eu_vat` | European VAT Number | | Ethiopia | `et_tin` | Ethiopia Tax Identification Number | | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | | Faroe Islands | `fo_vat` | Faroe Islands VAT Number | | Finland | `eu_vat` | European VAT Number | | France | `eu_vat` | European VAT Number | | Georgia | `ge_vat` | Georgian VAT | | Germany | `de_stn` | German Tax Number (Steuernummer) | | Germany | `eu_vat` | European VAT Number | | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number | | Greece | `eu_vat` | European VAT Number | | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) | | 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 | | Italy | `it_cf` | Italian Codice Fiscale 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ō*) | | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number | | Laos | `la_tin` | Laos Tax Identification Number | | Latvia | `eu_vat` | European VAT Number | | Liechtenstein | `li_uid` | Liechtensteinian UID Number | | Liechtenstein | `li_vat` | Liechtenstein VAT 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 | | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) | | Mexico | `mx_rfc` | Mexican RFC Number | | Moldova | `md_vat` | Moldova VAT Number | | Montenegro | `me_pib` | Montenegro PIB Number | | Morocco | `ma_vat` | Morocco VAT Number | | Nepal | `np_pan` | Nepal PAN Number | | Netherlands | `eu_vat` | European VAT Number | | New Zealand | `nz_gst` | New Zealand GST Number | | Nigeria | `ng_tin` | Nigerian Tax Identification Number | | North Macedonia | `mk_vat` | North Macedonia VAT Number | | Northern Ireland | `eu_vat` | Northern Ireland VAT Number | | Norway | `no_vat` | Norwegian VAT Number | | Norway | `no_voec` | Norwegian VAT on e-commerce Number | | Oman | `om_vat` | Omani VAT Number | | Paraguay | `py_ruc` | Paraguayan RUC Number | | Peru | `pe_ruc` | Peruvian RUC Number | | Philippines | `ph_tin` | Philippines Tax Identification Number | | Poland | `eu_vat` | European VAT Number | | Poland | `pl_nip` | Polish Tax ID Number | | Portugal | `eu_vat` | European VAT Number | | Romania | `eu_vat` | European VAT Number | | Romania | `ro_tin` | Romanian Tax ID Number | | Russia | `ru_inn` | Russian INN | | Russia | `ru_kpp` | Russian KPP | | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | | Senegal | `sn_ninea` | Senegal NINEA Number | | Serbia | `rs_pib` | Serbian PIB Number | | Singapore | `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 | | Sri Lanka | `lk_vat` | Sri Lanka VAT Number | | Suriname | `sr_fin` | Suriname FIN Number | | Sweden | `eu_vat` | European VAT Number | | Switzerland | `ch_uid` | Switzerland UID Number | | Switzerland | `ch_vat` | Switzerland VAT Number | | Taiwan | `tw_vat` | Taiwanese VAT | | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number | | Tanzania | `tz_vat` | Tanzania VAT Number | | Thailand | `th_vat` | Thai VAT | | Turkey | `tr_tin` | Turkish Tax Identification Number | | Uganda | `ug_tin` | Uganda Tax Identification Number | | Ukraine | `ua_vat` | Ukrainian VAT | | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | | United Kingdom | `gb_vat` | United Kingdom VAT Number | | United States | `us_ein` | United States EIN | | Uruguay | `uy_ruc` | Uruguayan RUC Number | | Uzbekistan | `uz_tin` | Uzbekistan TIN Number | | Uzbekistan | `uz_vat` | Uzbekistan VAT Number | | Venezuela | `ve_rif` | Venezuelan RIF Number | | Vietnam | `vn_tin` | Vietnamese Tax ID Number | | Zambia | `zm_tin` | Zambia Tax Identification Number | | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number | - `country` 'AD' | 'AE' | 'AL' | 'AM' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BJ' | 'BO' | 'BR' | 'BS' | 'BY' | 'CA' | 'CD' | 'CH' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CY' | 'CZ' | 'DE' | 'DK' | 'DO' | 'EC' | 'EE' | 'EG' | 'ES' | 'ET' | 'EU' | 'FI' | 'FO' | 'FR' | 'GB' | 'GE' | 'GI' | 'GN' | 'GR' | 'HK' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IS' | 'IT' | 'JP' | 'KE' | 'KG' | 'KH' | 'KR' | 'KZ' | 'LA' | 'LI' | 'LK' | 'LT' | 'LU' | 'LV' | 'MA' | 'MD' | 'ME' | 'MK' | 'MR' | 'MT' | 'MX' | 'MY' | 'NG' | 'NL' | 'NO' | 'NP' | 'NZ' | 'OM' | 'PE' | 'PH' | 'PL' | 'PT' | 'PY' | 'RO' | 'RS' | 'RU' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'SN' | 'SR' | 'SV' | 'TH' | 'TJ' | 'TR' | 'TW' | 'TZ' | 'UA' | 'UG' | 'US' | 'UY' | 'UZ' | 'VE' | 'VN' | 'ZA' | 'ZM' | 'ZW', required - `type` 'ad_nrt' | 'ae_trn' | 'al_tin' | 'am_tin' | 'ao_tin' | 'ar_cuit' | 'eu_vat' | 'au_abn' | 'au_arn' | 'aw_tin' | 'az_tin' | 'ba_tin' | 'bb_tin' | 'bd_bin' | 'bf_ifu' | 'bg_uic' | 'bh_vat' | 'bj_ifu' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'bs_tin' | 'by_tin' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'cd_nif' | 'ch_uid' | 'ch_vat' | 'cl_tin' | 'cm_niu' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'cv_nif' | 'de_stn' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'et_tin' | 'eu_oss_vat' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_vat' | 'ma_vat' | 'md_vat' | 'me_pib' | 'mk_vat' | 'mr_nif' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'np_pan' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'pl_nip' | 'py_ruc' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sn_ninea' | 'sr_fin' | 'sv_nit' | 'th_vat' | 'tj_tin' | 'tr_tin' | 'tw_vat' | 'tz_vat' | 'ua_vat' | 'ug_tin' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin', required - `value` string, required - `memo` string, nullable, required — Free-form text which is available on the invoice PDF and the Orb invoice portal. - `credit_notes` CreditNoteSummary[], required — A list of credit notes associated with the invoice - `id` string, required - `credit_note_number` string, required - `reason` string, required - `total` string, required - `voided_at` string, date-time, nullable, required — If the credit note has a status of `void`, this gives a timestamp when the credit note was voided. - `type` string, required - `memo` string, nullable, required — An optional memo supplied on the credit note. - `payment_attempts` PaymentAttempt[], required — A list of payment attempts associated with the invoice - `id` string, required — The ID of the payment attempt. - `payment_provider` 'stripe' | 'adyen', nullable, required — The payment provider that attempted to collect the payment. - `payment_provider_id` string, nullable, required — The ID of the payment attempt in the payment provider. - `amount` string, required — The amount of the payment attempt. - `succeeded` boolean, required — Whether the payment attempt succeeded. - `created_at` string, date-time, required — The time at which the payment attempt was created. - `receipt_pdf` string, nullable, required — URL to the downloadable PDF version of the receipt. This field will be `null` for payment attempts that did not succeed. - `discount` unknown, required - `discounts` InvoiceLevelDiscount[], required - union - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `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` - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - `lower_bound` number, required — Exclusive lower bound of cumulative spend for this tier. - `upper_bound` number, nullable — Inclusive upper bound of cumulative spend for this tier; null for the final open-ended tier. - `percentage` number, required — The percentage (between 0 and 1) discounted from spend that falls within this tier. - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `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 - `line_items` InvoiceLineItem[], required — The breakdown of prices in this invoice. - `amount` string, required — The final amount for a line item after all adjustments and pre paid credits have been applied. - `end_date` string, date-time, required — The end date of the range of time applied for this line item's price. - `grouping` string, nullable, required — [DEPRECATED] For configured prices that are split by a grouping key, this will be populated with the key and a value. The `amount` and `subtotal` will be the values for this particular grouping. - `adjustments` MonetaryAdjustment[], required — All adjustments applied to the line item in the order they were applied based on invoice calculations (ie. usage discounts -> amount discounts -> percentage discounts -> minimums -> maximums). - union - MonetaryUsageDiscountAdjustment - `id` string, required - `is_invoice_level` boolean, required — True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price. - `filters` PriceFilter[], required — The filters that determine which prices to apply this adjustment to. - … - `applies_to_price_ids` string[], required — The price IDs that this adjustment applies to. - `reason` string, nullable, required — The reason for the adjustment. - `replaces_adjustment_id` string, nullable, required — The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations. - `adjustment_type` 'usage_discount', required - `usage_discount` number, required — The number of usage units by which to discount the price this adjustment applies to in a given billing period. - `amount` string, required — The value applied by an adjustment. - MonetaryAmountDiscountAdjustment - `id` string, required - `is_invoice_level` boolean, required — True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price. - `filters` PriceFilter[], required — The filters that determine which prices to apply this adjustment to. - … - `applies_to_price_ids` string[], required — The price IDs that this adjustment applies to. - `reason` string, nullable, required — The reason for the adjustment. - `replaces_adjustment_id` string, nullable, required — The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations. - `adjustment_type` 'amount_discount', required - `amount_discount` string, required — The amount by which to discount the prices this adjustment applies to in a given billing period. - `amount` string, required — The value applied by an adjustment. - MonetaryPercentageDiscountAdjustment - `id` string, required - `is_invoice_level` boolean, required — True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price. - `filters` PriceFilter[], required — The filters that determine which prices to apply this adjustment to. - … - `applies_to_price_ids` string[], required — The price IDs that this adjustment applies to. - `reason` string, nullable, required — The reason for the adjustment. - `replaces_adjustment_id` string, nullable, required — The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations. - `adjustment_type` 'percentage_discount', required - `percentage_discount` number, required — The percentage (as a value between 0 and 1) by which to discount the price intervals this adjustment applies to in a given billing period. - `amount` string, required — The value applied by an adjustment. - MonetaryTieredPercentageDiscountAdjustment - `id` string, required - `is_invoice_level` boolean, required — True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price. - `filters` PriceFilter[], required — The filters that determine which prices to apply this adjustment to. - … - `applies_to_price_ids` string[], required — The price IDs that this adjustment applies to. - `reason` string, nullable, required — The reason for the adjustment. - `replaces_adjustment_id` string, nullable, required — The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations. - `adjustment_type` 'tiered_percentage_discount', required - `tiers` PercentageTier[], required — The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier), applied to the prices this adjustment covers in a given billing period. - … - `amount` string, required — The value applied by an adjustment. - MonetaryMinimumAdjustment - `id` string, required - `is_invoice_level` boolean, required — True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price. - `filters` PriceFilter[], required — The filters that determine which prices to apply this adjustment to. - … - `applies_to_price_ids` string[], required — The price IDs that this adjustment applies to. - `reason` string, nullable, required — The reason for the adjustment. - `replaces_adjustment_id` string, nullable, required — The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations. - `adjustment_type` 'minimum', required - `minimum_amount` string, required — The minimum amount to charge in a given billing period for the prices this adjustment applies to. - `item_id` string, required — The item ID that revenue from this minimum will be attributed to. - `amount` string, required — The value applied by an adjustment. - MonetaryMaximumAdjustment - `id` string, required - `is_invoice_level` boolean, required — True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price. - `filters` PriceFilter[], required — The filters that determine which prices to apply this adjustment to. - … - `applies_to_price_ids` string[], required — The price IDs that this adjustment applies to. - `reason` string, nullable, required — The reason for the adjustment. - `replaces_adjustment_id` string, nullable, required — The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations. - `adjustment_type` 'maximum', required - `maximum_amount` string, required — The maximum amount to charge in a given billing period for the prices this adjustment applies to. - `amount` string, required — The value applied by an adjustment. - `name` string, required — The name of the price associated with this line item. - `quantity` number, required — Either the fixed fee quantity or the usage during the service period. - `start_date` string, date-time, required — The start date of the range of time applied for this line item's price. - `subtotal` string, required — The line amount before any adjustments. - `adjusted_subtotal` string, required — The line amount after any adjustments and before overage conversion, credits and partial invoicing. - `credits_applied` string, required — The number of prepaid credits applied. - `partially_invoiced_amount` string, required — Any amount applied from a partial invoice - `sub_line_items` InvoiceSubLineItem[], required — For complex pricing structures, the line item can be broken down further in `sub_line_items`. - union - MatrixSubLineItem - `amount` string, required — The total amount for this sub line item. - `name` string, required - `quantity` number, required - `grouping` SubLineItemGrouping, required - … - `type` 'matrix', required - `scaled_quantity` number, nullable — The scaled quantity for this line item for specific pricing structures - `matrix_config` SubLineItemMatrixConfig, required - … - TierSubLineItem - `amount` string, required — The total amount for this sub line item. - `name` string, required - `quantity` number, required - `grouping` SubLineItemGrouping, required - … - `type` 'tier', required - `tier_config` TierSubLineItemTierConfig, required - … - OtherSubLineItem - `amount` string, required — The total amount for this sub line item. - `name` string, required - `quantity` number, required - `grouping` SubLineItemGrouping, required - … - `type` ''null'', required - `tax_amounts` TaxAmount[], required — An array of tax rates and their incurred tax amounts. Empty if no tax integration is configured. - `tax_rate_description` string, required — The human-readable description of the applied tax rate. - `tax_rate_percentage` string, nullable, required — The tax rate percentage, out of 100. - `amount` string, required — The amount of additional tax incurred by this tax rate. - `id` string, required — A unique ID for this line item. - `price` union, 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. For more on the types of prices, see [the core concepts documentation](/core-concepts#plan-and-price) - UnitPrice - `model_type` 'unit', required — The pricing model type - `unit_config` UnitConfig, required — Configuration for unit pricing - `unit_amount` string, required — Rate per unit of usage - `prorated` boolean — If true, subtotals from this price are prorated based on the service period - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - TieredPrice - `model_type` 'tiered', required — The pricing model type - `tiered_config` TieredConfig, required — Configuration for tiered pricing - `tiers` Tier[], required — Tiers for rating based on total usage quantities into the specified tier - … - `prorated` boolean — If true, subtotals from this price are prorated based on the service period - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - BulkPrice - `model_type` 'bulk', required — The pricing model type - `bulk_config` BulkConfig, required — Configuration for bulk pricing - `tiers` BulkTier[], required — Bulk tiers for rating based on total usage volume - … - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - BulkWithFiltersPrice - `model_type` 'bulk_with_filters', required — The pricing model type - `bulk_with_filters_config` BulkWithFiltersConfig, required — Bulk pricing with event filtering applies bulk pricing tiers based on total usage volume, but only charges for events that match specified property filters. How it works: 1. **Tier Selection**: Uses the customer's total usage quantity to determine which bulk pricing tier applies 2. **Event Filtering**: Only counts events where the specified property filters match (supports single or multiple filters) 3. **Billing**: Charges the filtered quantity at the rate determined by the total usage tier Example: - Total usage: 150 events - Bulk tiers: 0-99 = $1.00, 100+ = $0.80 - Filters: region="us-east-1" AND environment="production" - Filtered events: 75 events matching both filters - Result: 75 events × $0.80 = $60.00 (rate determined by 150 total, but only 75 charged) This allows customers to get bulk discounts based on their total volume while only paying for usage in specific regions, environments, or other filtered categories. - `tiers` BulkWithFiltersTier[], required — Bulk tiers for rating based on total usage volume - … - `filters` FilterRule[], required — Property filters to apply (all must match) - … - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - PackagePrice - `model_type` 'package', required — The pricing model type - `package_config` PackageConfig, required — Configuration for package pricing - `package_amount` string, required — A currency amount to rate usage by - `package_size` integer, required — An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - MatrixPrice - `model_type` 'matrix', required — The pricing model type - `matrix_config` MatrixConfig, required — Configuration for matrix pricing - `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` MatrixValue[], required — Matrix values configuration - … - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - ThresholdTotalAmountPrice - `model_type` 'threshold_total_amount', required — The pricing model type - `threshold_total_amount_config` ThresholdTotalAmountConfig, required — Configuration for tiered total pricing - `consumption_table` TieredTotalThreshold[], required — When the quantity consumed passes a provided threshold, the configured total will be charged - … - `prorate` boolean, nullable — If true, the unit price will be prorated to the billing period - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - TieredPackagePrice - `model_type` 'tiered_package', required — The pricing model type - `tiered_package_config` TieredPackagePricingConfig, required — Configuration for tiered package pricing - `tiers` TieredPackageTierItem[], required — Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds. The tier bounds are defined based on the total quantity rather than the number of packages, so they must be multiples of the package size. - … - `package_size` string, required - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - TieredWithMinimumPrice - `model_type` 'tiered_with_minimum', required — The pricing model type - `tiered_with_minimum_config` TieredPricingWithMinimumConfig, required — Configuration for tiered pricing with minimum - `tiers` TieredPricingWithMinimumTierItem[], required — Tiered pricing with a minimum amount dependent on the volume tier. Tiers are defined using exclusive lower bounds. - … - `hide_zero_amount_tiers` boolean — If true, tiers with an accrued amount of 0 will not be included in the rating. - `prorate` boolean — If true, the unit price will be prorated to the billing period - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - GroupedTieredPrice - `model_type` 'grouped_tiered', required — The pricing model type - `grouped_tiered_config` GroupedTieredConfig, required — Configuration for grouped tiered pricing - `tiers` GroupedTieredTier[], required — Apply tiered pricing to each segment generated after grouping with the provided key - … - `grouping_key` string, required — The billable metric property used to group before tiering - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - TieredPackageWithMinimumPrice - `model_type` 'tiered_package_with_minimum', required — The pricing model type - `tiered_package_with_minimum_config` TieredPackagePricingWithMinimumConfig, required — Configuration for tiered package pricing with minimum - `tiers` TieredPackageWithMinimumTierItem[], required — Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds. - … - `package_size` number, required - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - PackageWithAllocationPrice - `model_type` 'package_with_allocation', required — The pricing model type - `package_with_allocation_config` PackageWithAllocationConfig, required — Configuration for package pricing with usage allocation - `package_amount` string, required - `package_size` string, required - `allocation` string, required - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - UnitWithPercentPrice - `model_type` 'unit_with_percent', required — The pricing model type - `unit_with_percent_config` UnitWithPercentConfig, required — Configuration for unit pricing with percentage - `unit_amount` string, required — Rate per unit of usage - `percent` string, required — What percent, out of 100, of the calculated total to charge - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - MatrixWithAllocationPrice - `model_type` 'matrix_with_allocation', required — The pricing model type - `matrix_with_allocation_config` MatrixWithAllocationConfig, required — Configuration for matrix pricing with usage allocation - `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 - `allocation` string, required — Usage allocation - `matrix_values` MatrixWithAllocationValueItem[], required — Matrix values configuration - … - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - MatrixWithThresholdDiscountsPrice - `model_type` 'matrix_with_threshold_discounts', required — The pricing model type - `matrix_with_threshold_discounts_config` MatrixWithThresholdDiscountsConfig, required — Matrix pricing with per-dimension-subset threshold discounts. Each threshold-discount group targets a subset of matrix cells and applies a two-rate discount: a baseline % on spend at or below a threshold, and a steeper % on spend above. - `first_dimension` string, required — First matrix dimension key. - `second_dimension` string, nullable — Optional second matrix dimension key. - `default_unit_amount` string, required — Unit price used for usage that does not match any defined matrix cell. - `matrix_values` MatrixCell[], required — Per-cell unit prices. - … - `threshold_discount_groups` ThresholdDiscountGroup[] - … - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - TieredWithProrationPrice - `model_type` 'tiered_with_proration', required — The pricing model type - `tiered_with_proration_config` TieredWithProrationConfig, required — Configuration for tiered pricing with proration - `tiers` TieredWithProrationTier[], required — Tiers for rating based on total usage quantities into the specified tier with proration - … - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - UnitWithProrationPrice - `model_type` 'unit_with_proration', required — The pricing model type - `unit_with_proration_config` UnitWithProrationConfig, required — Configuration for unit pricing with proration - `unit_amount` string, required — Rate per unit of usage - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - GroupedAllocationPrice - `model_type` 'grouped_allocation', required — The pricing model type - `grouped_allocation_config` GroupedAllocationConfig, required — Configuration for grouped allocation pricing - `grouping_key` string, required — How to determine the groups that should each be allocated some quantity - `overage_unit_rate` string, required — Unit rate for post-allocation - `allocation` string, required — Usage allocation per group - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - BulkWithProrationPrice - `model_type` 'bulk_with_proration', required — The pricing model type - `bulk_with_proration_config` BulkWithProrationConfig, required — Configuration for bulk pricing with proration - `tiers` BulkTierWithProration[], required — Bulk tiers for rating based on total usage volume - … - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `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 - GroupedWithProratedMinimumPrice - `model_type` 'grouped_with_prorated_minimum', required — The pricing model type - `grouped_with_prorated_minimum_config` GroupedWithProratedMinimumConfig, required — Configuration for grouped with prorated minimum pricing - `grouping_key` string, required — How to determine the groups that should each have a minimum - `unit_rate` string, required — The amount to charge per unit - `minimum` string, required — The minimum amount to charge per group - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - … - TieredConversionRateConfig - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - … - `filters` PriceFilter[] - … - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - … truncated; see the full OpenAPI document linked below ## Other responses - `400` — Bad Request - `401` — Unauthorized - `404` — Not Found - `409` — Conflict - `413` — Content Too Large - `429` — Too Many Requests - `500` — Internal Server Error --- [API](https://skmtc.dev/withorb/apis/api-reference.md) · [All operations](https://skmtc.dev/withorb/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/withorb/api-reference/revisions/816dfe734e2e/schema)