--- title: "List subscriptions" method: GET path: "/subscriptions" tags: ["Subscription"] --- # List subscriptions `GET /subscriptions` This endpoint returns a list of all subscriptions for an account as a [paginated](/api-reference/pagination) list, ordered starting from the most recently created subscription. For a full discussion of the subscription resource, see [Subscription](/core-concepts##subscription). Subscriptions can be filtered for a specific customer by using either the customer_id or external_customer_id query parameters. To filter subscriptions for multiple customers, use the customer_id[] or external_customer_id[] query parameters. Subscriptions can be filtered by status using the status query parameter (one of `active`, `ended`, or `upcoming`). To filter for multiple statuses in a single request, use the status[] query parameter, e.g. `status[]=active&status[]=ended`. ## Query parameters - `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. - `customer_id` string, nullable - `customer_id[]` string[], nullable - `external_customer_id` string, nullable - `external_customer_id[]` string[], nullable - `plan_id` string, nullable - `external_plan_id` string, nullable - `status` 'active' | 'ended' | 'upcoming', nullable - `status[]` string[], nullable - `created_at[gte]` string, date-time, nullable - `created_at[gt]` string, date-time, nullable - `created_at[lt]` string, date-time, nullable - `created_at[lte]` string, date-time, nullable ## Response `200` OK - Subscriptions - `data` Subscription[], 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 - `customer` Customer, required — A customer is a buyer of your products, and the other party to the billing relationship. In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an `external_customer_id` with your own identifier. See [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these aliases work in Orb. In addition to having an identifier in your system, a customer may exist in a payment provider solution like Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping. A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which defaults to your account's timezone. See [Timezone localization](/essentials/timezones) for information on what this timezone parameter influences within Orb. - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `external_customer_id` string, nullable, required — An optional user-defined ID for this customer resource, used throughout the system as an alias for this Customer. Use this field to identify a customer by an existing identifier in your system. - `name` string, required — The full name of the customer - `email` string, required — A valid customer email, to be used for notifications. When Orb triggers payment through a payment gateway, this email will be used for any automatically issued receipts. - `timezone` string, required — A timezone identifier from the IANA timezone database, such as "America/Los_Angeles". This "defaults to your account's timezone if not set. This cannot be changed after customer creation. - `payment_provider_id` string, nullable, required — The ID of this customer in an external payments solution, such as Stripe. This is used for creating charges or invoices in the external system via Orb. - `payment_provider` 'quickbooks' | 'bill.com' | 'stripe_charge' | 'stripe_invoice' | 'netsuite' | 'adyen', nullable, required — This is used for creating charges or invoices in an external system via Orb. When not in test mode, the connection must first be configured in the Orb webapp. - `created_at` string, date-time, 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 - `balance` string, required — The customer's current balance in their currency. - `currency` string, nullable, required - `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 - `auto_collection` boolean, required - `exempt_from_automated_tax` boolean, nullable, required - `email_delivery` boolean, required - `auto_issuance` boolean, nullable, required — Whether invoices for this customer should be automatically issued. If true, invoices will be automatically issued. If false, invoices will require manual approval. If null, inherits the account-level setting. - `additional_emails` string[], required - `portal_url` string, nullable, required — Deprecated. Returns the URL of the most recent non-expired portal link, or null. When the account has opted into customer portal sessions, this field always returns null. Use POST /v1/customers/{id}/portal_sessions to mint short-lived portal session URLs. - `accounting_sync_configuration` AccountingSyncConfiguration - `excluded` boolean, required - `accounting_providers` AccountingProvider[], required - `provider_type` 'quickbooks' | 'netsuite', required - `external_provider_id` string, nullable, required - `reporting_configuration` ReportingConfiguration - `exempt` boolean, required - `payment_configuration` PaymentConfiguration - `payment_providers` PaymentConfigurationItem[] — Provider-specific payment configuration. - `provider_type` 'stripe', required — The payment provider to configure. - `excluded_payment_method_types` string[] — List of Stripe payment method types to exclude for this customer. Excluded payment methods will not be available for the customer to select during payment, and will not be used for auto-collection. If a customer's default payment method becomes excluded, Orb will attempt to use the next available compatible payment method for auto-collection. - `default_shared_payment_token` string, nullable — The ID of a shared payment token granted by an agent to use as the default payment instrument for this customer. When set, auto-collection will use this token instead of the customer's default payment method. - `default_payment_method` PaymentMethod — A payment method represents a customer's stored payment instrument held with an external payment provider (such as Adyen or Stripe). The serialization is intentionally minimal for now; provider-pulled details (e.g. card display metadata) will be added over time. - `id` string, required — The Orb-assigned unique identifier for the payment method. - `payment_method_type` 'card' | 'us_bank_account' | 'link' | 'amazon_pay' | 'crypto', required — The type of the underlying payment instrument, e.g. `card` or `us_bank_account`. - `provider_type` string, nullable, required — The external payment provider this method belongs to, derived from the linked payment gateway connection (e.g. `adyen` or `stripe`). Null if the connection has been removed. - `external_payment_method_id` string, required — The identifier of this payment method in the external payment provider. - `customer_id` string, required — The ID of the Orb customer this payment method is attached to. - `default` boolean, required — Whether this is the customer's default payment method. - `created_at` string, date-time, required — The time at which the payment method was created. - `hierarchy` CustomerHierarchy, required - `parent` CustomerMinified, required - `id` string, required - `external_customer_id` string, nullable, required - `children` CustomerMinified[], required - `id` string, required - `external_customer_id` string, nullable, required - `automatic_tax_enabled` boolean, nullable — Whether automatic tax calculation is enabled for this customer. This field is nullable for backwards compatibility but will always return a boolean value. - `plan` Plan, required — The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be subscribed to by a customer. Plans define the billing behavior of the subscription. You can see more about how to configure prices in the [Price resource](/reference/price). - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `name` string, required - `description` string, required - `maximum_amount` string, nullable, required - `minimum_amount` string, nullable, required - `created_at` string, date-time, required - `status` 'active' | 'archived' | 'draft', 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. - `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. - `discount` union, required - 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. - 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` - UsageDiscount - `discount_type` 'usage', 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 - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - 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`. - 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. - `product` Product, required - `created_at` string, date-time, required - `id` string, required - `name` string, required - `version` integer, required - `trial_config` TrialConfig, required - `trial_period` integer, nullable, required - `trial_period_unit` 'days', required - `plan_phases` PlanPhase[], nullable, required - `id` string, required - `description` string, nullable, required - `duration` integer, nullable, required — How many terms of length `duration_unit` this phase is active for. If null, this phase is evergreen and active indefinitely - `duration_unit` 'daily' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual', nullable, required - `name` string, required - `order` integer, required — Determines the ordering of the phase in a plan's lifecycle. 1 = first phase. - `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. - `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 - `minimum_amount` string, nullable, required - `discount` union, required - 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. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - 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. - … - `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` - UsageDiscount - `discount_type` 'usage', 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. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - 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. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - 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. - … - `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). - … - `base_plan` PlanMinified, required - `id` string, nullable, required - `external_plan_id` string, nullable, required — An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system. - `name` string, nullable, required - `base_plan_id` string, nullable, required — Legacy field representing the parent plan ID if the current plan is a 'child plan', overriding prices from the parent. - `external_plan_id` string, nullable, required — An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system. - `currency` string, required — An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's prices. - `invoicing_currency` string, required — An ISO 4217 currency string for which this plan is billed in. Matches `currency` unless `currency` is a custom pricing unit. - `net_terms` integer, nullable, required — Determines the difference between the invoice issue date and the due date. A value of "0" here signifies that invoices are due on issue, whereas a value of "30" means that the customer has a month to pay the invoice before its overdue. Note that individual subscriptions or invoices may set a different net terms configuration. - `default_invoice_memo` string, nullable, required — The default memo text on the invoices corresponding to subscriptions on this plan. Note that each subscription may configure its own memo. - `prices` Price[], required — Prices for this plan. If the plan has phases, this includes prices across all phases of the plan. - union — 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 - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - TieredPrice - `model_type` 'tiered', required — The pricing model type - `tiered_config` TieredConfig, required — Configuration for tiered pricing - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - BulkPrice - `model_type` 'bulk', required — The pricing model type - `bulk_config` BulkConfig, required — Configuration for bulk pricing - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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. - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - PackagePrice - `model_type` 'package', required — The pricing model type - `package_config` PackageConfig, required — Configuration for package pricing - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - MatrixPrice - `model_type` 'matrix', required — The pricing model type - `matrix_config` MatrixConfig, required — Configuration for matrix pricing - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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 - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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 - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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 - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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 - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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 - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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 - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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 - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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 - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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. - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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 - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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 - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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 - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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 - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `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 - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - GroupedWithMeteredMinimumPrice - `model_type` 'grouped_with_metered_minimum', required — The pricing model type - `grouped_with_metered_minimum_config` GroupedWithMeteredMinimumConfig, required — Configuration for grouped with metered minimum pricing - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - GroupedWithMinMaxThresholdsPrice - `model_type` 'grouped_with_min_max_thresholds', required — The pricing model type - `grouped_with_min_max_thresholds_config` GroupedWithMinMaxThresholdsConfig, required — Configuration for grouped with minimum and maximum thresholds pricing - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - MatrixWithDisplayNamePrice - `model_type` 'matrix_with_display_name', required — The pricing model type - `matrix_with_display_name_config` MatrixWithDisplayNameConfig, required — Configuration for matrix with display name pricing - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - GroupedTieredPackagePrice - `model_type` 'grouped_tiered_package', required — The pricing model type - `grouped_tiered_package_config` GroupedTieredPackagePricingConfig, required — Configuration for grouped tiered package pricing - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - MaxGroupTieredPackagePrice - `model_type` 'max_group_tiered_package', required — The pricing model type - `max_group_tiered_package_config` MaxGroupTieredPackageConfig, required — Configuration for max group tiered package pricing - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - ScalableMatrixWithUnitPricingPrice - `model_type` 'scalable_matrix_with_unit_pricing', required — The pricing model type - `scalable_matrix_with_unit_pricing_config` ScalableMatrixWithUnitPricingConfig, required — Configuration for scalable matrix with unit pricing - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - ScalableMatrixWithTieredPricingPrice - `model_type` 'scalable_matrix_with_tiered_pricing', required — The pricing model type - `scalable_matrix_with_tiered_pricing_config` ScalableMatrixWithTieredPricingConfig, required — Configuration for scalable matrix with tiered pricing - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - CumulativeGroupedBulkPrice - `model_type` 'cumulative_grouped_bulk', required — The pricing model type - `cumulative_grouped_bulk_config` CumulativeGroupedBulkConfig, required — Configuration for cumulative grouped bulk pricing - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - CumulativeGroupedAllocationPrice - `model_type` 'cumulative_grouped_allocation', required — The pricing model type - `cumulative_grouped_allocation_config` CumulativeGroupedAllocationConfig, required — Configuration for cumulative grouped allocation pricing. This rating function groups usage by a grouping key and applies both per-group and cumulative allocations. For each group (ordered by group value), it calculates the larger of the group overage and the incremental cumulative overage. - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - DailyCreditAllowancePrice - `model_type` 'daily_credit_allowance', required — The pricing model type - `daily_credit_allowance_config` DailyCreditAllowanceConfig, required — Pricing model that gives a daily credit budget across one or more dimensional rates. Each event is rated in credits at a per-dimension `unit_amount`. Events are bucketed into days via an `event_day_property` set on the event (e.g. an ISO date string in the customer's timezone, supplied at ingest by the customer). Within each day the first `daily_allowance` credits are free; usage beyond that is charged in full. The allowance does not roll over. Use cases: shared daily AI-token budgets where different models have different credit costs. - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - MeteredAllowancePrice - `model_type` 'metered_allowance', required — The pricing model type - `metered_allowance_config` MeteredAllowanceConfig, required — Charges a per-unit rate on consumption above an allowance whose size is itself metered from usage in the same period. Both quantities come from a single billable metric, partitioned by `grouping_key`. The line item shows two sub-lines under one parent: the gross consumption row and a (negative) allowance credit row. The parent line equals the net charge, never negative — so adjustments, tax, prepaid credits, and rev rec all behave like any other usage line. Use cases: free egress proportional to bytes stored; free outbound bandwidth proportional to compute hours; free messages proportional to seat count; free output tokens proportional to input tokens. - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - MinimumCompositePrice - `model_type` 'minimum_composite', required — The pricing model type - `minimum_composite_config` MinimumCompositeConfig, required — Configuration for minimum composite price - … - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - PercentCompositePrice - `model_type` 'percent', required — The pricing model type - `percent_config` PercentCompositeConfig, required — Configuration for a percent composite price. Charges ``percent`` of the sum of upstream subtotals matched by this price's composite filters. Optional ``minimum_amount`` and ``maximum_amount`` clamp the computed amount — leave both null for a pure pass-through percentage. Canonical bounded use case — service charge of the form "monthly fee = greater of X% of usage and $A, capped at $B": PercentCompositeConfig( percent=Decimal("0.08"), minimum_amount=MonetaryAmount(Decimal("5000")), maximum_amount=MonetaryAmount(Decimal("50000")), ) upstream sum $0 → fee $5,000 (minimum_amount) upstream sum $50,000 → fee $5,000 (minimum_amount; 8% = $4K < minimum_amount) upstream sum $100,000 → fee $8,000 (within bounds) upstream sum $1,000,000 → fee $50,000 (maximum_amount) - … - `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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - EventOutputPrice - `model_type` 'event_output', required — The pricing model type - `event_output_config` EventOutputConfig, 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 - … - `invoicing_cycle_configuration` BillingCycleConfiguration, required - … - `billable_metric` BillableMetricTiny, required - … - `dimensional_price_configuration` DimensionalPriceConfiguration - … - `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 - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - … - `credit_allocation` Allocation, required - … - `composite_price_filters` PriceFilter[], nullable, required - … - `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. - … - `discount` union, required - … - `minimum` Minimum, required - … - `minimum_amount` string, nullable, required - `maximum` Maximum, required - … - `maximum_amount` string, nullable, required - `adjustments` Adjustment[], required — Adjustments for this plan. If the plan has phases, this includes adjustments across all phases of the plan. - union - PlanPhaseUsageDiscountAdjustment - `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. - `plan_phase_order` integer, nullable, required — The plan phase in which this adjustment is active. - PlanPhaseAmountDiscountAdjustment - `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. - `plan_phase_order` integer, nullable, required — The plan phase in which this adjustment is active. - PlanPhasePercentageDiscountAdjustment - `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. - `plan_phase_order` integer, nullable, required — The plan phase in which this adjustment is active. - PlanPhaseTieredPercentageDiscountAdjustment - `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. - … - `plan_phase_order` integer, nullable, required — The plan phase in which this adjustment is active. - PlanPhaseMinimumAdjustment - `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. - `plan_phase_order` integer, nullable, required — The plan phase in which this adjustment is active. - PlanPhaseMaximumAdjustment - `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. - `plan_phase_order` integer, nullable, required — The plan phase in which this adjustment is active. - `name` string, required — The name of the subscription. - `start_date` string, date-time, required — The date Orb starts billing for this subscription. - `end_date` string, date-time, nullable, required — The date Orb stops billing for this subscription. - `created_at` string, date-time, required - `current_billing_period_start_date` string, date-time, nullable, required — The start date of the current billing period. This is an inclusive timestamp; the instant returned is exactly the beginning of the billing period. Set to null if the subscription is not currently active. - `current_billing_period_end_date` string, date-time, nullable, required — The end of the current billing period. This is an exclusive timestamp, such that the instant returned is not part of the billing period. Set to null for subscriptions that are not currently active. - `status` 'active' | 'ended' | 'upcoming', required - `trial_info` SubscriptionTrialInfo, required - `end_date` string, date-time, nullable, required - `active_plan_phase_order` integer, nullable, required — The current plan phase that is active, only if the subscription's plan has phases. - `fixed_fee_quantity_schedule` FixedFeeQuantityScheduleEntry[], required - `price_id` string, required - `start_date` string, date-time, required - `end_date` string, date-time, nullable, required - `quantity` number, required - `default_invoice_memo` string, nullable, required — Determines the default memo on this subscriptions' invoices. Note that if this is not provided, it is determined by the plan configuration. - `auto_collection` boolean, nullable, required — Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date. This property defaults to the plan's behavior. If null, defaults to the customer's setting. - `auto_issuance` boolean, nullable, required — Determines whether invoices for this subscription will be automatically issued. This resolves the effective setting for the subscription: a subscription-level override if set, otherwise the customer-level setting, otherwise the account-level default. - `net_terms` integer, required — Determines the difference between the invoice issue date for subscription invoices as the date that they are due. A value of `0` here represents that the invoice is due on issue, whereas a value of `30` represents that the customer has a month to pay the invoice. - `redeemed_coupon` CouponRedemption, required - `coupon_id` string, required - `start_date` string, date-time, required - `end_date` string, date-time, nullable, required - `billing_cycle_day` integer, required — The day of the month on which the billing cycle is anchored. If the maximum number of days in a month is greater than this value, the last day of the month is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing period begins on the 30th. - `billing_cycle_anchor_configuration` BillingCycleAnchorConfiguration, required - `day` integer, required — The day of the month on which the billing cycle is anchored. If the maximum number of days in a month is greater than this value, the last day of the month is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing period begins on the 30th. - `month` integer, nullable — The month on which the billing cycle is anchored (e.g. a quarterly price anchored in February would have cycles starting February, May, August, and November). - `year` integer, nullable — The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). - `invoicing_threshold` string, nullable, required - `price_intervals` PriceInterval[], required — The price intervals for this subscription. - `id` string, required - `start_date` string, date-time, required — The start date of the price interval. This is the date that Orb starts billing for this price. - `end_date` string, date-time, nullable, required — The end date of the price interval. This is the date that Orb stops billing for this price. - `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. - … 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.net/withorb/apis/api-reference.md) · [All operations](https://skmtc.net/withorb/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/withorb/api-reference/versions/816dfe734e2e/schema)