> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withorb.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Schedule plan change
> This endpoint can be used to change an existing subscription's plan. It returns the serialized updated subscription object.
The body parameter `change_option` determines when the plan change occurs. Orb supports three options:
- `end_of_subscription_term`: changes the plan at the end of the existing plan's term.
- Issuing this plan change request for a monthly subscription will keep the existing plan active until the start
of the subsequent month. Issuing this plan change request for a yearly subscription will keep the existing plan active for
the full year. Charges incurred in the remaining period will be invoiced as normal.
- Example: The plan is billed monthly on the 1st of the month, the request is made on January 15th, so the plan will be
changed on February 1st, and invoice will be issued on February 1st for the last month of the original plan.
- `immediate`: changes the plan immediately.
- Subscriptions that have their plan changed with this option will move to the new plan immediately, and be invoiced
immediately.
- This invoice will include any usage fees incurred in the billing period up to the change, along with any prorated
recurring fees for the billing period, if applicable.
- Example: The plan is billed monthly on the 1st of the month, the request is made on January 15th, so the plan will be
changed on January 15th, and an invoice will be issued for the partial month, from January 1 to January 15, on the
original plan.
- `requested_date`: changes the plan on the requested date (`change_date`).
- If no timezone is provided, the customer's timezone is used. The `change_date` body parameter is required if this option
is chosen.
- Example: The plan is billed monthly on the 1st of the month, the request is made on January 15th, with a requested
`change_date` of February 15th, so the plan will be changed on February 15th, and invoices will be issued on February 1st
and February 15th.
Note that one of `plan_id` or `external_plan_id` is required in the request body for this operation.
## Customize your customer's subscriptions
Prices and adjustments in a plan can be added, removed, or replaced on the subscription when you schedule the plan change. This
is useful when a customer has prices that differ from the default prices for a specific plan.
This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your
Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans)
### Adding Prices
To add prices, provide a list of objects with the key `add_prices`. An object in the list must specify an existing add-on price
with a `price_id` or `external_price_id` field, or create a new add-on price by including an object with the key `price`,
identical to what would be used in the request body for the [create price endpoint](/api-reference/price/create-price). See the
[Price resource](/product-catalog/price-configuration) for the specification of different price model configurations possible
in this object.
If the plan has phases, each object in the list must include a number with `plan_phase_order` key to indicate which phase the
price should be added to.
An object in the list can specify an optional `start_date` and optional `end_date`. If `start_date` is unspecified, the start
of the phase / plan change time will be used. If `end_date` is unspecified, it will finish at the end of the phase / have
no end time.
An object in the list can specify an optional `minimum_amount`, `maximum_amount`, or `discounts`. This will create adjustments
which apply only to this price.
Additionally, an object in the list can specify an optional `reference_id`. This ID can be used to reference this price when
[adding an adjustment](#adding-adjustments) in the same API call. However the ID is _transient_ and cannot be used to refer to
the price in future API calls.
### Removing Prices
To remove prices, provide a list of objects with the key `remove_prices`. An object in the list must specify a plan price with
either a `price_id` or `external_price_id` field.
### Replacing Prices
To replace prices, provide a list of objects with the key `replace_prices`. An object in the list must specify a plan price to
replace with the `replaces_price_id` key, and it must specify a price to replace it with by either referencing an existing
add-on price with a `price_id` or `external_price_id` field, or by creating a new add-on price by including an object with the
key `price`, identical to what would be used in the request body for
the [create price endpoint](/api-reference/price/create-price).
See the [Price resource](/product-catalog/price-configuration) for the specification of different price model configurations
possible in this object.
For fixed fees, an object in the list can supply a `fixed_price_quantity` instead of a `price`, `price_id`, or
`external_price_id` field. This will update only the quantity for the price, similar to the
[Update price quantity](/api-reference/subscription/update-price-quantity) endpoint.
The replacement price will have the same phase, if applicable, and the same start and end dates as the price it replaces.
An object in the list can specify an optional `minimum_amount`, `maximum_amount`, or `discounts`. This will create adjustments
which apply only to this price.
Additionally, an object in the list can specify an optional `reference_id`. This ID can be used to reference the replacement
price when [adding an adjustment](#adding-adjustments) in the same API call. However the ID is _transient_ and cannot be used to
refer to the price in future API calls.
### Adding adjustments
To add adjustments, provide a list of objects with the key `add_adjustments`. An object in the list must include an object with
the key `adjustment`, identical to the adjustment object in the
[add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
If the plan has phases, each object in the list must include a number with `plan_phase_order` key to indicate which phase the
adjustment should be added to.
An object in the list can specify an optional `start_date` and optional `end_date`. If `start_date` is unspecified, the start
of the phase / plan change time will be used. If `end_date` is unspecified, it will finish at the end of the phase / have
no end time.
### Removing adjustments
To remove adjustments, provide a list of objects with the key `remove_adjustments`. An object in the list must include a key,
`adjustment_id`, with the ID of the adjustment to be removed.
### Replacing adjustments
To replace adjustments, provide a list of objects with the key `replace_adjustments`. An object in the list must specify a plan
adjustment to replace with the `replaces_adjustment_id` key, and it must specify an adjustment to replace it with by including
an object with the key `adjustment`, identical to the adjustment object in the
[add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
The replacement adjustment will have the same phase, if applicable, and the same start and end dates as the adjustment it
replaces.
## Price overrides (DEPRECATED)
Price overrides are being phased out in favor adding/removing/replacing prices. (See
[Customize your customer's subscriptions](/api-reference/subscription/schedule-plan-change))
Price overrides are used to update some or all prices in a plan for the specific subscription being created. This is
useful when a new customer has negotiated a rate that is unique to the customer.
To override prices, provide a list of objects with the key `price_overrides`. The price object in the list of overrides
is expected to contain the existing price id, the `model_type` and configuration.
(See the [Price resource](/product-catalog/price-configuration)
for the specification of different price model configurations.) The numerical values can be updated, but the billable metric,
cadence, type, and name of a price can not be overridden.
### Maximums, and minimums
Price overrides are used to update some or all prices in the target plan. Minimums and maximums, much like price
overrides, can be useful when a new customer has negotiated a new or different minimum or maximum spend cap than the
default for the plan. The request format for maximums and minimums is the same as those in
[subscription creation](create-subscription).
## Scheduling multiple plan changes
When scheduling multiple plan changes with the same date, the latest plan change on that day takes effect.
## Prorations for in-advance fees
By default, Orb calculates the prorated difference in any fixed fees when making a plan change, adjusting the
customer balance as needed. For details on this behavior, see
[Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees).
## OpenAPI
````yaml /api-reference/orb-openapi.json post /subscriptions/{subscription_id}/schedule_plan_change
openapi: 3.1.0
info:
title: API Reference
description: >-
Orb's API is built with the following principles in mind:
1. **Predictable developer experience**: Where applicable, the Orb API uses
industry-standard patterns such as
cursor-based pagination and standardized error output. To help with
debugging in critical API
actions, the API always strives to provide detailed and actionable error
messages. Aliases
such as external customer IDs aid in fast integration times.
2. **Reliably real time**: Orb's event-based APIs, such as event ingestion
are designed to handle extremely high
throughput and scale with concurrent load. Orb also provides a real-time
event-level credits
ledger and a highly performant webhooks architecture.
3. **Flexibility at the forefront**: Features like timezone localization and
the ability to amend historical usage
show the flexible nature of the platform.
You can download the latest OpenAPI spec
[here](https://api.withorb.com/spec.json) - pass `?version=3.0` for an
OpenAPI 3.0-compatible spec.
contact:
name: Orb, Inc.
url: https://www.withorb.com/
email: team@withorb.com
version: '1.0'
servers:
- url: https://api.withorb.com/v1
description: Production server
security:
- APIKeyAuth: []
tags:
- name: Alert
description: >-
[Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
usage, or credit balance and trigger webhooks when a threshold is
exceeded.
Alerts created through the API can be scoped to either customers or
subscriptions.
- name: Availability
- name: Coupon
description: >-
A coupon represents a reusable discount configuration that can be applied
either as a fixed or percentage amount to an invoice or subscription.
Coupons are activated using a redemption code, which applies the discount
to a subscription or invoice. The duration of a coupon determines how long
it remains available for use by end users.
- name: Credit
description: >-
The [Credit Ledger Entry resource](/product-catalog/prepurchase) models
prepaid credits within Orb.
- name: Credit note
description: >-
The [Credit Note](/invoicing/credit-notes) resource represents a credit
that has been applied to a
particular invoice.
- name: Customer
description: >-
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.
- name: Dimensional Price Group
- name: Event
description: >-
The [Event](/core-concepts#event) resource represents a usage event that
has been created for a
customer. Events are the core of Orb's usage-based billing model, and are
used to calculate the usage charges for
a given billing period.
- name: Invoice
description: >-
An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
representing the request for payment for
a single subscription. This includes a set of line items, which correspond
to prices in the subscription's plan and
can represent fixed recurring fees or usage-based fees. They are generated
at the end of a billing period, or as
the result of an action, such as a cancellation.
- name: Item
description: >-
The Item resource represents a sellable product or good. Items are
associated with all line items, billable metrics,
and prices and are used for defining external sync behavior for invoices
and tax calculation purposes.
- name: License
- name: LicenseType
description: >-
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.
- name: Metric
description: >-
The Metric resource represents a calculation of a quantity based on
events.
Metrics are defined by the query that transforms raw usage events into
meaningful values for your customers.
- name: Plan
description: >-
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).
- name: Price
description: >-
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)
- name: Price interval
description: >-
The Price Interval resource represents a period of time for which a price
will bill on a subscription. A
subscription’s price intervals define its billing behavior.
- name: Subscription
description: >-
A [subscription](/core-concepts#subscription) represents the purchase of a
plan by a customer.
By default, subscriptions begin on the day that they're created and renew
automatically for each billing cycle at
the cadence that's configured in the plan definition.
Subscriptions also default to **beginning of month alignment**, which
means the first invoice issued for the
subscription will have pro-rated charges between the `start_date` and the
first of the following month. Subsequent
billing periods will always start and end on a month boundary (e.g.
subsequent month starts for monthly billing).
Depending on the plan configuration, any _flat_ recurring fees will be
billed either at the beginning (in-advance)
or end (in-arrears) of each billing cycle. Plans default to **in-advance
billing**. Usage-based fees are billed in
arrears as usage is accumulated. In the normal course of events, you can
expect an invoice to contain usage-based
charges for the previous period, and a recurring fee for the following
period.
- name: Subscription Change
paths:
/subscriptions/{subscription_id}/schedule_plan_change:
post:
tags:
- Subscription
summary: Schedule plan change
description: >-
This endpoint can be used to change an existing subscription's plan. It
returns the serialized updated subscription object.
The body parameter `change_option` determines when the plan change
occurs. Orb supports three options:
- `end_of_subscription_term`: changes the plan at the end of the
existing plan's term.
- Issuing this plan change request for a monthly subscription will keep the existing plan active until the start
of the subsequent month. Issuing this plan change request for a yearly subscription will keep the existing plan active for
the full year. Charges incurred in the remaining period will be invoiced as normal.
- Example: The plan is billed monthly on the 1st of the month, the request is made on January 15th, so the plan will be
changed on February 1st, and invoice will be issued on February 1st for the last month of the original plan.
- `immediate`: changes the plan immediately.
- Subscriptions that have their plan changed with this option will move to the new plan immediately, and be invoiced
immediately.
- This invoice will include any usage fees incurred in the billing period up to the change, along with any prorated
recurring fees for the billing period, if applicable.
- Example: The plan is billed monthly on the 1st of the month, the request is made on January 15th, so the plan will be
changed on January 15th, and an invoice will be issued for the partial month, from January 1 to January 15, on the
original plan.
- `requested_date`: changes the plan on the requested date
(`change_date`).
- If no timezone is provided, the customer's timezone is used. The `change_date` body parameter is required if this option
is chosen.
- Example: The plan is billed monthly on the 1st of the month, the request is made on January 15th, with a requested
`change_date` of February 15th, so the plan will be changed on February 15th, and invoices will be issued on February 1st
and February 15th.
Note that one of `plan_id` or `external_plan_id` is required in the
request body for this operation.
## Customize your customer's subscriptions
Prices and adjustments in a plan can be added, removed, or replaced on
the subscription when you schedule the plan change. This
is useful when a customer has prices that differ from the default prices
for a specific plan.
This feature is only available for accounts that have migrated to
Subscription Overrides Version 2. You can find your
Subscription Overrides Version at the bottom of your [Plans
page](https://app.withorb.com/plans)
### Adding Prices
To add prices, provide a list of objects with the key `add_prices`. An
object in the list must specify an existing add-on price
with a `price_id` or `external_price_id` field, or create a new add-on
price by including an object with the key `price`,
identical to what would be used in the request body for the [create
price endpoint](/api-reference/price/create-price). See the
[Price resource](/product-catalog/price-configuration) for the
specification of different price model configurations possible
in this object.
If the plan has phases, each object in the list must include a number
with `plan_phase_order` key to indicate which phase the
price should be added to.
An object in the list can specify an optional `start_date` and optional
`end_date`. If `start_date` is unspecified, the start
of the phase / plan change time will be used. If `end_date` is
unspecified, it will finish at the end of the phase / have
no end time.
An object in the list can specify an optional `minimum_amount`,
`maximum_amount`, or `discounts`. This will create adjustments
which apply only to this price.
Additionally, an object in the list can specify an optional
`reference_id`. This ID can be used to reference this price when
[adding an adjustment](#adding-adjustments) in the same API call.
However the ID is _transient_ and cannot be used to refer to
the price in future API calls.
### Removing Prices
To remove prices, provide a list of objects with the key
`remove_prices`. An object in the list must specify a plan price with
either a `price_id` or `external_price_id` field.
### Replacing Prices
To replace prices, provide a list of objects with the key
`replace_prices`. An object in the list must specify a plan price to
replace with the `replaces_price_id` key, and it must specify a price to
replace it with by either referencing an existing
add-on price with a `price_id` or `external_price_id` field, or by
creating a new add-on price by including an object with the
key `price`, identical to what would be used in the request body for
the [create price endpoint](/api-reference/price/create-price).
See the [Price resource](/product-catalog/price-configuration) for the
specification of different price model configurations
possible in this object.
For fixed fees, an object in the list can supply a
`fixed_price_quantity` instead of a `price`, `price_id`, or
`external_price_id` field. This will update only the quantity for the
price, similar to the
[Update price
quantity](/api-reference/subscription/update-price-quantity) endpoint.
The replacement price will have the same phase, if applicable, and the
same start and end dates as the price it replaces.
An object in the list can specify an optional `minimum_amount`,
`maximum_amount`, or `discounts`. This will create adjustments
which apply only to this price.
Additionally, an object in the list can specify an optional
`reference_id`. This ID can be used to reference the replacement
price when [adding an adjustment](#adding-adjustments) in the same API
call. However the ID is _transient_ and cannot be used to
refer to the price in future API calls.
### Adding adjustments
To add adjustments, provide a list of objects with the key
`add_adjustments`. An object in the list must include an object with
the key `adjustment`, identical to the adjustment object in the
[add/edit price intervals
endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
If the plan has phases, each object in the list must include a number
with `plan_phase_order` key to indicate which phase the
adjustment should be added to.
An object in the list can specify an optional `start_date` and optional
`end_date`. If `start_date` is unspecified, the start
of the phase / plan change time will be used. If `end_date` is
unspecified, it will finish at the end of the phase / have
no end time.
### Removing adjustments
To remove adjustments, provide a list of objects with the key
`remove_adjustments`. An object in the list must include a key,
`adjustment_id`, with the ID of the adjustment to be removed.
### Replacing adjustments
To replace adjustments, provide a list of objects with the key
`replace_adjustments`. An object in the list must specify a plan
adjustment to replace with the `replaces_adjustment_id` key, and it must
specify an adjustment to replace it with by including
an object with the key `adjustment`, identical to the adjustment object
in the
[add/edit price intervals
endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
The replacement adjustment will have the same phase, if applicable, and
the same start and end dates as the adjustment it
replaces.
## Price overrides (DEPRECATED)
Price overrides are being phased out in favor adding/removing/replacing
prices. (See
[Customize your customer's
subscriptions](/api-reference/subscription/schedule-plan-change))
Price overrides are used to update some or all prices in a plan for the
specific subscription being created. This is
useful when a new customer has negotiated a rate that is unique to the
customer.
To override prices, provide a list of objects with the key
`price_overrides`. The price object in the list of overrides
is expected to contain the existing price id, the `model_type` and
configuration.
(See the [Price resource](/product-catalog/price-configuration)
for the specification of different price model configurations.) The
numerical values can be updated, but the billable metric,
cadence, type, and name of a price can not be overridden.
### Maximums, and minimums
Price overrides are used to update some or all prices in the target
plan. Minimums and maximums, much like price
overrides, can be useful when a new customer has negotiated a new or
different minimum or maximum spend cap than the
default for the plan. The request format for maximums and minimums is
the same as those in
[subscription creation](create-subscription).
## Scheduling multiple plan changes
When scheduling multiple plan changes with the same date, the latest
plan change on that day takes effect.
## Prorations for in-advance fees
By default, Orb calculates the prorated difference in any fixed fees
when making a plan change, adjusting the
customer balance as needed. For details on this behavior, see
[Modifying
subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees).
operationId: schedule-plan-change
parameters:
- required: true
style: simple
schema:
type: string
name: subscription_id
in: path
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionPlanChange'
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/MutatedSubscription'
'400':
description: Bad Request
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/400Error'
'401':
description: Unauthorized
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/401Error'
'404':
description: Not Found
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/404Error'
'409':
description: Conflict
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/409Error'
'413':
description: Content Too Large
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/413Error'
'429':
description: Too Many Requests
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/429Error'
'500':
description: Internal Server Error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/500Error'
components:
schemas:
SubscriptionPlanChange:
properties:
usage_customer_ids:
oneOf:
- items:
type: string
type: array
- type: 'null'
title: Usage Customer Ids
description: >-
A list of customer IDs whose usage events will be aggregated and
billed under this subscription. By default, a subscription only
considers usage events associated with its attached customer's
customer_id. When usage_customer_ids is provided, the subscription
includes usage events from the specified customers only. Provided
usage_customer_ids must be either the customer for this subscription
itself, or any of that customer's children.
filter:
oneOf:
- type: string
- type: 'null'
title: Filter
description: >-
An additional filter to apply to usage queries. This filter must be
expressed as a boolean [computed
property](/extensibility/advanced-metrics#computed-properties). If
null, usage queries will not include any additional filter.
examples:
- my_property > 100 AND my_other_property = 'bar'
- my_property = 'foo'
plan_id:
oneOf:
- type: string
- type: 'null'
title: Plan Id
description: >-
The plan that the given subscription should be switched to. Note
that either this property or `external_plan_id` must be specified.
examples:
- ZMwNQefe7J3ecf7W
external_plan_id:
oneOf:
- type: string
- type: 'null'
title: External Plan Id
description: >-
The external_plan_id of the plan that the given subscription should
be switched to. Note that either this property or `plan_id` must be
specified.
examples:
- ZMwNQefe7J3ecf7W
price_overrides:
oneOf:
- items:
deprecated: true
type: array
- type: 'null'
title: Price Overrides
description: Optionally provide a list of overrides for prices on the plan
deprecated: true
per_credit_overage_amount:
oneOf:
- type: number
- type: 'null'
title: Per Credit Overage Amount
deprecated: true
credits_overage_rate:
oneOf:
- type: number
- type: 'null'
title: Credits Overage Rate
deprecated: true
trial_duration_days:
oneOf:
- type: integer
exclusiveMaximum: 1000000
minimum: 0
- type: 'null'
title: Trial Duration Days
description: >-
The duration of the trial period in days. If not provided, this
defaults to the value specified in the plan. If `0` is provided, the
trial on the plan will be skipped.
net_terms:
oneOf:
- type: integer
- type: 'null'
title: Net Terms
description: >-
The net terms determines the difference between the invoice date and
the issue date for the invoice. If you intend the invoice to be due
on issue, set this to 0. If not provided, this defaults to the value
specified in the plan.
auto_collection:
oneOf:
- type: boolean
- type: 'null'
title: Auto Collection
description: >-
Determines whether issued invoices for this subscription will
automatically be charged with the saved payment method on the due
date. If not specified, this defaults to the behavior configured for
this customer.
default_invoice_memo:
oneOf:
- type: string
- type: 'null'
title: Default Invoice Memo
description: >-
Determines the default memo on this subscription's invoices. Note
that if this is not provided, it is determined by the plan
configuration.
coupon_redemption_code:
oneOf:
- type: string
- type: 'null'
title: Coupon Redemption Code
description: >-
Redemption code to be used for this subscription. If the coupon
cannot be found by its redemption code, or cannot be redeemed, an
error response will be returned and the subscription creation or
plan change will not be scheduled.
invoicing_threshold:
oneOf:
- type: string
- type: 'null'
title: Invoicing Threshold
description: >-
When this subscription's accrued usage reaches this threshold, an
invoice will be issued for the subscription. If not specified,
invoices will only be issued at the end of the billing period.
examples:
- '10.00'
initial_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Initial Phase Order
description: The phase of the plan to start with
examples:
- 2
add_prices:
oneOf:
- items:
$ref: '#/components/schemas/AddSubscriptionPriceParams'
type: array
- type: 'null'
title: Add Prices
description: >-
Additional prices to be added to the subscription. (Only available
for accounts that have migrated off of legacy subscription
overrides)
remove_prices:
oneOf:
- items:
$ref: '#/components/schemas/RemoveSubscriptionPriceParams'
type: array
- type: 'null'
title: Remove Prices
description: >-
Plan prices to be removed from the subscription. (Only available for
accounts that have migrated off of legacy subscription overrides)
replace_prices:
oneOf:
- items:
$ref: '#/components/schemas/ReplaceSubscriptionPriceParams'
type: array
- type: 'null'
title: Replace Prices
description: >-
Plan prices to be replaced with additional prices on the
subscription. (Only available for accounts that have migrated off of
legacy subscription overrides)
add_adjustments:
oneOf:
- items:
$ref: '#/components/schemas/AddSubscriptionAdjustmentParams'
type: array
- type: 'null'
title: Add Adjustments
description: >-
Additional adjustments to be added to the subscription. (Only
available for accounts that have migrated off of legacy subscription
overrides)
remove_adjustments:
oneOf:
- items:
$ref: '#/components/schemas/RemoveSubscriptionAdjustmentParams'
type: array
- type: 'null'
title: Remove Adjustments
description: >-
Plan adjustments to be removed from the subscription. (Only
available for accounts that have migrated off of legacy subscription
overrides)
replace_adjustments:
oneOf:
- items:
$ref: '#/components/schemas/ReplaceSubscriptionAdjustmentParams'
type: array
- type: 'null'
title: Replace Adjustments
description: >-
Plan adjustments to be replaced with additional adjustments on the
subscription. (Only available for accounts that have migrated off of
legacy subscription overrides)
change_option:
type: string
enum:
- requested_date
- end_of_subscription_term
- immediate
title: Change Option
change_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Change Date
description: >-
The date that the plan change should take effect. This parameter can
only be passed if the `change_option` is `requested_date`. If a date
with no time is passed, the plan change will happen at midnight in
the customer's timezone.
examples:
- '2017-07-21T17:32:28Z'
- '2017-07-21'
align_billing_with_plan_change_date:
oneOf:
- type: boolean
- type: 'null'
title: Align Billing With Plan Change Date
description: >-
[DEPRECATED] Use billing_cycle_alignment instead. Reset billing
periods to be aligned with the plan change's effective date.
billing_cycle_alignment:
oneOf:
- type: string
enum:
- unchanged
- plan_change_date
- start_of_month
- type: 'null'
title: Billing Cycle Alignment
description: >-
Reset billing periods to be aligned with the plan change's effective
date or start of the month. Defaults to `unchanged` which keeps
subscription's existing billing cycle alignment.
default: unchanged
plan_version_number:
oneOf:
- type: integer
- type: 'null'
title: Plan Version Number
description: >-
Specifies which version of the plan to change to. If null, the
default version will be used.
billing_cycle_anchor_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleAnchorConfiguration'
- type: 'null'
additionalProperties: false
type: object
required:
- change_option
title: SubscriptionPlanChange
MutatedSubscription:
properties:
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
customer:
$ref: '#/components/schemas/Customer'
plan:
oneOf:
- $ref: '#/components/schemas/Plan'
- type: 'null'
name:
type: string
title: Name
description: The name of the subscription.
start_date:
type: string
format: date-time
title: Start Date
description: The date Orb starts billing for this subscription.
end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Date
description: The date Orb stops billing for this subscription.
created_at:
type: string
format: date-time
title: Created At
current_billing_period_start_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Current Billing Period Start Date
description: >-
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:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Current Billing Period End Date
description: >-
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:
type: string
enum:
- active
- ended
- upcoming
title: Status
trial_info:
$ref: '#/components/schemas/SubscriptionTrialInfo'
active_plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Active Plan Phase Order
description: >-
The current plan phase that is active, only if the subscription's
plan has phases.
fixed_fee_quantity_schedule:
items:
$ref: '#/components/schemas/FixedFeeQuantityScheduleEntry'
type: array
title: Fixed Fee Quantity Schedule
default_invoice_memo:
oneOf:
- type: string
- type: 'null'
title: Default Invoice Memo
description: >-
Determines the default memo on this subscriptions' invoices. Note
that if this is not provided, it is determined by the plan
configuration.
auto_collection:
oneOf:
- type: boolean
- type: 'null'
title: Auto Collection
description: >-
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.
net_terms:
type: integer
title: Net Terms
description: >-
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:
oneOf:
- $ref: '#/components/schemas/CouponRedemption'
- type: 'null'
billing_cycle_day:
type: integer
maximum: 31
minimum: 1
title: Billing Cycle Day
description: >-
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:
$ref: '#/components/schemas/BillingCycleAnchorConfiguration'
invoicing_threshold:
oneOf:
- type: string
- type: 'null'
title: Invoicing Threshold
price_intervals:
items:
$ref: '#/components/schemas/PriceInterval'
type: array
title: Price Intervals
description: The price intervals for this subscription.
adjustment_intervals:
items:
$ref: '#/components/schemas/AdjustmentInterval'
type: array
title: Adjustment Intervals
description: >-
The adjustment intervals for this subscription sorted by the
start_date of the adjustment interval.
discount_intervals:
items:
oneOf:
- $ref: '#/components/schemas/AmountDiscountInterval'
- $ref: '#/components/schemas/PercentageDiscountInterval'
- $ref: '#/components/schemas/UsageDiscountInterval'
- $ref: '#/components/schemas/TieredPercentageDiscountInterval'
discriminator:
propertyName: discount_type
mapping:
amount:
$ref: '#/components/schemas/AmountDiscountInterval'
percentage:
$ref: '#/components/schemas/PercentageDiscountInterval'
tiered_percentage:
$ref: '#/components/schemas/TieredPercentageDiscountInterval'
usage:
$ref: '#/components/schemas/UsageDiscountInterval'
type: array
title: Discount Intervals
description: >-
The discount intervals for this subscription sorted by the
start_date. This field is deprecated in favor of
`adjustment_intervals`.
deprecated: true
minimum_intervals:
items:
$ref: '#/components/schemas/MinimumInterval'
type: array
title: Minimum Intervals
description: >-
The minimum intervals for this subscription sorted by the
start_date. This field is deprecated in favor of
`adjustment_intervals`.
deprecated: true
maximum_intervals:
items:
$ref: '#/components/schemas/MaximumInterval'
type: array
title: Maximum Intervals
description: >-
The maximum intervals for this subscription sorted by the
start_date. This field is deprecated in favor of
`adjustment_intervals`.
deprecated: true
pending_subscription_change:
oneOf:
- $ref: '#/components/schemas/SubscriptionChangeMinified'
- type: 'null'
description: A pending subscription change if one exists on this subscription.
changed_resources:
oneOf:
- $ref: '#/components/schemas/ChangedSubscriptionResources'
- type: 'null'
description: >-
The resources that were changed as part of this operation. Only
present when fetched through the subscription changes API or if the
`include_changed_resources` parameter was passed in the request.
type: object
required:
- metadata
- id
- customer
- plan
- name
- start_date
- end_date
- created_at
- current_billing_period_start_date
- current_billing_period_end_date
- status
- trial_info
- active_plan_phase_order
- fixed_fee_quantity_schedule
- default_invoice_memo
- auto_collection
- net_terms
- redeemed_coupon
- billing_cycle_day
- billing_cycle_anchor_configuration
- invoicing_threshold
- price_intervals
- adjustment_intervals
- discount_intervals
- minimum_intervals
- maximum_intervals
- pending_subscription_change
title: MutatedSubscription
400Error:
oneOf:
- $ref: '#/components/schemas/ConstraintViolationError'
- $ref: '#/components/schemas/DuplicateResourceCreationError'
- $ref: '#/components/schemas/RequestValidationError'
401Error:
$ref: '#/components/schemas/AuthorizationError'
title: 401Error
404Error:
oneOf:
- $ref: '#/components/schemas/FeatureNotAvailableError'
- $ref: '#/components/schemas/ResourceNotFoundError'
- $ref: '#/components/schemas/URLNotFound'
409Error:
$ref: '#/components/schemas/IdempotencyRequestMismatch'
title: 409Error
413Error:
oneOf:
- $ref: '#/components/schemas/RequestTooLargeError'
- $ref: '#/components/schemas/ResourceTooLargeError'
- $ref: '#/components/schemas/TooManyResultsError'
429Error:
$ref: '#/components/schemas/TooManyRequests'
title: 429Error
500Error:
$ref: '#/components/schemas/ServerError'
title: 500Error
AddSubscriptionPriceParams:
properties:
price_id:
oneOf:
- type: string
- type: 'null'
title: Price Id
description: The id of the price to add to the subscription.
examples:
- h74gfhdjvn7ujokd
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: The external price id of the price to add to the subscription.
examples:
- external_price_id
price:
oneOf:
- $ref: '#/components/schemas/NewSubscriptionPrice'
- type: 'null'
description: The definition of a new price to create and add to the subscription.
allocation_price:
oneOf:
- $ref: '#/components/schemas/NewAllocationPrice'
- type: 'null'
description: >-
The definition of a new allocation price to create and add to the
subscription.
start_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Start Date
description: >-
The start date of the price interval. This is the date that the
price will start billing on the subscription. If null, billing will
start when the phase or subscription starts.
examples:
- '2023-05-01'
end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Date
description: >-
The end date of the price interval. This is the date that the price
will stop billing on the subscription. If null, billing will end
when the phase or subscription ends.
examples:
- '2023-07-10'
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
description: The phase to add this price to.
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
description: >-
[DEPRECATED] Use add_adjustments instead. The subscription's minimum
amount for this price.
deprecated: true
examples:
- '1.23'
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
description: >-
[DEPRECATED] Use add_adjustments instead. The subscription's maximum
amount for this price.
deprecated: true
examples:
- '1.23'
discounts:
oneOf:
- items:
$ref: '#/components/schemas/DiscountOverride'
type: array
- type: 'null'
title: Discounts
description: >-
[DEPRECATED] Use add_adjustments instead. The subscription's
discounts for this price.
deprecated: true
metric_parameter_overrides:
oneOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metric Parameter Overrides
description: >-
Override values for parameterized billable metric variables. Keys
are parameter names, values are the override values.
type: object
title: AddSubscriptionPriceParams
RemoveSubscriptionPriceParams:
properties:
price_id:
oneOf:
- type: string
- type: 'null'
title: Price Id
description: The id of the price to remove on the subscription.
examples:
- h74gfhdjvn7ujokd
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: The external price id of the price to remove on the subscription.
examples:
- external_price_id
type: object
title: RemoveSubscriptionPriceParams
ReplaceSubscriptionPriceParams:
properties:
price_id:
oneOf:
- type: string
- type: 'null'
title: Price Id
description: The id of the price to add to the subscription.
examples:
- h74gfhdjvn7ujokd
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: The external price id of the price to add to the subscription.
examples:
- external_price_id
price:
oneOf:
- $ref: '#/components/schemas/NewSubscriptionPrice'
- type: 'null'
description: The definition of a new price to create and add to the subscription.
allocation_price:
oneOf:
- $ref: '#/components/schemas/NewAllocationPrice'
- type: 'null'
description: >-
The definition of a new allocation price to create and add to the
subscription.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: The new quantity of the price, if the price is a fixed price.
examples:
- 2
replaces_price_id:
type: string
title: Replaces Price Id
description: The id of the price on the plan to replace in the subscription.
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
description: >-
[DEPRECATED] Use add_adjustments instead. The subscription's minimum
amount for the replacement price.
deprecated: true
examples:
- '1.23'
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
description: >-
[DEPRECATED] Use add_adjustments instead. The subscription's maximum
amount for the replacement price.
deprecated: true
examples:
- '1.23'
discounts:
oneOf:
- items:
$ref: '#/components/schemas/DiscountOverride'
type: array
- type: 'null'
title: Discounts
description: >-
[DEPRECATED] Use add_adjustments instead. The subscription's
discounts for the replacement price.
deprecated: true
metric_parameter_overrides:
oneOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metric Parameter Overrides
description: >-
Override values for parameterized billable metric variables. Keys
are parameter names, values are the override values.
type: object
required:
- replaces_price_id
title: ReplaceSubscriptionPriceParams
AddSubscriptionAdjustmentParams:
properties:
adjustment:
$ref: '#/components/schemas/NewAdjustment'
description: >-
The definition of a new adjustment to create and add to the
subscription.
start_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Start Date
description: >-
The start date of the adjustment interval. This is the date that the
adjustment will start affecting prices on the subscription. If null,
the adjustment will start when the phase or subscription starts.
examples:
- '2023-05-01'
end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Date
description: >-
The end date of the adjustment interval. This is the date that the
adjustment will stop affecting prices on the subscription.
examples:
- '2023-07-10'
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
description: The phase to add this adjustment to.
type: object
required:
- adjustment
title: AddSubscriptionAdjustmentParams
RemoveSubscriptionAdjustmentParams:
properties:
adjustment_id:
type: string
title: Adjustment Id
description: The id of the adjustment to remove on the subscription.
examples:
- h74gfhdjvn7ujokd
type: object
required:
- adjustment_id
title: RemoveSubscriptionAdjustmentParams
ReplaceSubscriptionAdjustmentParams:
properties:
adjustment:
$ref: '#/components/schemas/NewAdjustment'
description: >-
The definition of a new adjustment to create and add to the
subscription.
replaces_adjustment_id:
type: string
title: Replaces Adjustment Id
description: The id of the adjustment on the plan to replace in the subscription.
type: object
required:
- adjustment
- replaces_adjustment_id
title: ReplaceSubscriptionAdjustmentParams
BillingCycleAnchorConfiguration:
properties:
day:
type: integer
maximum: 31
minimum: 1
title: Day
description: >-
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:
oneOf:
- type: integer
maximum: 12
minimum: 1
- type: 'null'
title: Month
description: >-
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:
oneOf:
- type: integer
- type: 'null'
title: Year
description: >-
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.).
type: object
required:
- day
title: BillingCycleAnchorConfiguration
Customer:
properties:
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
external_customer_id:
oneOf:
- type: string
- type: 'null'
title: External Customer Id
description: >-
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:
type: string
title: Name
description: The full name of the customer
email:
type: string
title: Email
description: >-
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:
type: string
title: Timezone
description: >-
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:
oneOf:
- type: string
- type: 'null'
title: Payment Provider Id
description: >-
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:
oneOf:
- type: string
enum:
- quickbooks
- bill.com
- stripe_charge
- stripe_invoice
- netsuite
- adyen
- type: 'null'
title: Payment Provider
description: >-
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:
type: string
format: date-time
title: Created At
shipping_address:
oneOf:
- $ref: '#/components/schemas/Address'
- type: 'null'
billing_address:
oneOf:
- $ref: '#/components/schemas/Address'
- type: 'null'
balance:
type: string
title: Balance
description: The customer's current balance in their currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
tax_id:
oneOf:
- $ref: '#/components/schemas/CustomerTaxId'
- type: 'null'
auto_collection:
type: boolean
title: Auto Collection
exempt_from_automated_tax:
oneOf:
- type: boolean
- type: 'null'
title: Exempt From Automated Tax
email_delivery:
type: boolean
title: Email Delivery
auto_issuance:
oneOf:
- type: boolean
- type: 'null'
title: Auto Issuance
description: >-
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:
items:
type: string
type: array
title: Additional Emails
portal_url:
oneOf:
- type: string
- type: 'null'
title: Portal Url
description: >-
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:
oneOf:
- $ref: '#/components/schemas/AccountingSyncConfiguration'
- type: 'null'
reporting_configuration:
oneOf:
- $ref: '#/components/schemas/ReportingConfiguration'
- type: 'null'
payment_configuration:
oneOf:
- $ref: '#/components/schemas/PaymentConfiguration'
- type: 'null'
description: >-
Payment configuration for the customer, applicable when using Orb
Invoicing with a supported payment provider such as Stripe.
default_payment_method:
oneOf:
- $ref: '#/components/schemas/PaymentMethod'
- type: 'null'
description: The customer's default payment method, or null if none is set.
hierarchy:
$ref: '#/components/schemas/CustomerHierarchy'
description: The hierarchical relationships for this customer.
automatic_tax_enabled:
oneOf:
- type: boolean
- type: 'null'
title: Automatic Tax Enabled
description: >-
Whether automatic tax calculation is enabled for this customer. This
field is nullable for backwards compatibility but will always return
a boolean value.
type: object
required:
- metadata
- id
- external_customer_id
- name
- email
- timezone
- payment_provider_id
- payment_provider
- created_at
- shipping_address
- billing_address
- balance
- currency
- tax_id
- auto_collection
- exempt_from_automated_tax
- email_delivery
- auto_issuance
- additional_emails
- portal_url
- hierarchy
title: Customer
description: >-
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.
Plan:
properties:
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
description:
type: string
title: Description
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
created_at:
type: string
format: date-time
title: Created At
status:
type: string
enum:
- active
- archived
- draft
title: Status
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
product:
$ref: '#/components/schemas/Product'
version:
type: integer
title: Version
trial_config:
$ref: '#/components/schemas/TrialConfig'
plan_phases:
oneOf:
- items:
$ref: '#/components/schemas/PlanPhase'
type: array
- type: 'null'
title: Plan Phases
base_plan:
oneOf:
- $ref: '#/components/schemas/PlanMinified'
- type: 'null'
description: >-
Legacy field representing the parent plan if the current plan is a
'child plan', overriding prices from the parent.
deprecated: true
base_plan_id:
oneOf:
- type: string
- type: 'null'
title: Base Plan Id
description: >-
Legacy field representing the parent plan ID if the current plan is
a 'child plan', overriding prices from the parent.
deprecated: true
external_plan_id:
oneOf:
- type: string
- type: 'null'
title: External Plan Id
description: >-
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:
type: string
title: Currency
description: >-
An ISO 4217 currency string or custom pricing unit (`credits`) for
this plan's prices.
deprecated: true
invoicing_currency:
type: string
title: Invoicing Currency
description: >-
An ISO 4217 currency string for which this plan is billed in.
Matches `currency` unless `currency` is a custom pricing unit.
net_terms:
oneOf:
- type: integer
- type: 'null'
title: Net Terms
description: >-
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:
oneOf:
- type: string
- type: 'null'
title: Default Invoice Memo
description: >-
The default memo text on the invoices corresponding to subscriptions
on this plan. Note that each subscription may configure its own
memo.
prices:
items:
$ref: '#/components/schemas/Price'
type: array
uniqueItems: true
title: Prices
description: >-
Prices for this plan. If the plan has phases, this includes prices
across all phases of the plan.
adjustments:
items:
$ref: '#/components/schemas/Adjustment'
type: array
uniqueItems: true
title: Adjustments
description: >-
Adjustments for this plan. If the plan has phases, this includes
adjustments across all phases of the plan.
type: object
required:
- metadata
- id
- name
- description
- maximum_amount
- minimum_amount
- created_at
- status
- maximum
- minimum
- discount
- product
- version
- trial_config
- plan_phases
- base_plan
- base_plan_id
- external_plan_id
- currency
- invoicing_currency
- net_terms
- default_invoice_memo
- prices
- adjustments
title: Plan
description: >-
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).
SubscriptionTrialInfo:
properties:
end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Date
type: object
required:
- end_date
title: SubscriptionTrialInfo
FixedFeeQuantityScheduleEntry:
properties:
price_id:
type: string
title: Price Id
start_date:
type: string
format: date-time
title: Start Date
end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Date
quantity:
type: number
title: Quantity
type: object
required:
- price_id
- start_date
- end_date
- quantity
title: FixedFeeQuantityScheduleEntry
CouponRedemption:
properties:
coupon_id:
type: string
title: Coupon Id
start_date:
type: string
format: date-time
title: Start Date
end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Date
type: object
required:
- coupon_id
- start_date
- end_date
title: CouponRedemption
PriceInterval:
properties:
id:
type: string
title: Id
start_date:
type: string
format: date-time
title: Start Date
description: >-
The start date of the price interval. This is the date that Orb
starts billing for this price.
end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Date
description: >-
The end date of the price interval. This is the date that Orb stops
billing for this price.
price:
$ref: '#/components/schemas/Price'
billing_cycle_day:
type: integer
title: Billing Cycle Day
description: The day of the month that Orb bills for this price
can_defer_billing:
type: boolean
title: Can Defer Billing
description: >-
For in-arrears prices. If true, and the price interval ends
mid-cycle, the final line item will be deferred to the next
scheduled invoice instead of being billed mid-cycle.
fixed_fee_quantity_transitions:
oneOf:
- items:
$ref: '#/components/schemas/FixedFeeQuantityTransition'
type: array
- type: 'null'
title: Fixed Fee Quantity Transitions
description: >-
The fixed fee quantity transitions for this price interval. This is
only relevant for fixed fees.
current_billing_period_start_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Current Billing Period Start Date
description: >-
The start date of the current billing period. This is an inclusive
timestamp; the instant returned is exactly the beginning of the
billing period. Set to null if this price interval is not currently
active.
current_billing_period_end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Current Billing Period End Date
description: >-
The end of the current billing period. This is an exclusive
timestamp, such that the instant returned is exactly the end of the
billing period. Set to null if this price interval is not currently
active.
filter:
oneOf:
- type: string
- type: 'null'
title: Filter
description: An additional filter to apply to usage queries.
usage_customer_ids:
oneOf:
- items:
type: string
type: array
- type: 'null'
title: Usage Customer Ids
description: >-
A list of customer IDs whose usage events will be aggregated and
billed under this price interval.
metric_parameter_overrides:
oneOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metric Parameter Overrides
description: >-
Override values for parameterized billable metric variables. Keys
are parameter names, values are the override values.
type: object
required:
- id
- start_date
- end_date
- price
- billing_cycle_day
- can_defer_billing
- fixed_fee_quantity_transitions
- current_billing_period_start_date
- current_billing_period_end_date
- filter
- usage_customer_ids
title: PriceInterval
description: >-
The Price Interval resource represents a period of time for which a
price will bill on a subscription. A
subscription’s price intervals define its billing behavior.
AdjustmentInterval:
properties:
id:
type: string
title: Id
adjustment:
$ref: '#/components/schemas/Adjustment'
start_date:
type: string
format: date-time
title: Start Date
description: The start date of the adjustment interval.
end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Date
description: The end date of the adjustment interval.
applies_to_price_interval_ids:
items:
type: string
type: array
title: Applies To Price Interval Ids
description: The price interval IDs that this adjustment applies to.
type: object
required:
- id
- adjustment
- start_date
- end_date
- applies_to_price_interval_ids
title: AdjustmentInterval
AmountDiscountInterval:
properties:
discount_type:
type: string
enum:
- amount
title: Discount Type
amount_discount:
type: string
title: Amount Discount
description: Only available if discount_type is `amount`.
start_date:
type: string
format: date-time
title: Start Date
description: The start date of the discount interval.
end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Date
description: The end date of the discount interval.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: >-
The filters that determine which prices this discount interval
applies to.
applies_to_price_interval_ids:
items:
type: string
type: array
title: Applies To Price Interval Ids
description: The price interval ids that this discount interval applies to.
type: object
required:
- discount_type
- amount_discount
- start_date
- end_date
- filters
- applies_to_price_interval_ids
title: AmountDiscountInterval
PercentageDiscountInterval:
properties:
discount_type:
type: string
enum:
- percentage
title: Discount Type
percentage_discount:
type: number
title: Percentage Discount
description: >-
Only available if discount_type is `percentage`.This is a number
between 0 and 1.
examples:
- 0.15
start_date:
type: string
format: date-time
title: Start Date
description: The start date of the discount interval.
end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Date
description: The end date of the discount interval.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: >-
The filters that determine which prices this discount interval
applies to.
applies_to_price_interval_ids:
items:
type: string
type: array
title: Applies To Price Interval Ids
description: The price interval ids that this discount interval applies to.
type: object
required:
- discount_type
- percentage_discount
- start_date
- end_date
- filters
- applies_to_price_interval_ids
title: PercentageDiscountInterval
UsageDiscountInterval:
properties:
discount_type:
type: string
enum:
- usage
title: Discount Type
usage_discount:
type: number
title: Usage Discount
description: >-
Only available if discount_type is `usage`. Number of usage units
that this discount is for
start_date:
type: string
format: date-time
title: Start Date
description: The start date of the discount interval.
end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Date
description: The end date of the discount interval.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: >-
The filters that determine which prices this discount interval
applies to.
applies_to_price_interval_ids:
items:
type: string
type: array
title: Applies To Price Interval Ids
description: The price interval ids that this discount interval applies to.
type: object
required:
- discount_type
- usage_discount
- start_date
- end_date
- filters
- applies_to_price_interval_ids
title: UsageDiscountInterval
TieredPercentageDiscountInterval:
properties:
discount_type:
type: string
enum:
- tiered_percentage
title: Discount Type
tiers:
items:
$ref: '#/components/schemas/PercentageTier'
type: array
title: Tiers
description: >-
Only available if discount_type is `tiered_percentage`. The ordered,
contiguous bands of cumulative eligible spend, each discounted at
its own percentage.
start_date:
type: string
format: date-time
title: Start Date
description: The start date of the discount interval.
end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Date
description: The end date of the discount interval.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: >-
The filters that determine which prices this discount interval
applies to.
applies_to_price_interval_ids:
items:
type: string
type: array
title: Applies To Price Interval Ids
description: The price interval ids that this discount interval applies to.
type: object
required:
- discount_type
- tiers
- start_date
- end_date
- filters
- applies_to_price_interval_ids
title: TieredPercentageDiscountInterval
MinimumInterval:
properties:
start_date:
type: string
format: date-time
title: Start Date
description: The start date of the minimum interval.
end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Date
description: The end date of the minimum interval.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: >-
The filters that determine which prices this minimum interval
applies to.
applies_to_price_interval_ids:
items:
type: string
type: array
title: Applies To Price Interval Ids
description: The price interval ids that this minimum interval applies to.
minimum_amount:
type: string
title: Minimum Amount
description: >-
The minimum amount to charge in a given billing period for the price
intervals this minimum applies to.
type: object
required:
- start_date
- end_date
- filters
- applies_to_price_interval_ids
- minimum_amount
title: MinimumInterval
MaximumInterval:
properties:
start_date:
type: string
format: date-time
title: Start Date
description: The start date of the maximum interval.
end_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Date
description: The end date of the maximum interval.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: >-
The filters that determine which prices this maximum interval
applies to.
applies_to_price_interval_ids:
items:
type: string
type: array
title: Applies To Price Interval Ids
description: The price interval ids that this maximum interval applies to.
maximum_amount:
type: string
title: Maximum Amount
description: >-
The maximum amount to charge in a given billing period for the price
intervals this transform applies to.
type: object
required:
- start_date
- end_date
- filters
- applies_to_price_interval_ids
- maximum_amount
title: MaximumInterval
SubscriptionChangeMinified:
properties:
id:
type: string
title: Id
type: object
required:
- id
title: SubscriptionChangeMinified
ChangedSubscriptionResources:
properties:
created_credit_notes:
items:
$ref: '#/components/schemas/CreditNote'
type: array
title: Created Credit Notes
description: The credit notes that were created as part of this operation.
voided_credit_notes:
items:
$ref: '#/components/schemas/CreditNote'
type: array
title: Voided Credit Notes
description: The credit notes that were voided as part of this operation.
created_invoices:
items:
$ref: '#/components/schemas/CreatedInvoice'
type: array
title: Created Invoices
description: The invoices that were created as part of this operation.
voided_invoices:
items:
$ref: '#/components/schemas/Invoice'
type: array
title: Voided Invoices
description: The invoices that were voided as part of this operation.
type: object
required:
- created_credit_notes
- voided_credit_notes
- created_invoices
- voided_invoices
title: ChangedSubscriptionResources
ConstraintViolationError:
properties:
type:
type: string
enum:
- >-
https://docs.withorb.com/reference/error-responses#400-constraint-violation
title: Type
status:
type: integer
enum:
- 400
title: Status
detail:
oneOf:
- type: string
- type: 'null'
title: Detail
title:
oneOf:
- type: string
- type: 'null'
title: Title
type: object
required:
- type
- status
title: ConstraintViolationError
DuplicateResourceCreationError:
properties:
type:
type: string
enum:
- >-
https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation
title: Type
status:
type: integer
enum:
- 400
title: Status
detail:
oneOf:
- type: string
- type: 'null'
title: Detail
title:
oneOf:
- type: string
- type: 'null'
title: Title
type: object
required:
- type
- status
title: DuplicateResourceCreationError
RequestValidationError:
properties:
type:
type: string
enum:
- >-
https://docs.withorb.com/reference/error-responses#400-request-validation-errors
title: Type
status:
type: integer
enum:
- 400
title: Status
detail:
oneOf:
- type: string
- type: 'null'
title: Detail
title:
oneOf:
- type: string
- type: 'null'
title: Title
validation_errors:
items: {}
type: array
title: Validation Errors
type: object
required:
- type
- status
- validation_errors
title: RequestValidationError
AuthorizationError:
properties:
type:
type: string
enum:
- >-
https://docs.withorb.com/reference/error-responses#401-authentication-error
title: Type
status:
type: integer
enum:
- 401
title: Status
detail:
oneOf:
- type: string
- type: 'null'
title: Detail
title:
oneOf:
- type: string
- type: 'null'
title: Title
type: object
required:
- type
- status
title: AuthorizationError
FeatureNotAvailableError:
properties:
type:
type: string
enum:
- >-
https://docs.withorb.com/reference/error-responses#404-feature-not-available
title: Type
status:
type: integer
enum:
- 400
title: Status
detail:
oneOf:
- type: string
- type: 'null'
title: Detail
title:
oneOf:
- type: string
- type: 'null'
title: Title
type: object
required:
- type
- status
title: FeatureNotAvailableError
ResourceNotFoundError:
properties:
type:
type: string
enum:
- >-
https://docs.withorb.com/reference/error-responses#404-resource-not-found
title: Type
status:
type: integer
enum:
- 404
title: Status
detail:
oneOf:
- type: string
- type: 'null'
title: Detail
title:
type: string
title: Title
type: object
required:
- type
- status
- title
title: ResourceNotFoundError
URLNotFound:
properties:
type:
type: string
enum:
- >-
https://docs.withorb.com/reference/error-responses#404-url-not-found
title: Type
status:
type: integer
enum:
- 404
title: Status
detail:
oneOf:
- type: string
- type: 'null'
title: Detail
title:
oneOf:
- type: string
- type: 'null'
title: Title
type: object
required:
- type
- status
title: URLNotFound
IdempotencyRequestMismatch:
properties:
type:
type: string
enum:
- >-
https://docs.withorb.com/reference/error-responses#409-resource-conflict
title: Type
status:
type: integer
enum:
- 409
title: Status
detail:
oneOf:
- type: string
- type: 'null'
title: Detail
title:
oneOf:
- type: string
- type: 'null'
title: Title
type: object
required:
- type
- status
title: IdempotencyRequestMismatch
RequestTooLargeError:
properties:
type:
type: string
enum:
- >-
https://docs.withorb.com/reference/error-responses#413-request-too-large
title: Type
status:
type: integer
enum:
- 413
title: Status
detail:
oneOf:
- type: string
- type: 'null'
title: Detail
title:
oneOf:
- type: string
- type: 'null'
title: Title
type: object
required:
- type
- status
title: RequestTooLargeError
ResourceTooLargeError:
properties:
type:
type: string
enum:
- >-
https://docs.withorb.com/reference/error-responses#413-resource-too-large
title: Type
status:
type: integer
enum:
- 413
title: Status
detail:
oneOf:
- type: string
- type: 'null'
title: Detail
title:
oneOf:
- type: string
- type: 'null'
title: Title
type: object
required:
- type
- status
title: ResourceTooLargeError
TooManyResultsError:
properties:
type:
type: string
enum:
- >-
https://docs.withorb.com/reference/error-responses#413-too-many-results
title: Type
status:
type: integer
enum:
- 413
title: Status
detail:
oneOf:
- type: string
- type: 'null'
title: Detail
title:
oneOf:
- type: string
- type: 'null'
title: Title
type: object
required:
- type
- status
title: TooManyResultsError
TooManyRequests:
properties:
type:
type: string
enum:
- >-
https://docs.withorb.com/reference/error-responses#429-too-many-requests
title: Type
status:
type: integer
enum:
- 429
title: Status
detail:
oneOf:
- type: string
- type: 'null'
title: Detail
title:
oneOf:
- type: string
- type: 'null'
title: Title
type: object
required:
- type
- status
title: TooManyRequests
ServerError:
properties:
type:
type: string
enum:
- >-
https://docs.withorb.com/reference/error-responses#500-internal-server-error
title: Type
status:
type: integer
title: Status
detail:
oneOf:
- type: string
- type: 'null'
title: Detail
title:
oneOf:
- type: string
- type: 'null'
title: Title
type: object
required:
- type
- status
title: ServerError
NewSubscriptionPrice:
oneOf:
- $ref: '#/components/schemas/NewSubscriptionUnitPrice'
- $ref: '#/components/schemas/NewSubscriptionTieredPrice'
- $ref: '#/components/schemas/NewSubscriptionBulkPrice'
- $ref: '#/components/schemas/NewSubscriptionBulkWithFiltersPrice'
- $ref: '#/components/schemas/NewSubscriptionPackagePrice'
- $ref: '#/components/schemas/NewSubscriptionMatrixPrice'
- $ref: '#/components/schemas/NewSubscriptionThresholdTotalAmountPrice'
- $ref: '#/components/schemas/NewSubscriptionTieredPackagePrice'
- $ref: '#/components/schemas/NewSubscriptionTieredWithMinimumPrice'
- $ref: '#/components/schemas/NewSubscriptionGroupedTieredPrice'
- $ref: '#/components/schemas/NewSubscriptionTieredPackageWithMinimumPrice'
- $ref: '#/components/schemas/NewSubscriptionPackageWithAllocationPrice'
- $ref: '#/components/schemas/NewSubscriptionUnitWithPercentPrice'
- $ref: '#/components/schemas/NewSubscriptionMatrixWithAllocationPrice'
- $ref: >-
#/components/schemas/NewSubscriptionMatrixWithThresholdDiscountsPrice
- $ref: '#/components/schemas/NewSubscriptionTieredWithProrationPrice'
- $ref: '#/components/schemas/NewSubscriptionUnitWithProrationPrice'
- $ref: '#/components/schemas/NewSubscriptionGroupedAllocationPrice'
- $ref: '#/components/schemas/NewSubscriptionBulkWithProrationPrice'
- $ref: '#/components/schemas/NewSubscriptionGroupedWithProratedMinimumPrice'
- $ref: '#/components/schemas/NewSubscriptionGroupedWithMeteredMinimumPrice'
- $ref: '#/components/schemas/NewSubscriptionGroupedWithMinMaxThresholdsPrice'
- $ref: '#/components/schemas/NewSubscriptionMatrixWithDisplayNamePrice'
- $ref: '#/components/schemas/NewSubscriptionGroupedTieredPackagePrice'
- $ref: '#/components/schemas/NewSubscriptionMaxGroupTieredPackagePrice'
- $ref: >-
#/components/schemas/NewSubscriptionScalableMatrixWithUnitPricingPrice
- $ref: >-
#/components/schemas/NewSubscriptionScalableMatrixWithTieredPricingPrice
- $ref: '#/components/schemas/NewSubscriptionCumulativeGroupedBulkPrice'
- $ref: '#/components/schemas/NewSubscriptionCumulativeGroupedAllocationPrice'
- $ref: '#/components/schemas/NewSubscriptionDailyCreditAllowancePrice'
- $ref: '#/components/schemas/NewSubscriptionMeteredAllowancePrice'
- $ref: '#/components/schemas/NewSubscriptionMinimumCompositePrice'
- $ref: '#/components/schemas/NewSubscriptionPercentCompositePrice'
- $ref: '#/components/schemas/NewSubscriptionEventOutputPrice'
description: New subscription price request body params.
discriminator:
propertyName: model_type
mapping:
bulk:
$ref: '#/components/schemas/NewSubscriptionBulkPrice'
bulk_with_filters:
$ref: '#/components/schemas/NewSubscriptionBulkWithFiltersPrice'
bulk_with_proration:
$ref: '#/components/schemas/NewSubscriptionBulkWithProrationPrice'
cumulative_grouped_allocation:
$ref: >-
#/components/schemas/NewSubscriptionCumulativeGroupedAllocationPrice
cumulative_grouped_bulk:
$ref: '#/components/schemas/NewSubscriptionCumulativeGroupedBulkPrice'
daily_credit_allowance:
$ref: '#/components/schemas/NewSubscriptionDailyCreditAllowancePrice'
event_output:
$ref: '#/components/schemas/NewSubscriptionEventOutputPrice'
grouped_allocation:
$ref: '#/components/schemas/NewSubscriptionGroupedAllocationPrice'
grouped_tiered:
$ref: '#/components/schemas/NewSubscriptionGroupedTieredPrice'
grouped_tiered_package:
$ref: '#/components/schemas/NewSubscriptionGroupedTieredPackagePrice'
grouped_with_metered_minimum:
$ref: '#/components/schemas/NewSubscriptionGroupedWithMeteredMinimumPrice'
grouped_with_min_max_thresholds:
$ref: >-
#/components/schemas/NewSubscriptionGroupedWithMinMaxThresholdsPrice
grouped_with_prorated_minimum:
$ref: >-
#/components/schemas/NewSubscriptionGroupedWithProratedMinimumPrice
matrix:
$ref: '#/components/schemas/NewSubscriptionMatrixPrice'
matrix_with_allocation:
$ref: '#/components/schemas/NewSubscriptionMatrixWithAllocationPrice'
matrix_with_display_name:
$ref: '#/components/schemas/NewSubscriptionMatrixWithDisplayNamePrice'
matrix_with_threshold_discounts:
$ref: >-
#/components/schemas/NewSubscriptionMatrixWithThresholdDiscountsPrice
max_group_tiered_package:
$ref: '#/components/schemas/NewSubscriptionMaxGroupTieredPackagePrice'
metered_allowance:
$ref: '#/components/schemas/NewSubscriptionMeteredAllowancePrice'
minimum_composite:
$ref: '#/components/schemas/NewSubscriptionMinimumCompositePrice'
package:
$ref: '#/components/schemas/NewSubscriptionPackagePrice'
package_with_allocation:
$ref: '#/components/schemas/NewSubscriptionPackageWithAllocationPrice'
percent:
$ref: '#/components/schemas/NewSubscriptionPercentCompositePrice'
scalable_matrix_with_tiered_pricing:
$ref: >-
#/components/schemas/NewSubscriptionScalableMatrixWithTieredPricingPrice
scalable_matrix_with_unit_pricing:
$ref: >-
#/components/schemas/NewSubscriptionScalableMatrixWithUnitPricingPrice
threshold_total_amount:
$ref: '#/components/schemas/NewSubscriptionThresholdTotalAmountPrice'
tiered:
$ref: '#/components/schemas/NewSubscriptionTieredPrice'
tiered_package:
$ref: '#/components/schemas/NewSubscriptionTieredPackagePrice'
tiered_package_with_minimum:
$ref: '#/components/schemas/NewSubscriptionTieredPackageWithMinimumPrice'
tiered_with_minimum:
$ref: '#/components/schemas/NewSubscriptionTieredWithMinimumPrice'
tiered_with_proration:
$ref: '#/components/schemas/NewSubscriptionTieredWithProrationPrice'
unit:
$ref: '#/components/schemas/NewSubscriptionUnitPrice'
unit_with_percent:
$ref: '#/components/schemas/NewSubscriptionUnitWithPercentPrice'
unit_with_proration:
$ref: '#/components/schemas/NewSubscriptionUnitWithProrationPrice'
NewAllocationPrice:
properties:
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
currency:
type: string
title: Currency
description: >-
An ISO 4217 currency string or a custom pricing unit identifier in
which to bill this price.
examples:
- USD
- credits
amount:
type: string
title: Amount
description: >-
An amount of the currency to allocate to the customer at the
specified cadence.
examples:
- '10.00'
- '5'
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
title: Cadence
description: The cadence at which to allocate the amount to the customer.
examples:
- monthly
- quarterly
expires_at_end_of_cadence:
oneOf:
- type: boolean
- type: 'null'
title: Expires At End Of Cadence
description: >-
Whether the allocated amount should expire at the end of the cadence
or roll over to the next period. Set to null if using
custom_expiration.
custom_expiration:
oneOf:
- $ref: '#/components/schemas/CustomExpiration'
- type: 'null'
description: The custom expiration for the allocation.
filters:
oneOf:
- items:
$ref: '#/components/schemas/BlockPriceFilter'
type: array
- type: 'null'
title: Filters
description: The filters that determine which items the allocation applies to.
per_unit_cost_basis:
type: string
title: Per Unit Cost Basis
description: >-
The (per-unit) cost basis of each created block. If non-zero, a
customer will be invoiced according to the quantity and per unit
cost basis specified for the allocation each cadence.
default: '0.00'
item_id:
oneOf:
- type: string
- type: 'null'
title: Item Id
description: >-
The item ID that line items representing charges for this allocation
will be associated with. If not provided, the default allocation
item for the currency will be used (e.g. 'Included Allocation
(USD)').
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: 'The license type ID to associate the price with license allocation. '
type: object
required:
- currency
- amount
- cadence
title: NewAllocationPrice
DiscountOverride:
properties:
discount_type:
type: string
enum:
- percentage
- usage
- amount
title: Discount Type
percentage_discount:
oneOf:
- type: number
- type: 'null'
title: Percentage Discount
description: >-
Only available if discount_type is `percentage`. This is a number
between 0 and 1.
examples:
- 0.15
usage_discount:
oneOf:
- type: number
- type: 'null'
title: Usage Discount
description: >-
Only available if discount_type is `usage`. Number of usage units
that this discount is for
amount_discount:
oneOf:
- type: string
- type: 'null'
title: Amount Discount
description: Only available if discount_type is `amount`.
type: object
required:
- discount_type
title: DiscountOverride
NewAdjustment:
oneOf:
- $ref: '#/components/schemas/NewPercentageDiscount'
- $ref: '#/components/schemas/NewUsageDiscount'
- $ref: '#/components/schemas/NewAmountDiscount'
- $ref: '#/components/schemas/NewMinimum'
- $ref: '#/components/schemas/NewMaximum'
- $ref: '#/components/schemas/NewTieredPercentageDiscount'
discriminator:
propertyName: adjustment_type
mapping:
amount_discount:
$ref: '#/components/schemas/NewAmountDiscount'
maximum:
$ref: '#/components/schemas/NewMaximum'
minimum:
$ref: '#/components/schemas/NewMinimum'
percentage_discount:
$ref: '#/components/schemas/NewPercentageDiscount'
tiered_percentage_discount:
$ref: '#/components/schemas/NewTieredPercentageDiscount'
usage_discount:
$ref: '#/components/schemas/NewUsageDiscount'
Address:
properties:
line1:
oneOf:
- type: string
- type: 'null'
title: Line1
line2:
oneOf:
- type: string
- type: 'null'
title: Line2
city:
oneOf:
- type: string
- type: 'null'
title: City
state:
oneOf:
- type: string
- type: 'null'
title: State
postal_code:
oneOf:
- type: string
- type: 'null'
title: Postal Code
country:
oneOf:
- type: string
- type: 'null'
title: Country
type: object
required:
- line1
- line2
- city
- state
- postal_code
- country
title: Address
CustomerTaxId:
properties:
country:
type: string
enum:
- 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
title: Country
type:
type: string
enum:
- 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
title: Type
value:
type: string
title: Value
type: object
required:
- country
- type
- value
title: CustomerTaxId
description: >-
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 |
AccountingSyncConfiguration:
properties:
excluded:
type: boolean
title: Excluded
accounting_providers:
items:
$ref: '#/components/schemas/AccountingProvider'
type: array
title: Accounting Providers
type: object
required:
- excluded
- accounting_providers
title: AccountingSyncConfiguration
ReportingConfiguration:
properties:
exempt:
type: boolean
title: Exempt
type: object
required:
- exempt
title: ReportingConfiguration
PaymentConfiguration:
properties:
payment_providers:
items:
$ref: '#/components/schemas/PaymentConfigurationItem'
type: array
title: Payment Providers
description: Provider-specific payment configuration.
default: []
type: object
title: PaymentConfiguration
PaymentMethod:
properties:
id:
type: string
title: Id
description: The Orb-assigned unique identifier for the payment method.
payment_method_type:
type: string
enum:
- card
- us_bank_account
- link
- amazon_pay
- crypto
title: Payment Method Type
description: >-
The type of the underlying payment instrument, e.g. `card` or
`us_bank_account`.
provider_type:
oneOf:
- type: string
- type: 'null'
title: Provider Type
description: >-
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:
type: string
title: External Payment Method Id
description: >-
The identifier of this payment method in the external payment
provider.
customer_id:
type: string
title: Customer Id
description: The ID of the Orb customer this payment method is attached to.
default:
type: boolean
title: Default
description: Whether this is the customer's default payment method.
created_at:
type: string
format: date-time
title: Created At
description: The time at which the payment method was created.
type: object
required:
- id
- payment_method_type
- provider_type
- external_payment_method_id
- customer_id
- default
- created_at
title: PaymentMethod
description: >-
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.
CustomerHierarchy:
properties:
parent:
oneOf:
- $ref: '#/components/schemas/CustomerMinified'
- type: 'null'
children:
items:
$ref: '#/components/schemas/CustomerMinified'
type: array
title: Children
type: object
required:
- parent
- children
title: CustomerHierarchy
Maximum:
properties:
maximum_amount:
type: string
title: Maximum Amount
description: Maximum amount applied
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: The filters that determine which prices to apply this maximum to.
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
description: >-
List of price_ids that this maximum amount applies to. For plan/plan
phase maximums, this can be a subset of prices.
deprecated: true
type: object
required:
- maximum_amount
- filters
- applies_to_price_ids
title: Maximum
Minimum:
properties:
minimum_amount:
type: string
title: Minimum Amount
description: Minimum amount applied
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: The filters that determine which prices to apply this minimum to.
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
description: >-
List of price_ids that this minimum amount applies to. For plan/plan
phase minimums, this can be a subset of prices.
deprecated: true
type: object
required:
- minimum_amount
- filters
- applies_to_price_ids
title: Minimum
Discount:
oneOf:
- $ref: '#/components/schemas/PercentageDiscount'
- $ref: '#/components/schemas/TrialDiscount'
- $ref: '#/components/schemas/UsageDiscount'
- $ref: '#/components/schemas/AmountDiscount'
- $ref: '#/components/schemas/TieredPercentageDiscount'
discriminator:
propertyName: discount_type
mapping:
amount:
$ref: '#/components/schemas/AmountDiscount'
percentage:
$ref: '#/components/schemas/PercentageDiscount'
tiered_percentage:
$ref: '#/components/schemas/TieredPercentageDiscount'
trial:
$ref: '#/components/schemas/TrialDiscount'
usage:
$ref: '#/components/schemas/UsageDiscount'
Product:
properties:
created_at:
type: string
format: date-time
title: Created At
id:
type: string
title: Id
name:
type: string
title: Name
type: object
required:
- created_at
- id
- name
title: Product
TrialConfig:
properties:
trial_period:
oneOf:
- type: integer
- type: 'null'
title: Trial Period
trial_period_unit:
type: string
enum:
- days
title: Trial Period Unit
type: object
required:
- trial_period
- trial_period_unit
title: TrialConfig
PlanPhase:
properties:
id:
type: string
title: Id
description:
oneOf:
- type: string
- type: 'null'
title: Description
duration:
oneOf:
- type: integer
- type: 'null'
title: Duration
description: >-
How many terms of length `duration_unit` this phase is active for.
If null, this phase is evergreen and active indefinitely
duration_unit:
oneOf:
- type: string
enum:
- daily
- monthly
- quarterly
- semi_annual
- annual
- type: 'null'
title: Duration Unit
name:
type: string
title: Name
order:
type: integer
title: Order
description: >-
Determines the ordering of the phase in a plan's lifecycle. 1 =
first phase.
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
type: object
required:
- id
- description
- duration
- duration_unit
- name
- order
- minimum
- maximum
- maximum_amount
- minimum_amount
- discount
title: PlanPhase
PlanMinified:
properties:
id:
oneOf:
- type: string
- type: 'null'
title: Id
examples:
- m2t5akQeh2obwxeU
external_plan_id:
oneOf:
- type: string
- type: 'null'
title: External Plan Id
description: >-
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.
examples:
- m2t5akQeh2obwxeU
name:
oneOf:
- type: string
- type: 'null'
title: Name
examples:
- Example plan
type: object
required:
- id
- external_plan_id
- name
title: PlanMinified
Price:
oneOf:
- $ref: '#/components/schemas/UnitPrice'
- $ref: '#/components/schemas/TieredPrice'
- $ref: '#/components/schemas/BulkPrice'
- $ref: '#/components/schemas/BulkWithFiltersPrice'
- $ref: '#/components/schemas/PackagePrice'
- $ref: '#/components/schemas/MatrixPrice'
- $ref: '#/components/schemas/ThresholdTotalAmountPrice'
- $ref: '#/components/schemas/TieredPackagePrice'
- $ref: '#/components/schemas/TieredWithMinimumPrice'
- $ref: '#/components/schemas/GroupedTieredPrice'
- $ref: '#/components/schemas/TieredPackageWithMinimumPrice'
- $ref: '#/components/schemas/PackageWithAllocationPrice'
- $ref: '#/components/schemas/UnitWithPercentPrice'
- $ref: '#/components/schemas/MatrixWithAllocationPrice'
- $ref: '#/components/schemas/MatrixWithThresholdDiscountsPrice'
- $ref: '#/components/schemas/TieredWithProrationPrice'
- $ref: '#/components/schemas/UnitWithProrationPrice'
- $ref: '#/components/schemas/GroupedAllocationPrice'
- $ref: '#/components/schemas/BulkWithProrationPrice'
- $ref: '#/components/schemas/GroupedWithProratedMinimumPrice'
- $ref: '#/components/schemas/GroupedWithMeteredMinimumPrice'
- $ref: '#/components/schemas/GroupedWithMinMaxThresholdsPrice'
- $ref: '#/components/schemas/MatrixWithDisplayNamePrice'
- $ref: '#/components/schemas/GroupedTieredPackagePrice'
- $ref: '#/components/schemas/MaxGroupTieredPackagePrice'
- $ref: '#/components/schemas/ScalableMatrixWithUnitPricingPrice'
- $ref: '#/components/schemas/ScalableMatrixWithTieredPricingPrice'
- $ref: '#/components/schemas/CumulativeGroupedBulkPrice'
- $ref: '#/components/schemas/CumulativeGroupedAllocationPrice'
- $ref: '#/components/schemas/DailyCreditAllowancePrice'
- $ref: '#/components/schemas/MeteredAllowancePrice'
- $ref: '#/components/schemas/MinimumCompositePrice'
- $ref: '#/components/schemas/PercentCompositePrice'
- $ref: '#/components/schemas/EventOutputPrice'
description: >-
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)
discriminator:
propertyName: model_type
mapping:
bulk:
$ref: '#/components/schemas/BulkPrice'
bulk_with_filters:
$ref: '#/components/schemas/BulkWithFiltersPrice'
bulk_with_proration:
$ref: '#/components/schemas/BulkWithProrationPrice'
cumulative_grouped_allocation:
$ref: '#/components/schemas/CumulativeGroupedAllocationPrice'
cumulative_grouped_bulk:
$ref: '#/components/schemas/CumulativeGroupedBulkPrice'
daily_credit_allowance:
$ref: '#/components/schemas/DailyCreditAllowancePrice'
event_output:
$ref: '#/components/schemas/EventOutputPrice'
grouped_allocation:
$ref: '#/components/schemas/GroupedAllocationPrice'
grouped_tiered:
$ref: '#/components/schemas/GroupedTieredPrice'
grouped_tiered_package:
$ref: '#/components/schemas/GroupedTieredPackagePrice'
grouped_with_metered_minimum:
$ref: '#/components/schemas/GroupedWithMeteredMinimumPrice'
grouped_with_min_max_thresholds:
$ref: '#/components/schemas/GroupedWithMinMaxThresholdsPrice'
grouped_with_prorated_minimum:
$ref: '#/components/schemas/GroupedWithProratedMinimumPrice'
matrix:
$ref: '#/components/schemas/MatrixPrice'
matrix_with_allocation:
$ref: '#/components/schemas/MatrixWithAllocationPrice'
matrix_with_display_name:
$ref: '#/components/schemas/MatrixWithDisplayNamePrice'
matrix_with_threshold_discounts:
$ref: '#/components/schemas/MatrixWithThresholdDiscountsPrice'
max_group_tiered_package:
$ref: '#/components/schemas/MaxGroupTieredPackagePrice'
metered_allowance:
$ref: '#/components/schemas/MeteredAllowancePrice'
minimum_composite:
$ref: '#/components/schemas/MinimumCompositePrice'
package:
$ref: '#/components/schemas/PackagePrice'
package_with_allocation:
$ref: '#/components/schemas/PackageWithAllocationPrice'
percent:
$ref: '#/components/schemas/PercentCompositePrice'
scalable_matrix_with_tiered_pricing:
$ref: '#/components/schemas/ScalableMatrixWithTieredPricingPrice'
scalable_matrix_with_unit_pricing:
$ref: '#/components/schemas/ScalableMatrixWithUnitPricingPrice'
threshold_total_amount:
$ref: '#/components/schemas/ThresholdTotalAmountPrice'
tiered:
$ref: '#/components/schemas/TieredPrice'
tiered_package:
$ref: '#/components/schemas/TieredPackagePrice'
tiered_package_with_minimum:
$ref: '#/components/schemas/TieredPackageWithMinimumPrice'
tiered_with_minimum:
$ref: '#/components/schemas/TieredWithMinimumPrice'
tiered_with_proration:
$ref: '#/components/schemas/TieredWithProrationPrice'
unit:
$ref: '#/components/schemas/UnitPrice'
unit_with_percent:
$ref: '#/components/schemas/UnitWithPercentPrice'
unit_with_proration:
$ref: '#/components/schemas/UnitWithProrationPrice'
Adjustment:
oneOf:
- $ref: '#/components/schemas/PlanPhaseUsageDiscountAdjustment'
- $ref: '#/components/schemas/PlanPhaseAmountDiscountAdjustment'
- $ref: '#/components/schemas/PlanPhasePercentageDiscountAdjustment'
- $ref: '#/components/schemas/PlanPhaseTieredPercentageDiscountAdjustment'
- $ref: '#/components/schemas/PlanPhaseMinimumAdjustment'
- $ref: '#/components/schemas/PlanPhaseMaximumAdjustment'
discriminator:
propertyName: adjustment_type
mapping:
amount_discount:
$ref: '#/components/schemas/PlanPhaseAmountDiscountAdjustment'
maximum:
$ref: '#/components/schemas/PlanPhaseMaximumAdjustment'
minimum:
$ref: '#/components/schemas/PlanPhaseMinimumAdjustment'
percentage_discount:
$ref: '#/components/schemas/PlanPhasePercentageDiscountAdjustment'
tiered_percentage_discount:
$ref: '#/components/schemas/PlanPhaseTieredPercentageDiscountAdjustment'
usage_discount:
$ref: '#/components/schemas/PlanPhaseUsageDiscountAdjustment'
FixedFeeQuantityTransition:
properties:
price_id:
type: string
title: Price Id
effective_date:
type: string
format: date-time
title: Effective Date
quantity:
type: integer
title: Quantity
type: object
required:
- price_id
- effective_date
- quantity
title: FixedFeeQuantityTransition
PriceFilter:
properties:
field:
type: string
enum:
- price_id
- item_id
- price_type
- currency
- pricing_unit_id
title: Field
description: The property of the price to filter on.
operator:
type: string
enum:
- includes
- excludes
title: Operator
description: Should prices that match the filter be included or excluded.
values:
items:
type: string
type: array
uniqueItems: true
title: Values
description: The IDs or values that match this filter.
type: object
required:
- field
- operator
- values
title: PriceFilter
PercentageTier:
properties:
lower_bound:
type: number
minimum: 0
title: Lower Bound
description: Exclusive lower bound of cumulative spend for this tier.
upper_bound:
oneOf:
- type: number
- type: 'null'
title: Upper Bound
description: >-
Inclusive upper bound of cumulative spend for this tier; null for
the final open-ended tier.
percentage:
type: number
maximum: 1
minimum: 0
title: Percentage
description: >-
The percentage (between 0 and 1) discounted from spend that falls
within this tier.
type: object
required:
- lower_bound
- percentage
title: PercentageTier
description: >-
One band of a tiered percentage discount. Bounds are denominated in the
discount's currency.
`lower_bound` is the exclusive start of the band and `upper_bound` is
the inclusive end;
`upper_bound` is null only for the open-ended final tier.
CreditNote:
properties:
id:
type: string
title: Id
description: The Orb id of this credit note.
created_at:
type: string
format: date-time
title: Created At
description: The creation time of the resource in Orb.
voided_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Voided At
description: The time at which the credit note was voided in Orb, if applicable.
credit_note_number:
type: string
title: Credit Note Number
description: The unique identifier for credit notes.
invoice_id:
type: string
title: Invoice Id
description: The id of the invoice resource that this credit note is applied to.
memo:
oneOf:
- type: string
- type: 'null'
title: Memo
description: An optional memo supplied on the credit note.
reason:
oneOf:
- type: string
enum:
- Duplicate
- Fraudulent
- Order change
- Product unsatisfactory
- type: 'null'
title: Reason
type:
type: string
enum:
- refund
- adjustment
title: Type
subtotal:
type: string
title: Subtotal
description: >-
The total prior to any creditable invoice-level discounts or
minimums.
total:
type: string
title: Total
description: >-
The total including creditable invoice-level discounts or minimums,
and tax.
customer:
$ref: '#/components/schemas/CustomerMinified'
credit_note_pdf:
oneOf:
- type: string
- type: 'null'
title: Credit Note Pdf
description: A URL to a PDF of the credit note.
minimum_amount_refunded:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount Refunded
description: Any credited amount from the applied minimum on the invoice.
discounts:
items:
$ref: '#/components/schemas/CreditNoteDiscount'
type: array
title: Discounts
description: Any discounts applied on the original invoice.
default: []
maximum_amount_adjustment:
oneOf:
- $ref: '#/components/schemas/CreditNoteDiscount'
- type: 'null'
description: The maximum amount applied on the original invoice
line_items:
items:
$ref: '#/components/schemas/CreditNoteLineItem'
type: array
title: Line Items
description: All of the line items associated with this credit note.
type: object
required:
- id
- created_at
- voided_at
- credit_note_number
- invoice_id
- memo
- reason
- type
- subtotal
- total
- customer
- credit_note_pdf
- minimum_amount_refunded
- maximum_amount_adjustment
- line_items
title: CreditNote
description: >-
The [Credit Note](/invoicing/credit-notes) resource represents a credit
that has been applied to a
particular invoice.
CreatedInvoice:
properties:
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
User specified key-value pairs for the resource. If not present,
this defaults to an empty dictionary. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can
be cleared by setting `metadata` to `null`.
voided_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Voided At
description: >-
If the invoice has a status of `void`, this gives a timestamp when
the invoice was voided.
paid_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Paid At
description: >-
If the invoice has a status of `paid`, this gives a timestamp when
the invoice was paid.
issued_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Issued At
description: >-
If the invoice has been issued, this will be the time it
transitioned to `issued` (even if it is now in a different state.)
scheduled_issue_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Scheduled Issue At
description: >-
If the invoice is in draft, this timestamp will reflect when the
invoice is scheduled to be issued.
auto_collection:
$ref: '#/components/schemas/AutoCollection'
issue_failed_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Issue Failed At
description: >-
If the invoice failed to issue, this will be the last time it failed
to issue (even if it is now in a different state.)
sync_failed_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Sync Failed At
description: >-
If the invoice failed to sync, this will be the last time an
external invoicing provider sync was attempted. This field will
always be `null` for invoices using Orb Invoicing.
payment_failed_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Payment Failed At
description: >-
If payment was attempted on this invoice but failed, this will be
the time of the most recent attempt.
payment_started_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Payment Started At
description: >-
If payment was attempted on this invoice, this will be the start
time of the most recent attempt. This field is especially useful for
delayed-notification payment mechanisms (like bank transfers), where
payment can take 3 days or more.
amount_due:
type: string
title: Amount Due
description: >-
This is the final amount required to be charged to the customer and
reflects the application of the customer balance to the `total` of
the invoice.
examples:
- '8.00'
created_at:
type: string
format: date-time
title: Created At
description: The creation time of the resource in Orb.
examples:
- '2022-05-01T07:01:31+00:00'
currency:
type: string
title: Currency
description: An ISO 4217 currency string or `credits`
examples:
- USD
customer:
$ref: '#/components/schemas/CustomerMinified'
due_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Due Date
description: >-
When the invoice payment is due. The due date is null if the invoice
is not yet finalized.
examples:
- '2022-05-30T07:00:00+00:00'
id:
type: string
title: Id
invoice_pdf:
oneOf:
- type: string
- type: 'null'
title: Invoice Pdf
description: The link to download the PDF representation of the `Invoice`.
examples:
- >-
https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb
invoice_number:
type: string
title: Invoice Number
description: >-
Automatically generated invoice number to help track and reconcile
invoices. Invoice numbers have a prefix such as `RFOBWG`. These can
be sequential per account or customer.
examples:
- JYEFHK-00001
subscription:
oneOf:
- $ref: '#/components/schemas/SubscriptionMinified'
- type: 'null'
total:
type: string
title: Total
description: The total after any minimums and discounts have been applied.
examples:
- '8.00'
customer_balance_transactions:
items:
$ref: '#/components/schemas/CustomerBalanceTransaction'
type: array
title: Customer Balance Transactions
status:
type: string
enum:
- issued
- paid
- synced
- void
- draft
title: Status
invoice_source:
type: string
enum:
- subscription
- partial
- one_off
title: Invoice Source
shipping_address:
oneOf:
- $ref: '#/components/schemas/Address'
- type: 'null'
billing_address:
oneOf:
- $ref: '#/components/schemas/Address'
- type: 'null'
hosted_invoice_url:
oneOf:
- type: string
- type: 'null'
title: Hosted Invoice Url
description: >-
A URL for the customer-facing invoice portal. This URL expires 60
days after the link is generated, or 30 days after the invoice's due
date — whichever is later.
will_auto_issue:
type: boolean
title: Will Auto Issue
description: >-
This is true if the invoice will be automatically issued in the
future, and false otherwise.
eligible_to_issue_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Eligible To Issue At
description: >-
If the invoice has a status of `draft`, this will be the time that
the invoice will be eligible to be issued, otherwise it will be
`null`. If `auto-issue` is true, the invoice will automatically
begin issuing at this time.
customer_tax_id:
oneOf:
- $ref: '#/components/schemas/CustomerTaxId'
- type: 'null'
memo:
oneOf:
- type: string
- type: 'null'
title: Memo
description: >-
Free-form text which is available on the invoice PDF and the Orb
invoice portal.
credit_notes:
items:
$ref: '#/components/schemas/CreditNoteSummary'
type: array
title: Credit Notes
description: A list of credit notes associated with the invoice
payment_attempts:
items:
$ref: '#/components/schemas/PaymentAttempt'
type: array
title: Payment Attempts
description: A list of payment attempts associated with the invoice
discount:
oneOf:
- $ref: '#/components/schemas/DEPRECATED_InvoiceLevelDiscount'
- type: 'null'
description: >-
This field is deprecated in favor of `discounts`. If a `discounts`
list is provided, the first discount in the list will be returned.
If the list is empty, `None` will be returned.
deprecated: true
discounts:
items:
$ref: '#/components/schemas/InvoiceLevelDiscount'
type: array
title: Discounts
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
line_items:
items:
$ref: '#/components/schemas/InvoiceLineItem'
type: array
title: Line Items
description: The breakdown of prices in this invoice.
subtotal:
type: string
title: Subtotal
description: The total before any discounts and minimums are applied.
examples:
- '8.00'
invoice_date:
type: string
format: date-time
title: Invoice Date
description: The scheduled date of the invoice
examples:
- '2022-05-01T07:00:00+00:00'
is_payable_now:
type: boolean
title: Is Payable Now
description: >-
True if the invoice has only in-advance fixed fees and is payable
now
type: object
required:
- metadata
- voided_at
- paid_at
- issued_at
- scheduled_issue_at
- auto_collection
- issue_failed_at
- sync_failed_at
- payment_failed_at
- payment_started_at
- amount_due
- created_at
- currency
- customer
- due_date
- id
- invoice_pdf
- invoice_number
- subscription
- total
- customer_balance_transactions
- status
- invoice_source
- shipping_address
- billing_address
- hosted_invoice_url
- will_auto_issue
- eligible_to_issue_at
- customer_tax_id
- memo
- credit_notes
- payment_attempts
- discount
- discounts
- minimum
- minimum_amount
- maximum
- maximum_amount
- line_items
- subtotal
- invoice_date
- is_payable_now
title: CreatedInvoice
Invoice:
properties:
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
User specified key-value pairs for the resource. If not present,
this defaults to an empty dictionary. Individual keys can be removed
by setting the value to `null`, and the entire metadata mapping can
be cleared by setting `metadata` to `null`.
voided_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Voided At
description: >-
If the invoice has a status of `void`, this gives a timestamp when
the invoice was voided.
paid_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Paid At
description: >-
If the invoice has a status of `paid`, this gives a timestamp when
the invoice was paid.
issued_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Issued At
description: >-
If the invoice has been issued, this will be the time it
transitioned to `issued` (even if it is now in a different state.)
scheduled_issue_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Scheduled Issue At
description: >-
If the invoice is in draft, this timestamp will reflect when the
invoice is scheduled to be issued.
auto_collection:
$ref: '#/components/schemas/AutoCollection'
issue_failed_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Issue Failed At
description: >-
If the invoice failed to issue, this will be the last time it failed
to issue (even if it is now in a different state.)
sync_failed_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Sync Failed At
description: >-
If the invoice failed to sync, this will be the last time an
external invoicing provider sync was attempted. This field will
always be `null` for invoices using Orb Invoicing.
payment_failed_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Payment Failed At
description: >-
If payment was attempted on this invoice but failed, this will be
the time of the most recent attempt.
payment_started_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Payment Started At
description: >-
If payment was attempted on this invoice, this will be the start
time of the most recent attempt. This field is especially useful for
delayed-notification payment mechanisms (like bank transfers), where
payment can take 3 days or more.
amount_due:
type: string
title: Amount Due
description: >-
This is the final amount required to be charged to the customer and
reflects the application of the customer balance to the `total` of
the invoice.
examples:
- '8.00'
created_at:
type: string
format: date-time
title: Created At
description: The creation time of the resource in Orb.
examples:
- '2022-05-01T07:01:31+00:00'
currency:
type: string
title: Currency
description: An ISO 4217 currency string or `credits`
examples:
- USD
customer:
$ref: '#/components/schemas/CustomerMinified'
due_date:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Due Date
description: >-
When the invoice payment is due. The due date is null if the invoice
is not yet finalized.
examples:
- '2022-05-30T07:00:00+00:00'
id:
type: string
title: Id
invoice_pdf:
oneOf:
- type: string
- type: 'null'
title: Invoice Pdf
description: The link to download the PDF representation of the `Invoice`.
examples:
- >-
https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb
invoice_number:
type: string
title: Invoice Number
description: >-
Automatically generated invoice number to help track and reconcile
invoices. Invoice numbers have a prefix such as `RFOBWG`. These can
be sequential per account or customer.
examples:
- JYEFHK-00001
subscription:
oneOf:
- $ref: '#/components/schemas/SubscriptionMinified'
- type: 'null'
total:
type: string
title: Total
description: The total after any minimums and discounts have been applied.
examples:
- '8.00'
customer_balance_transactions:
items:
$ref: '#/components/schemas/CustomerBalanceTransaction'
type: array
title: Customer Balance Transactions
status:
type: string
enum:
- issued
- paid
- synced
- void
- draft
title: Status
invoice_source:
type: string
enum:
- subscription
- partial
- one_off
title: Invoice Source
shipping_address:
oneOf:
- $ref: '#/components/schemas/Address'
- type: 'null'
billing_address:
oneOf:
- $ref: '#/components/schemas/Address'
- type: 'null'
hosted_invoice_url:
oneOf:
- type: string
- type: 'null'
title: Hosted Invoice Url
description: >-
A URL for the customer-facing invoice portal. This URL expires 60
days after the link is generated, or 30 days after the invoice's due
date — whichever is later.
will_auto_issue:
type: boolean
title: Will Auto Issue
description: >-
This is true if the invoice will be automatically issued in the
future, and false otherwise.
eligible_to_issue_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Eligible To Issue At
description: >-
If the invoice has a status of `draft`, this will be the time that
the invoice will be eligible to be issued, otherwise it will be
`null`. If `auto-issue` is true, the invoice will automatically
begin issuing at this time.
customer_tax_id:
oneOf:
- $ref: '#/components/schemas/CustomerTaxId'
- type: 'null'
memo:
oneOf:
- type: string
- type: 'null'
title: Memo
description: >-
Free-form text which is available on the invoice PDF and the Orb
invoice portal.
credit_notes:
items:
$ref: '#/components/schemas/CreditNoteSummary'
type: array
title: Credit Notes
description: A list of credit notes associated with the invoice
payment_attempts:
items:
$ref: '#/components/schemas/PaymentAttempt'
type: array
title: Payment Attempts
description: A list of payment attempts associated with the invoice
discount:
oneOf:
- $ref: '#/components/schemas/DEPRECATED_InvoiceLevelDiscount'
- type: 'null'
description: >-
This field is deprecated in favor of `discounts`. If a `discounts`
list is provided, the first discount in the list will be returned.
If the list is empty, `None` will be returned.
deprecated: true
discounts:
items:
$ref: '#/components/schemas/InvoiceLevelDiscount'
type: array
title: Discounts
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
line_items:
items:
$ref: '#/components/schemas/InvoiceLineItem'
type: array
title: Line Items
description: The breakdown of prices in this invoice.
subtotal:
type: string
title: Subtotal
description: The total before any discounts and minimums are applied.
examples:
- '8.00'
invoice_date:
type: string
format: date-time
title: Invoice Date
description: The scheduled date of the invoice
examples:
- '2022-05-01T07:00:00+00:00'
type: object
required:
- metadata
- voided_at
- paid_at
- issued_at
- scheduled_issue_at
- auto_collection
- issue_failed_at
- sync_failed_at
- payment_failed_at
- payment_started_at
- amount_due
- created_at
- currency
- customer
- due_date
- id
- invoice_pdf
- invoice_number
- subscription
- total
- customer_balance_transactions
- status
- invoice_source
- shipping_address
- billing_address
- hosted_invoice_url
- will_auto_issue
- eligible_to_issue_at
- customer_tax_id
- memo
- credit_notes
- payment_attempts
- discount
- discounts
- minimum
- minimum_amount
- maximum
- maximum_amount
- line_items
- subtotal
- invoice_date
title: Invoice
description: >-
An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
representing the request for payment for
a single subscription. This includes a set of line items, which
correspond to prices in the subscription's plan and
can represent fixed recurring fees or usage-based fees. They are
generated at the end of a billing period, or as
the result of an action, such as a cancellation.
NewSubscriptionUnitPrice:
properties:
model_type:
type: string
enum:
- unit
title: Model Type
description: The pricing model type
unit_config:
$ref: '#/components/schemas/UnitConfig'
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- unit_config
- name
- item_id
- cadence
title: NewSubscriptionUnitPrice
NewSubscriptionTieredPrice:
properties:
model_type:
type: string
enum:
- tiered
title: Model Type
description: The pricing model type
tiered_config:
$ref: '#/components/schemas/TieredConfig'
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- tiered_config
- name
- item_id
- cadence
title: NewSubscriptionTieredPrice
NewSubscriptionBulkPrice:
properties:
model_type:
type: string
enum:
- bulk
title: Model Type
description: The pricing model type
bulk_config:
$ref: '#/components/schemas/BulkConfig'
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- bulk_config
- name
- item_id
- cadence
title: NewSubscriptionBulkPrice
NewSubscriptionBulkWithFiltersPrice:
properties:
model_type:
type: string
enum:
- bulk_with_filters
title: Model Type
description: The pricing model type
bulk_with_filters_config:
$ref: '#/components/schemas/BulkWithFiltersConfig'
description: Configuration for bulk_with_filters pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- bulk_with_filters_config
- name
- item_id
- cadence
title: NewSubscriptionBulkWithFiltersPrice
NewSubscriptionPackagePrice:
properties:
model_type:
type: string
enum:
- package
title: Model Type
description: The pricing model type
package_config:
$ref: '#/components/schemas/PackageConfig'
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- package_config
- name
- item_id
- cadence
title: NewSubscriptionPackagePrice
NewSubscriptionMatrixPrice:
properties:
model_type:
type: string
enum:
- matrix
title: Model Type
description: The pricing model type
matrix_config:
$ref: '#/components/schemas/MatrixConfig'
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- matrix_config
- name
- item_id
- cadence
title: NewSubscriptionMatrixPrice
NewSubscriptionThresholdTotalAmountPrice:
properties:
model_type:
type: string
enum:
- threshold_total_amount
title: Model Type
description: The pricing model type
threshold_total_amount_config:
$ref: '#/components/schemas/ThresholdTotalAmountConfig'
description: Configuration for threshold_total_amount pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- threshold_total_amount_config
- name
- item_id
- cadence
title: NewSubscriptionThresholdTotalAmountPrice
NewSubscriptionTieredPackagePrice:
properties:
model_type:
type: string
enum:
- tiered_package
title: Model Type
description: The pricing model type
tiered_package_config:
$ref: '#/components/schemas/TieredPackagePricingConfig'
description: Configuration for tiered_package pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- tiered_package_config
- name
- item_id
- cadence
title: NewSubscriptionTieredPackagePrice
NewSubscriptionTieredWithMinimumPrice:
properties:
model_type:
type: string
enum:
- tiered_with_minimum
title: Model Type
description: The pricing model type
tiered_with_minimum_config:
$ref: '#/components/schemas/TieredPricingWithMinimumConfig'
description: Configuration for tiered_with_minimum pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- tiered_with_minimum_config
- name
- item_id
- cadence
title: NewSubscriptionTieredWithMinimumPrice
NewSubscriptionGroupedTieredPrice:
properties:
model_type:
type: string
enum:
- grouped_tiered
title: Model Type
description: The pricing model type
grouped_tiered_config:
$ref: '#/components/schemas/GroupedTieredConfig'
description: Configuration for grouped_tiered pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- grouped_tiered_config
- name
- item_id
- cadence
title: NewSubscriptionGroupedTieredPrice
NewSubscriptionTieredPackageWithMinimumPrice:
properties:
model_type:
type: string
enum:
- tiered_package_with_minimum
title: Model Type
description: The pricing model type
tiered_package_with_minimum_config:
$ref: '#/components/schemas/TieredPackagePricingWithMinimumConfig'
description: Configuration for tiered_package_with_minimum pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- tiered_package_with_minimum_config
- name
- item_id
- cadence
title: NewSubscriptionTieredPackageWithMinimumPrice
NewSubscriptionPackageWithAllocationPrice:
properties:
model_type:
type: string
enum:
- package_with_allocation
title: Model Type
description: The pricing model type
package_with_allocation_config:
$ref: '#/components/schemas/PackageWithAllocationConfig'
description: Configuration for package_with_allocation pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- package_with_allocation_config
- name
- item_id
- cadence
title: NewSubscriptionPackageWithAllocationPrice
NewSubscriptionUnitWithPercentPrice:
properties:
model_type:
type: string
enum:
- unit_with_percent
title: Model Type
description: The pricing model type
unit_with_percent_config:
$ref: '#/components/schemas/UnitWithPercentConfig'
description: Configuration for unit_with_percent pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- unit_with_percent_config
- name
- item_id
- cadence
title: NewSubscriptionUnitWithPercentPrice
NewSubscriptionMatrixWithAllocationPrice:
properties:
model_type:
type: string
enum:
- matrix_with_allocation
title: Model Type
description: The pricing model type
matrix_with_allocation_config:
$ref: '#/components/schemas/MatrixWithAllocationConfig'
description: Configuration for matrix_with_allocation pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- matrix_with_allocation_config
- name
- item_id
- cadence
title: NewSubscriptionMatrixWithAllocationPrice
NewSubscriptionMatrixWithThresholdDiscountsPrice:
properties:
model_type:
type: string
enum:
- matrix_with_threshold_discounts
title: Model Type
description: The pricing model type
matrix_with_threshold_discounts_config:
$ref: '#/components/schemas/MatrixWithThresholdDiscountsConfig'
description: Configuration for matrix_with_threshold_discounts pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- matrix_with_threshold_discounts_config
- name
- item_id
- cadence
title: NewSubscriptionMatrixWithThresholdDiscountsPrice
NewSubscriptionTieredWithProrationPrice:
properties:
model_type:
type: string
enum:
- tiered_with_proration
title: Model Type
description: The pricing model type
tiered_with_proration_config:
$ref: '#/components/schemas/TieredWithProrationConfig'
description: Configuration for tiered_with_proration pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- tiered_with_proration_config
- name
- item_id
- cadence
title: NewSubscriptionTieredWithProrationPrice
NewSubscriptionUnitWithProrationPrice:
properties:
model_type:
type: string
enum:
- unit_with_proration
title: Model Type
description: The pricing model type
unit_with_proration_config:
$ref: '#/components/schemas/UnitWithProrationConfig'
description: Configuration for unit_with_proration pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- unit_with_proration_config
- name
- item_id
- cadence
title: NewSubscriptionUnitWithProrationPrice
NewSubscriptionGroupedAllocationPrice:
properties:
model_type:
type: string
enum:
- grouped_allocation
title: Model Type
description: The pricing model type
grouped_allocation_config:
$ref: '#/components/schemas/GroupedAllocationConfig'
description: Configuration for grouped_allocation pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- grouped_allocation_config
- name
- item_id
- cadence
title: NewSubscriptionGroupedAllocationPrice
NewSubscriptionBulkWithProrationPrice:
properties:
model_type:
type: string
enum:
- bulk_with_proration
title: Model Type
description: The pricing model type
bulk_with_proration_config:
$ref: '#/components/schemas/BulkWithProrationConfig'
description: Configuration for bulk_with_proration pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- bulk_with_proration_config
- name
- item_id
- cadence
title: NewSubscriptionBulkWithProrationPrice
NewSubscriptionGroupedWithProratedMinimumPrice:
properties:
model_type:
type: string
enum:
- grouped_with_prorated_minimum
title: Model Type
description: The pricing model type
grouped_with_prorated_minimum_config:
$ref: '#/components/schemas/GroupedWithProratedMinimumConfig'
description: Configuration for grouped_with_prorated_minimum pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- grouped_with_prorated_minimum_config
- name
- item_id
- cadence
title: NewSubscriptionGroupedWithProratedMinimumPrice
NewSubscriptionGroupedWithMeteredMinimumPrice:
properties:
model_type:
type: string
enum:
- grouped_with_metered_minimum
title: Model Type
description: The pricing model type
grouped_with_metered_minimum_config:
$ref: '#/components/schemas/GroupedWithMeteredMinimumConfig'
description: Configuration for grouped_with_metered_minimum pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- grouped_with_metered_minimum_config
- name
- item_id
- cadence
title: NewSubscriptionGroupedWithMeteredMinimumPrice
NewSubscriptionGroupedWithMinMaxThresholdsPrice:
properties:
model_type:
type: string
enum:
- grouped_with_min_max_thresholds
title: Model Type
description: The pricing model type
grouped_with_min_max_thresholds_config:
$ref: '#/components/schemas/GroupedWithMinMaxThresholdsConfig'
description: Configuration for grouped_with_min_max_thresholds pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- grouped_with_min_max_thresholds_config
- name
- item_id
- cadence
title: NewSubscriptionGroupedWithMinMaxThresholdsPrice
NewSubscriptionMatrixWithDisplayNamePrice:
properties:
model_type:
type: string
enum:
- matrix_with_display_name
title: Model Type
description: The pricing model type
matrix_with_display_name_config:
$ref: '#/components/schemas/MatrixWithDisplayNameConfig'
description: Configuration for matrix_with_display_name pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- matrix_with_display_name_config
- name
- item_id
- cadence
title: NewSubscriptionMatrixWithDisplayNamePrice
NewSubscriptionGroupedTieredPackagePrice:
properties:
model_type:
type: string
enum:
- grouped_tiered_package
title: Model Type
description: The pricing model type
grouped_tiered_package_config:
$ref: '#/components/schemas/GroupedTieredPackagePricingConfig'
description: Configuration for grouped_tiered_package pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- grouped_tiered_package_config
- name
- item_id
- cadence
title: NewSubscriptionGroupedTieredPackagePrice
NewSubscriptionMaxGroupTieredPackagePrice:
properties:
model_type:
type: string
enum:
- max_group_tiered_package
title: Model Type
description: The pricing model type
max_group_tiered_package_config:
$ref: '#/components/schemas/MaxGroupTieredPackageConfig'
description: Configuration for max_group_tiered_package pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- max_group_tiered_package_config
- name
- item_id
- cadence
title: NewSubscriptionMaxGroupTieredPackagePrice
NewSubscriptionScalableMatrixWithUnitPricingPrice:
properties:
model_type:
type: string
enum:
- scalable_matrix_with_unit_pricing
title: Model Type
description: The pricing model type
scalable_matrix_with_unit_pricing_config:
$ref: '#/components/schemas/ScalableMatrixWithUnitPricingConfig'
description: Configuration for scalable_matrix_with_unit_pricing pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- scalable_matrix_with_unit_pricing_config
- name
- item_id
- cadence
title: NewSubscriptionScalableMatrixWithUnitPricingPrice
NewSubscriptionScalableMatrixWithTieredPricingPrice:
properties:
model_type:
type: string
enum:
- scalable_matrix_with_tiered_pricing
title: Model Type
description: The pricing model type
scalable_matrix_with_tiered_pricing_config:
$ref: '#/components/schemas/ScalableMatrixWithTieredPricingConfig'
description: Configuration for scalable_matrix_with_tiered_pricing pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- scalable_matrix_with_tiered_pricing_config
- name
- item_id
- cadence
title: NewSubscriptionScalableMatrixWithTieredPricingPrice
NewSubscriptionCumulativeGroupedBulkPrice:
properties:
model_type:
type: string
enum:
- cumulative_grouped_bulk
title: Model Type
description: The pricing model type
cumulative_grouped_bulk_config:
$ref: '#/components/schemas/CumulativeGroupedBulkConfig'
description: Configuration for cumulative_grouped_bulk pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- cumulative_grouped_bulk_config
- name
- item_id
- cadence
title: NewSubscriptionCumulativeGroupedBulkPrice
NewSubscriptionCumulativeGroupedAllocationPrice:
properties:
model_type:
type: string
enum:
- cumulative_grouped_allocation
title: Model Type
description: The pricing model type
cumulative_grouped_allocation_config:
$ref: '#/components/schemas/CumulativeGroupedAllocationConfig'
description: Configuration for cumulative_grouped_allocation pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- cumulative_grouped_allocation_config
- name
- item_id
- cadence
title: NewSubscriptionCumulativeGroupedAllocationPrice
NewSubscriptionDailyCreditAllowancePrice:
properties:
model_type:
type: string
enum:
- daily_credit_allowance
title: Model Type
description: The pricing model type
daily_credit_allowance_config:
$ref: '#/components/schemas/DailyCreditAllowanceConfig'
description: Configuration for daily_credit_allowance pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- daily_credit_allowance_config
- name
- item_id
- cadence
title: NewSubscriptionDailyCreditAllowancePrice
NewSubscriptionMeteredAllowancePrice:
properties:
model_type:
type: string
enum:
- metered_allowance
title: Model Type
description: The pricing model type
metered_allowance_config:
$ref: '#/components/schemas/MeteredAllowanceConfig'
description: Configuration for metered_allowance pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- metered_allowance_config
- name
- item_id
- cadence
title: NewSubscriptionMeteredAllowancePrice
NewSubscriptionMinimumCompositePrice:
properties:
model_type:
type: string
enum:
- minimum_composite
title: Model Type
description: The pricing model type
minimum_composite_config:
$ref: '#/components/schemas/MinimumCompositeConfig'
description: Configuration for minimum_composite pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- minimum_composite_config
- name
- item_id
- cadence
title: NewSubscriptionMinimumCompositePrice
NewSubscriptionPercentCompositePrice:
properties:
model_type:
type: string
enum:
- percent
title: Model Type
description: The pricing model type
percent_config:
$ref: '#/components/schemas/PercentCompositeConfig'
description: Configuration for percent pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- percent_config
- name
- item_id
- cadence
title: NewSubscriptionPercentCompositePrice
NewSubscriptionEventOutputPrice:
properties:
model_type:
type: string
enum:
- event_output
title: Model Type
description: The pricing model type
event_output_config:
$ref: '#/components/schemas/EventOutputConfig'
description: Configuration for event_output pricing
metadata:
oneOf:
- additionalProperties:
oneOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Metadata
description: >-
User-specified key/value pairs for the resource. Individual keys can
be removed by setting the value to `null`, and the entire metadata
mapping can be cleared by setting `metadata` to `null`.
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
description: An alias for the price.
name:
type: string
title: Name
description: The name of the price.
examples:
- Annual fee
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/NewDimensionalPriceConfiguration'
- type: 'null'
description: 'For dimensional price: specifies a price group and dimension values'
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
description: The ID of the license type to associate with this price.
billable_metric_id:
oneOf:
- type: string
- type: 'null'
title: Billable Metric Id
description: >-
The id of the billable metric for the price. Only needed if the
price is usage-based.
item_id:
type: string
title: Item Id
description: The id of the item the price will be associated with.
billed_in_advance:
oneOf:
- type: boolean
- type: 'null'
title: Billed In Advance
description: >-
If the Price represents a fixed cost, the price will be billed
in-advance if this is true, and in-arrears if this is false.
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
description: >-
If the Price represents a fixed cost, this represents the quantity
of units applied.
invoice_grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Invoice Grouping Key
description: The property used to group this price on an invoice
cadence:
type: string
enum:
- annual
- semi_annual
- monthly
- quarterly
- one_time
- custom
title: Cadence
description: The cadence to bill for this price on.
billing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
For custom cadence: specifies the duration of the billing period in
days or months.
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/NewBillingCycleConfiguration'
- type: 'null'
description: >-
Within each billing cycle, specifies the cadence at which invoices
are produced. If unspecified, a single invoice is produced per
billing cycle.
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
description: >-
The per unit conversion rate of the price currency to the invoicing
currency.
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
description: >-
The configuration for the rate of the price currency to the
invoicing currency.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
An ISO 4217 currency string, or custom pricing unit identifier, in
which this price is billed.
reference_id:
oneOf:
- type: string
- type: 'null'
title: Reference Id
description: >-
A transient ID that can be used to reference this price when adding
adjustments in the same API call.
additionalProperties: false
type: object
required:
- model_type
- event_output_config
- name
- item_id
- cadence
title: NewSubscriptionEventOutputPrice
CustomExpiration:
properties:
duration:
type: integer
title: Duration
duration_unit:
type: string
enum:
- day
- month
title: Duration Unit
type: object
required:
- duration
- duration_unit
title: CustomExpiration
BlockPriceFilter:
properties:
field:
type: string
enum:
- item_id
title: Field
description: >-
The property of the price the block applies to. Only item_id is
supported.
operator:
type: string
enum:
- includes
- excludes
title: Operator
description: Should prices that match the filter be included or excluded.
values:
items:
type: string
type: array
uniqueItems: true
title: Values
description: The IDs or values that match this filter.
type: object
required:
- field
- operator
- values
title: BlockPriceFilter
description: A PriceFilter that only allows item_id field for block filters.
NewPercentageDiscount:
properties:
applies_to_price_ids:
oneOf:
- items:
type: string
type: array
uniqueItems: true
- type: 'null'
title: Applies To Price Ids
description: The set of price IDs to which this adjustment applies.
examples:
- - price_1
- price_2
applies_to_item_ids:
oneOf:
- items:
type: string
type: array
uniqueItems: true
- type: 'null'
title: Applies To Item Ids
description: The set of item IDs to which this adjustment applies.
examples:
- - item_1
- item_2
applies_to_all:
oneOf:
- type: boolean
enum:
- true
- type: 'null'
title: Applies To All
description: >-
If set, the adjustment will apply to every price on the
subscription.
filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Filters
description: >-
A list of filters that determine which prices this adjustment will
apply to.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
If set, only prices in the specified currency will have the
adjustment applied.
examples:
- - USD
- JPY
- credits
price_type:
oneOf:
- type: string
enum:
- usage
- fixed_in_advance
- fixed_in_arrears
- fixed
- in_arrears
- type: 'null'
title: Price Type
description: >-
If set, only prices of the specified type will have the adjustment
applied.
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
When false, this adjustment will be applied to a single price.
Otherwise, it will be applied at the invoice level, possibly to
multiple prices.
default: true
adjustment_type:
type: string
enum:
- percentage_discount
title: Adjustment Type
percentage_discount:
type: number
title: Percentage Discount
ge: 0
le: 1
type: object
required:
- adjustment_type
- percentage_discount
title: NewPercentageDiscount
NewUsageDiscount:
properties:
applies_to_price_ids:
oneOf:
- items:
type: string
type: array
uniqueItems: true
- type: 'null'
title: Applies To Price Ids
description: The set of price IDs to which this adjustment applies.
examples:
- - price_1
- price_2
applies_to_item_ids:
oneOf:
- items:
type: string
type: array
uniqueItems: true
- type: 'null'
title: Applies To Item Ids
description: The set of item IDs to which this adjustment applies.
examples:
- - item_1
- item_2
applies_to_all:
oneOf:
- type: boolean
enum:
- true
- type: 'null'
title: Applies To All
description: >-
If set, the adjustment will apply to every price on the
subscription.
filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Filters
description: >-
A list of filters that determine which prices this adjustment will
apply to.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
If set, only prices in the specified currency will have the
adjustment applied.
examples:
- - USD
- JPY
- credits
price_type:
oneOf:
- type: string
enum:
- usage
- fixed_in_advance
- fixed_in_arrears
- fixed
- in_arrears
- type: 'null'
title: Price Type
description: >-
If set, only prices of the specified type will have the adjustment
applied.
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
When false, this adjustment will be applied to a single price.
Otherwise, it will be applied at the invoice level, possibly to
multiple prices.
default: true
adjustment_type:
type: string
enum:
- usage_discount
title: Adjustment Type
usage_discount:
type: number
title: Usage Discount
type: object
required:
- adjustment_type
- usage_discount
title: NewUsageDiscount
NewAmountDiscount:
properties:
applies_to_price_ids:
oneOf:
- items:
type: string
type: array
uniqueItems: true
- type: 'null'
title: Applies To Price Ids
description: The set of price IDs to which this adjustment applies.
examples:
- - price_1
- price_2
applies_to_item_ids:
oneOf:
- items:
type: string
type: array
uniqueItems: true
- type: 'null'
title: Applies To Item Ids
description: The set of item IDs to which this adjustment applies.
examples:
- - item_1
- item_2
applies_to_all:
oneOf:
- type: boolean
enum:
- true
- type: 'null'
title: Applies To All
description: >-
If set, the adjustment will apply to every price on the
subscription.
filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Filters
description: >-
A list of filters that determine which prices this adjustment will
apply to.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
If set, only prices in the specified currency will have the
adjustment applied.
examples:
- - USD
- JPY
- credits
price_type:
oneOf:
- type: string
enum:
- usage
- fixed_in_advance
- fixed_in_arrears
- fixed
- in_arrears
- type: 'null'
title: Price Type
description: >-
If set, only prices of the specified type will have the adjustment
applied.
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
When false, this adjustment will be applied to a single price.
Otherwise, it will be applied at the invoice level, possibly to
multiple prices.
default: true
adjustment_type:
type: string
enum:
- amount_discount
title: Adjustment Type
amount_discount:
type: string
title: Amount Discount
type: object
required:
- adjustment_type
- amount_discount
title: NewAmountDiscount
NewMinimum:
properties:
applies_to_price_ids:
oneOf:
- items:
type: string
type: array
uniqueItems: true
- type: 'null'
title: Applies To Price Ids
description: The set of price IDs to which this adjustment applies.
examples:
- - price_1
- price_2
applies_to_item_ids:
oneOf:
- items:
type: string
type: array
uniqueItems: true
- type: 'null'
title: Applies To Item Ids
description: The set of item IDs to which this adjustment applies.
examples:
- - item_1
- item_2
applies_to_all:
oneOf:
- type: boolean
enum:
- true
- type: 'null'
title: Applies To All
description: >-
If set, the adjustment will apply to every price on the
subscription.
filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Filters
description: >-
A list of filters that determine which prices this adjustment will
apply to.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
If set, only prices in the specified currency will have the
adjustment applied.
examples:
- - USD
- JPY
- credits
price_type:
oneOf:
- type: string
enum:
- usage
- fixed_in_advance
- fixed_in_arrears
- fixed
- in_arrears
- type: 'null'
title: Price Type
description: >-
If set, only prices of the specified type will have the adjustment
applied.
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
When false, this adjustment will be applied to a single price.
Otherwise, it will be applied at the invoice level, possibly to
multiple prices.
default: true
adjustment_type:
type: string
enum:
- minimum
title: Adjustment Type
minimum_amount:
type: string
title: Minimum Amount
item_id:
type: string
title: Item Id
description: The item ID that revenue from this minimum will be attributed to.
type: object
required:
- adjustment_type
- minimum_amount
- item_id
title: NewMinimum
NewMaximum:
properties:
applies_to_price_ids:
oneOf:
- items:
type: string
type: array
uniqueItems: true
- type: 'null'
title: Applies To Price Ids
description: The set of price IDs to which this adjustment applies.
examples:
- - price_1
- price_2
applies_to_item_ids:
oneOf:
- items:
type: string
type: array
uniqueItems: true
- type: 'null'
title: Applies To Item Ids
description: The set of item IDs to which this adjustment applies.
examples:
- - item_1
- item_2
applies_to_all:
oneOf:
- type: boolean
enum:
- true
- type: 'null'
title: Applies To All
description: >-
If set, the adjustment will apply to every price on the
subscription.
filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Filters
description: >-
A list of filters that determine which prices this adjustment will
apply to.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
If set, only prices in the specified currency will have the
adjustment applied.
examples:
- - USD
- JPY
- credits
price_type:
oneOf:
- type: string
enum:
- usage
- fixed_in_advance
- fixed_in_arrears
- fixed
- in_arrears
- type: 'null'
title: Price Type
description: >-
If set, only prices of the specified type will have the adjustment
applied.
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
When false, this adjustment will be applied to a single price.
Otherwise, it will be applied at the invoice level, possibly to
multiple prices.
default: true
adjustment_type:
type: string
enum:
- maximum
title: Adjustment Type
maximum_amount:
type: string
title: Maximum Amount
type: object
required:
- adjustment_type
- maximum_amount
title: NewMaximum
NewTieredPercentageDiscount:
properties:
applies_to_price_ids:
oneOf:
- items:
type: string
type: array
uniqueItems: true
- type: 'null'
title: Applies To Price Ids
description: The set of price IDs to which this adjustment applies.
examples:
- - price_1
- price_2
applies_to_item_ids:
oneOf:
- items:
type: string
type: array
uniqueItems: true
- type: 'null'
title: Applies To Item Ids
description: The set of item IDs to which this adjustment applies.
examples:
- - item_1
- item_2
applies_to_all:
oneOf:
- type: boolean
enum:
- true
- type: 'null'
title: Applies To All
description: >-
If set, the adjustment will apply to every price on the
subscription.
filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Filters
description: >-
A list of filters that determine which prices this adjustment will
apply to.
currency:
oneOf:
- type: string
- type: 'null'
title: Currency
description: >-
If set, only prices in the specified currency will have the
adjustment applied.
examples:
- - USD
- JPY
- credits
price_type:
oneOf:
- type: string
enum:
- usage
- fixed_in_advance
- fixed_in_arrears
- fixed
- in_arrears
- type: 'null'
title: Price Type
description: >-
If set, only prices of the specified type will have the adjustment
applied.
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
When false, this adjustment will be applied to a single price.
Otherwise, it will be applied at the invoice level, possibly to
multiple prices.
default: true
adjustment_type:
type: string
enum:
- tiered_percentage_discount
title: Adjustment Type
tiers:
items:
$ref: '#/components/schemas/NewTieredPercentageDiscountTier'
type: array
minItems: 1
title: Tiers
type: object
required:
- adjustment_type
- tiers
title: NewTieredPercentageDiscount
AccountingProvider:
properties:
provider_type:
type: string
enum:
- quickbooks
- netsuite
title: Provider Type
external_provider_id:
oneOf:
- type: string
- type: 'null'
title: External Provider Id
type: object
required:
- provider_type
- external_provider_id
title: AccountingProvider
PaymentConfigurationItem:
properties:
provider_type:
type: string
enum:
- stripe
title: Provider Type
description: The payment provider to configure.
excluded_payment_method_types:
items:
type: string
type: array
title: Excluded Payment Method Types
description: >-
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: []
default_shared_payment_token:
oneOf:
- type: string
- type: 'null'
title: Default Shared Payment Token
description: >-
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.
type: object
required:
- provider_type
title: PaymentConfigurationItem
CustomerMinified:
properties:
id:
type: string
title: Id
external_customer_id:
oneOf:
- type: string
- type: 'null'
title: External Customer Id
type: object
required:
- id
- external_customer_id
title: CustomerMinified
PercentageDiscount:
properties:
discount_type:
type: string
enum:
- percentage
title: Discount Type
applies_to_price_ids:
oneOf:
- items:
type: string
type: array
- type: 'null'
title: Applies To Price Ids
description: >-
List of price_ids that this discount applies to. For plan/plan phase
discounts, this can be a subset of prices.
examples:
- - h74gfhdjvn7ujokd
- 7hfgtgjnbvc3ujkl
filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Filters
description: The filters that determine which prices to apply this discount to.
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
percentage_discount:
type: number
maximum: 1
minimum: 0
title: Percentage Discount
description: >-
Only available if discount_type is `percentage`. This is a number
between 0 and 1.
examples:
- 0.15
type: object
required:
- discount_type
- percentage_discount
title: PercentageDiscount
TrialDiscount:
properties:
discount_type:
type: string
enum:
- trial
title: Discount Type
applies_to_price_ids:
oneOf:
- items:
type: string
type: array
- type: 'null'
title: Applies To Price Ids
description: >-
List of price_ids that this discount applies to. For plan/plan phase
discounts, this can be a subset of prices.
examples:
- - h74gfhdjvn7ujokd
- 7hfgtgjnbvc3ujkl
filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Filters
description: The filters that determine which prices to apply this discount to.
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
trial_amount_discount:
oneOf:
- type: string
- type: 'null'
title: Trial Amount Discount
description: Only available if discount_type is `trial`
trial_percentage_discount:
oneOf:
- type: number
- type: 'null'
title: Trial Percentage Discount
description: Only available if discount_type is `trial`
type: object
required:
- discount_type
title: TrialDiscount
UsageDiscount:
properties:
discount_type:
type: string
enum:
- usage
title: Discount Type
applies_to_price_ids:
oneOf:
- items:
type: string
type: array
- type: 'null'
title: Applies To Price Ids
description: >-
List of price_ids that this discount applies to. For plan/plan phase
discounts, this can be a subset of prices.
examples:
- - h74gfhdjvn7ujokd
- 7hfgtgjnbvc3ujkl
filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Filters
description: The filters that determine which prices to apply this discount to.
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
usage_discount:
type: number
title: Usage Discount
description: >-
Only available if discount_type is `usage`. Number of usage units
that this discount is for
type: object
required:
- discount_type
- usage_discount
title: UsageDiscount
AmountDiscount:
properties:
discount_type:
type: string
enum:
- amount
title: Discount Type
applies_to_price_ids:
oneOf:
- items:
type: string
type: array
- type: 'null'
title: Applies To Price Ids
description: >-
List of price_ids that this discount applies to. For plan/plan phase
discounts, this can be a subset of prices.
examples:
- - h74gfhdjvn7ujokd
- 7hfgtgjnbvc3ujkl
filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Filters
description: The filters that determine which prices to apply this discount to.
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
amount_discount:
type: string
title: Amount Discount
description: Only available if discount_type is `amount`.
type: object
required:
- discount_type
- amount_discount
title: AmountDiscount
TieredPercentageDiscount:
properties:
discount_type:
type: string
enum:
- tiered_percentage
title: Discount Type
applies_to_price_ids:
oneOf:
- items:
type: string
type: array
- type: 'null'
title: Applies To Price Ids
description: >-
List of price_ids that this discount applies to. For plan/plan phase
discounts, this can be a subset of prices.
examples:
- - h74gfhdjvn7ujokd
- 7hfgtgjnbvc3ujkl
filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Filters
description: The filters that determine which prices to apply this discount to.
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
tiers:
items:
$ref: '#/components/schemas/PercentageTier'
type: array
title: Tiers
description: >-
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).
type: object
required:
- discount_type
- tiers
title: TieredPercentageDiscount
UnitPrice:
properties:
model_type:
type: string
enum:
- unit
title: Model Type
description: The pricing model type
unit_config:
$ref: '#/components/schemas/UnitConfig'
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- unit_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: UnitPrice
TieredPrice:
properties:
model_type:
type: string
enum:
- tiered
title: Model Type
description: The pricing model type
tiered_config:
$ref: '#/components/schemas/TieredConfig'
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- tiered_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: TieredPrice
BulkPrice:
properties:
model_type:
type: string
enum:
- bulk
title: Model Type
description: The pricing model type
bulk_config:
$ref: '#/components/schemas/BulkConfig'
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- bulk_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: BulkPrice
BulkWithFiltersPrice:
properties:
model_type:
type: string
enum:
- bulk_with_filters
title: Model Type
description: The pricing model type
bulk_with_filters_config:
$ref: '#/components/schemas/BulkWithFiltersConfig'
description: Configuration for bulk_with_filters pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- bulk_with_filters_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: BulkWithFiltersPrice
PackagePrice:
properties:
model_type:
type: string
enum:
- package
title: Model Type
description: The pricing model type
package_config:
$ref: '#/components/schemas/PackageConfig'
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- package_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: PackagePrice
MatrixPrice:
properties:
model_type:
type: string
enum:
- matrix
title: Model Type
description: The pricing model type
matrix_config:
$ref: '#/components/schemas/MatrixConfig'
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- matrix_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: MatrixPrice
ThresholdTotalAmountPrice:
properties:
model_type:
type: string
enum:
- threshold_total_amount
title: Model Type
description: The pricing model type
threshold_total_amount_config:
$ref: '#/components/schemas/ThresholdTotalAmountConfig'
description: Configuration for threshold_total_amount pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- threshold_total_amount_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: ThresholdTotalAmountPrice
TieredPackagePrice:
properties:
model_type:
type: string
enum:
- tiered_package
title: Model Type
description: The pricing model type
tiered_package_config:
$ref: '#/components/schemas/TieredPackagePricingConfig'
description: Configuration for tiered_package pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- tiered_package_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: TieredPackagePrice
TieredWithMinimumPrice:
properties:
model_type:
type: string
enum:
- tiered_with_minimum
title: Model Type
description: The pricing model type
tiered_with_minimum_config:
$ref: '#/components/schemas/TieredPricingWithMinimumConfig'
description: Configuration for tiered_with_minimum pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- tiered_with_minimum_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: TieredWithMinimumPrice
GroupedTieredPrice:
properties:
model_type:
type: string
enum:
- grouped_tiered
title: Model Type
description: The pricing model type
grouped_tiered_config:
$ref: '#/components/schemas/GroupedTieredConfig'
description: Configuration for grouped_tiered pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- grouped_tiered_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: GroupedTieredPrice
TieredPackageWithMinimumPrice:
properties:
model_type:
type: string
enum:
- tiered_package_with_minimum
title: Model Type
description: The pricing model type
tiered_package_with_minimum_config:
$ref: '#/components/schemas/TieredPackagePricingWithMinimumConfig'
description: Configuration for tiered_package_with_minimum pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- tiered_package_with_minimum_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: TieredPackageWithMinimumPrice
PackageWithAllocationPrice:
properties:
model_type:
type: string
enum:
- package_with_allocation
title: Model Type
description: The pricing model type
package_with_allocation_config:
$ref: '#/components/schemas/PackageWithAllocationConfig'
description: Configuration for package_with_allocation pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- package_with_allocation_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: PackageWithAllocationPrice
UnitWithPercentPrice:
properties:
model_type:
type: string
enum:
- unit_with_percent
title: Model Type
description: The pricing model type
unit_with_percent_config:
$ref: '#/components/schemas/UnitWithPercentConfig'
description: Configuration for unit_with_percent pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- unit_with_percent_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: UnitWithPercentPrice
MatrixWithAllocationPrice:
properties:
model_type:
type: string
enum:
- matrix_with_allocation
title: Model Type
description: The pricing model type
matrix_with_allocation_config:
$ref: '#/components/schemas/MatrixWithAllocationConfig'
description: Configuration for matrix_with_allocation pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- matrix_with_allocation_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: MatrixWithAllocationPrice
MatrixWithThresholdDiscountsPrice:
properties:
model_type:
type: string
enum:
- matrix_with_threshold_discounts
title: Model Type
description: The pricing model type
matrix_with_threshold_discounts_config:
$ref: '#/components/schemas/MatrixWithThresholdDiscountsConfig'
description: Configuration for matrix_with_threshold_discounts pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- matrix_with_threshold_discounts_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: MatrixWithThresholdDiscountsPrice
TieredWithProrationPrice:
properties:
model_type:
type: string
enum:
- tiered_with_proration
title: Model Type
description: The pricing model type
tiered_with_proration_config:
$ref: '#/components/schemas/TieredWithProrationConfig'
description: Configuration for tiered_with_proration pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- tiered_with_proration_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: TieredWithProrationPrice
UnitWithProrationPrice:
properties:
model_type:
type: string
enum:
- unit_with_proration
title: Model Type
description: The pricing model type
unit_with_proration_config:
$ref: '#/components/schemas/UnitWithProrationConfig'
description: Configuration for unit_with_proration pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- unit_with_proration_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: UnitWithProrationPrice
GroupedAllocationPrice:
properties:
model_type:
type: string
enum:
- grouped_allocation
title: Model Type
description: The pricing model type
grouped_allocation_config:
$ref: '#/components/schemas/GroupedAllocationConfig'
description: Configuration for grouped_allocation pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- grouped_allocation_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: GroupedAllocationPrice
BulkWithProrationPrice:
properties:
model_type:
type: string
enum:
- bulk_with_proration
title: Model Type
description: The pricing model type
bulk_with_proration_config:
$ref: '#/components/schemas/BulkWithProrationConfig'
description: Configuration for bulk_with_proration pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- bulk_with_proration_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: BulkWithProrationPrice
GroupedWithProratedMinimumPrice:
properties:
model_type:
type: string
enum:
- grouped_with_prorated_minimum
title: Model Type
description: The pricing model type
grouped_with_prorated_minimum_config:
$ref: '#/components/schemas/GroupedWithProratedMinimumConfig'
description: Configuration for grouped_with_prorated_minimum pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- grouped_with_prorated_minimum_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: GroupedWithProratedMinimumPrice
GroupedWithMeteredMinimumPrice:
properties:
model_type:
type: string
enum:
- grouped_with_metered_minimum
title: Model Type
description: The pricing model type
grouped_with_metered_minimum_config:
$ref: '#/components/schemas/GroupedWithMeteredMinimumConfig'
description: Configuration for grouped_with_metered_minimum pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- grouped_with_metered_minimum_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: GroupedWithMeteredMinimumPrice
GroupedWithMinMaxThresholdsPrice:
properties:
model_type:
type: string
enum:
- grouped_with_min_max_thresholds
title: Model Type
description: The pricing model type
grouped_with_min_max_thresholds_config:
$ref: '#/components/schemas/GroupedWithMinMaxThresholdsConfig'
description: Configuration for grouped_with_min_max_thresholds pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- grouped_with_min_max_thresholds_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: GroupedWithMinMaxThresholdsPrice
MatrixWithDisplayNamePrice:
properties:
model_type:
type: string
enum:
- matrix_with_display_name
title: Model Type
description: The pricing model type
matrix_with_display_name_config:
$ref: '#/components/schemas/MatrixWithDisplayNameConfig'
description: Configuration for matrix_with_display_name pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- matrix_with_display_name_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: MatrixWithDisplayNamePrice
GroupedTieredPackagePrice:
properties:
model_type:
type: string
enum:
- grouped_tiered_package
title: Model Type
description: The pricing model type
grouped_tiered_package_config:
$ref: '#/components/schemas/GroupedTieredPackagePricingConfig'
description: Configuration for grouped_tiered_package pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- grouped_tiered_package_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: GroupedTieredPackagePrice
MaxGroupTieredPackagePrice:
properties:
model_type:
type: string
enum:
- max_group_tiered_package
title: Model Type
description: The pricing model type
max_group_tiered_package_config:
$ref: '#/components/schemas/MaxGroupTieredPackageConfig'
description: Configuration for max_group_tiered_package pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- max_group_tiered_package_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: MaxGroupTieredPackagePrice
ScalableMatrixWithUnitPricingPrice:
properties:
model_type:
type: string
enum:
- scalable_matrix_with_unit_pricing
title: Model Type
description: The pricing model type
scalable_matrix_with_unit_pricing_config:
$ref: '#/components/schemas/ScalableMatrixWithUnitPricingConfig'
description: Configuration for scalable_matrix_with_unit_pricing pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- scalable_matrix_with_unit_pricing_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: ScalableMatrixWithUnitPricingPrice
ScalableMatrixWithTieredPricingPrice:
properties:
model_type:
type: string
enum:
- scalable_matrix_with_tiered_pricing
title: Model Type
description: The pricing model type
scalable_matrix_with_tiered_pricing_config:
$ref: '#/components/schemas/ScalableMatrixWithTieredPricingConfig'
description: Configuration for scalable_matrix_with_tiered_pricing pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- scalable_matrix_with_tiered_pricing_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: ScalableMatrixWithTieredPricingPrice
CumulativeGroupedBulkPrice:
properties:
model_type:
type: string
enum:
- cumulative_grouped_bulk
title: Model Type
description: The pricing model type
cumulative_grouped_bulk_config:
$ref: '#/components/schemas/CumulativeGroupedBulkConfig'
description: Configuration for cumulative_grouped_bulk pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- cumulative_grouped_bulk_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: CumulativeGroupedBulkPrice
CumulativeGroupedAllocationPrice:
properties:
model_type:
type: string
enum:
- cumulative_grouped_allocation
title: Model Type
description: The pricing model type
cumulative_grouped_allocation_config:
$ref: '#/components/schemas/CumulativeGroupedAllocationConfig'
description: Configuration for cumulative_grouped_allocation pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- cumulative_grouped_allocation_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: CumulativeGroupedAllocationPrice
DailyCreditAllowancePrice:
properties:
model_type:
type: string
enum:
- daily_credit_allowance
title: Model Type
description: The pricing model type
daily_credit_allowance_config:
$ref: '#/components/schemas/DailyCreditAllowanceConfig'
description: Configuration for daily_credit_allowance pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- daily_credit_allowance_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: DailyCreditAllowancePrice
MeteredAllowancePrice:
properties:
model_type:
type: string
enum:
- metered_allowance
title: Model Type
description: The pricing model type
metered_allowance_config:
$ref: '#/components/schemas/MeteredAllowanceConfig'
description: Configuration for metered_allowance pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- metered_allowance_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: MeteredAllowancePrice
MinimumCompositePrice:
properties:
model_type:
type: string
enum:
- minimum_composite
title: Model Type
description: The pricing model type
minimum_composite_config:
$ref: '#/components/schemas/MinimumCompositeConfig'
description: Configuration for minimum_composite pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- minimum_composite_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: MinimumCompositePrice
PercentCompositePrice:
properties:
model_type:
type: string
enum:
- percent
title: Model Type
description: The pricing model type
percent_config:
$ref: '#/components/schemas/PercentCompositeConfig'
description: Configuration for percent pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- percent_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: PercentCompositePrice
EventOutputPrice:
properties:
model_type:
type: string
enum:
- event_output
title: Model Type
description: The pricing model type
event_output_config:
$ref: '#/components/schemas/EventOutputConfig'
description: Configuration for event_output pricing
metadata:
additionalProperties:
type: string
type: object
title: Metadata
description: >-
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:
type: string
title: Id
name:
type: string
title: Name
external_price_id:
oneOf:
- type: string
- type: 'null'
title: External Price Id
replaces_price_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Price Id
description: >-
The price id this price replaces. This price will take the place of
the replaced price in plan version migrations.
price_type:
type: string
enum:
- usage_price
- fixed_price
- composite_price
title: Price Type
created_at:
type: string
format: date-time
title: Created At
cadence:
type: string
enum:
- one_time
- monthly
- quarterly
- semi_annual
- annual
- custom
title: Cadence
billing_mode:
type: string
enum:
- in_advance
- in_arrear
title: Billing Mode
billing_cycle_configuration:
$ref: '#/components/schemas/BillingCycleConfiguration'
invoicing_cycle_configuration:
oneOf:
- $ref: '#/components/schemas/BillingCycleConfiguration'
- type: 'null'
billable_metric:
oneOf:
- $ref: '#/components/schemas/BillableMetricTiny'
- type: 'null'
dimensional_price_configuration:
oneOf:
- $ref: '#/components/schemas/DimensionalPriceConfiguration'
- type: 'null'
fixed_price_quantity:
oneOf:
- type: number
- type: 'null'
title: Fixed Price Quantity
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
currency:
type: string
title: Currency
conversion_rate:
oneOf:
- type: number
- type: 'null'
title: Conversion Rate
conversion_rate_config:
oneOf:
- $ref: '#/components/schemas/ConversionRateConfig'
- type: 'null'
item:
$ref: '#/components/schemas/ItemSlim'
credit_allocation:
oneOf:
- $ref: '#/components/schemas/Allocation'
- type: 'null'
composite_price_filters:
oneOf:
- items:
$ref: '#/components/schemas/PriceFilter'
type: array
- type: 'null'
title: Composite Price Filters
invoice_grouping_key:
oneOf:
- type: string
- type: 'null'
title: Invoice Grouping Key
license_type:
oneOf:
- $ref: '#/components/schemas/LicenseType'
- type: 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
deprecated: true
minimum:
oneOf:
- $ref: '#/components/schemas/Minimum'
- type: 'null'
deprecated: true
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
deprecated: true
maximum:
oneOf:
- $ref: '#/components/schemas/Maximum'
- type: 'null'
deprecated: true
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
deprecated: true
type: object
required:
- model_type
- event_output_config
- metadata
- id
- name
- external_price_id
- replaces_price_id
- price_type
- created_at
- cadence
- billing_mode
- billing_cycle_configuration
- invoicing_cycle_configuration
- billable_metric
- fixed_price_quantity
- plan_phase_order
- currency
- conversion_rate
- conversion_rate_config
- item
- credit_allocation
- composite_price_filters
- invoice_grouping_key
- discount
- minimum
- minimum_amount
- maximum
- maximum_amount
title: EventOutputPrice
PlanPhaseUsageDiscountAdjustment:
properties:
id:
type: string
title: Id
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
True for adjustments that apply to an entire invoice, false for
adjustments that apply to only one price.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: The filters that determine which prices to apply this adjustment to.
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
description: The price IDs that this adjustment applies to.
deprecated: true
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
description: The reason for the adjustment.
replaces_adjustment_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Adjustment Id
description: >-
The adjustment id this adjustment replaces. This adjustment will
take the place of the replaced adjustment in plan version
migrations.
adjustment_type:
type: string
enum:
- usage_discount
title: Adjustment Type
usage_discount:
type: number
title: Usage Discount
description: >-
The number of usage units by which to discount the price this
adjustment applies to in a given billing period.
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
description: The plan phase in which this adjustment is active.
type: object
required:
- id
- is_invoice_level
- filters
- applies_to_price_ids
- reason
- replaces_adjustment_id
- adjustment_type
- usage_discount
- plan_phase_order
title: PlanPhaseUsageDiscountAdjustment
PlanPhaseAmountDiscountAdjustment:
properties:
id:
type: string
title: Id
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
True for adjustments that apply to an entire invoice, false for
adjustments that apply to only one price.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: The filters that determine which prices to apply this adjustment to.
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
description: The price IDs that this adjustment applies to.
deprecated: true
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
description: The reason for the adjustment.
replaces_adjustment_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Adjustment Id
description: >-
The adjustment id this adjustment replaces. This adjustment will
take the place of the replaced adjustment in plan version
migrations.
adjustment_type:
type: string
enum:
- amount_discount
title: Adjustment Type
amount_discount:
type: string
title: Amount Discount
description: >-
The amount by which to discount the prices this adjustment applies
to in a given billing period.
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
description: The plan phase in which this adjustment is active.
type: object
required:
- id
- is_invoice_level
- filters
- applies_to_price_ids
- reason
- replaces_adjustment_id
- adjustment_type
- amount_discount
- plan_phase_order
title: PlanPhaseAmountDiscountAdjustment
PlanPhasePercentageDiscountAdjustment:
properties:
id:
type: string
title: Id
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
True for adjustments that apply to an entire invoice, false for
adjustments that apply to only one price.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: The filters that determine which prices to apply this adjustment to.
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
description: The price IDs that this adjustment applies to.
deprecated: true
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
description: The reason for the adjustment.
replaces_adjustment_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Adjustment Id
description: >-
The adjustment id this adjustment replaces. This adjustment will
take the place of the replaced adjustment in plan version
migrations.
adjustment_type:
type: string
enum:
- percentage_discount
title: Adjustment Type
percentage_discount:
type: number
maximum: 1
minimum: 0
title: Percentage Discount
description: >-
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:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
description: The plan phase in which this adjustment is active.
type: object
required:
- id
- is_invoice_level
- filters
- applies_to_price_ids
- reason
- replaces_adjustment_id
- adjustment_type
- percentage_discount
- plan_phase_order
title: PlanPhasePercentageDiscountAdjustment
PlanPhaseTieredPercentageDiscountAdjustment:
properties:
id:
type: string
title: Id
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
True for adjustments that apply to an entire invoice, false for
adjustments that apply to only one price.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: The filters that determine which prices to apply this adjustment to.
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
description: The price IDs that this adjustment applies to.
deprecated: true
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
description: The reason for the adjustment.
replaces_adjustment_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Adjustment Id
description: >-
The adjustment id this adjustment replaces. This adjustment will
take the place of the replaced adjustment in plan version
migrations.
adjustment_type:
type: string
enum:
- tiered_percentage_discount
title: Adjustment Type
tiers:
items:
$ref: '#/components/schemas/PercentageTier'
type: array
title: Tiers
description: >-
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:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
description: The plan phase in which this adjustment is active.
type: object
required:
- id
- is_invoice_level
- filters
- applies_to_price_ids
- reason
- replaces_adjustment_id
- adjustment_type
- tiers
- plan_phase_order
title: PlanPhaseTieredPercentageDiscountAdjustment
PlanPhaseMinimumAdjustment:
properties:
id:
type: string
title: Id
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
True for adjustments that apply to an entire invoice, false for
adjustments that apply to only one price.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: The filters that determine which prices to apply this adjustment to.
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
description: The price IDs that this adjustment applies to.
deprecated: true
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
description: The reason for the adjustment.
replaces_adjustment_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Adjustment Id
description: >-
The adjustment id this adjustment replaces. This adjustment will
take the place of the replaced adjustment in plan version
migrations.
adjustment_type:
type: string
enum:
- minimum
title: Adjustment Type
minimum_amount:
type: string
title: Minimum Amount
description: >-
The minimum amount to charge in a given billing period for the
prices this adjustment applies to.
item_id:
type: string
title: Item Id
description: The item ID that revenue from this minimum will be attributed to.
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
description: The plan phase in which this adjustment is active.
type: object
required:
- id
- is_invoice_level
- filters
- applies_to_price_ids
- reason
- replaces_adjustment_id
- adjustment_type
- minimum_amount
- item_id
- plan_phase_order
title: PlanPhaseMinimumAdjustment
PlanPhaseMaximumAdjustment:
properties:
id:
type: string
title: Id
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
True for adjustments that apply to an entire invoice, false for
adjustments that apply to only one price.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: The filters that determine which prices to apply this adjustment to.
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
description: The price IDs that this adjustment applies to.
deprecated: true
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
description: The reason for the adjustment.
replaces_adjustment_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Adjustment Id
description: >-
The adjustment id this adjustment replaces. This adjustment will
take the place of the replaced adjustment in plan version
migrations.
adjustment_type:
type: string
enum:
- maximum
title: Adjustment Type
maximum_amount:
type: string
title: Maximum Amount
description: >-
The maximum amount to charge in a given billing period for the
prices this adjustment applies to.
plan_phase_order:
oneOf:
- type: integer
- type: 'null'
title: Plan Phase Order
description: The plan phase in which this adjustment is active.
type: object
required:
- id
- is_invoice_level
- filters
- applies_to_price_ids
- reason
- replaces_adjustment_id
- adjustment_type
- maximum_amount
- plan_phase_order
title: PlanPhaseMaximumAdjustment
CreditNoteDiscount:
properties:
discount_type:
type: string
enum:
- percentage
title: Discount Type
percentage_discount:
type: number
title: Percentage Discount
amount_applied:
type: string
title: Amount Applied
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
applies_to_prices:
oneOf:
- items:
$ref: '#/components/schemas/CreditNoteDiscountAppliesToPrice'
type: array
- type: 'null'
title: Applies To Prices
type: object
required:
- discount_type
- percentage_discount
- amount_applied
title: CreditNoteDiscount
CreditNoteLineItem:
properties:
id:
type: string
title: Id
description: The Orb id of this resource.
name:
type: string
title: Name
description: The name of the corresponding invoice line item.
subtotal:
type: string
title: Subtotal
description: >-
The amount of the line item, excluding any line item minimums and
discounts.
amount:
type: string
title: Amount
description: >-
The amount of the line item, including any line item minimums and
discounts.
quantity:
oneOf:
- type: number
- type: 'null'
title: Quantity
description: An optional quantity credited.
discounts:
items:
$ref: '#/components/schemas/CreditNoteLineItemDiscount'
type: array
title: Discounts
description: Any line item discounts from the invoice's line item.
default: []
tax_amounts:
items:
$ref: '#/components/schemas/TaxAmount'
type: array
title: Tax Amounts
description: Any tax amounts applied onto the line item.
item_id:
type: string
title: Item Id
description: The id of the item associated with this line item.
start_time_inclusive:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Start Time Inclusive
description: The start time of the service period for this credit note line item.
end_time_exclusive:
oneOf:
- type: string
format: date-time
- type: 'null'
title: End Time Exclusive
description: The end time of the service period for this credit note line item.
type: object
required:
- id
- name
- subtotal
- amount
- quantity
- tax_amounts
- item_id
title: CreditNoteLineItem
AutoCollection:
properties:
next_attempt_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Next Attempt At
description: >-
If the invoice is scheduled for auto-collection, this field will
reflect when the next attempt will occur. If dunning has been
exhausted, or auto-collection is not enabled for this invoice, this
field will be `null`.
previously_attempted_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Previously Attempted At
description: >-
If Orb has ever attempted payment auto-collection for this invoice,
this field will reflect when that attempt occurred. In conjunction
with `next_attempt_at`, this can be used to tell whether the invoice
is currently in dunning (that is, `previously_attempted_at` is
non-null, and `next_attempt_time` is non-null), or if dunning has
been exhausted (`previously_attempted_at` is non-null, but
`next_attempt_time` is null).
enabled:
oneOf:
- type: boolean
- type: 'null'
title: Enabled
description: True only if auto-collection is enabled for this invoice.
num_attempts:
oneOf:
- type: integer
- type: 'null'
title: Num Attempts
description: Number of auto-collection payment attempts.
type: object
required:
- next_attempt_at
- previously_attempted_at
- enabled
- num_attempts
title: AutoCollection
SubscriptionMinified:
properties:
id:
type: string
title: Id
examples:
- VDGsT23osdLb84KD
type: object
required:
- id
title: SubscriptionMinified
CustomerBalanceTransaction:
properties:
id:
type: string
title: Id
description: A unique id for this transaction.
examples:
- cgZa3SXcsPTVyC4Y
created_at:
type: string
format: date-time
title: Created At
description: The creation time of this transaction.
examples:
- '2022-05-01T07:01:31+00:00'
starting_balance:
type: string
title: Starting Balance
description: >-
The original value of the customer's balance prior to the
transaction, in the customer's currency.
examples:
- '33.00'
ending_balance:
type: string
title: Ending Balance
description: >-
The new value of the customer's balance prior to the transaction, in
the customer's currency.
examples:
- '22.00'
amount:
type: string
title: Amount
description: The value of the amount changed in the transaction.
examples:
- '11.00'
action:
type: string
enum:
- applied_to_invoice
- manual_adjustment
- prorated_refund
- revert_prorated_refund
- return_from_voiding
- credit_note_applied
- credit_note_voided
- overpayment_refund
- external_payment
- small_invoice_carryover
title: Action
description:
oneOf:
- type: string
- type: 'null'
title: Description
description: >-
An optional description provided for manual customer balance
adjustments.
examples:
- An optional description
invoice:
oneOf:
- $ref: '#/components/schemas/InvoiceTiny'
- type: 'null'
type:
type: string
enum:
- increment
- decrement
title: Type
credit_note:
oneOf:
- $ref: '#/components/schemas/CreditNoteTiny'
- type: 'null'
type: object
required:
- id
- created_at
- starting_balance
- ending_balance
- amount
- action
- description
- invoice
- type
- credit_note
title: CustomerBalanceTransaction
CreditNoteSummary:
properties:
id:
type: string
title: Id
credit_note_number:
type: string
title: Credit Note Number
reason:
type: string
title: Reason
total:
type: string
title: Total
voided_at:
oneOf:
- type: string
format: date-time
- type: 'null'
title: Voided At
description: >-
If the credit note has a status of `void`, this gives a timestamp
when the credit note was voided.
examples:
- '2022-05-01T07:01:31+00:00'
type:
type: string
title: Type
memo:
oneOf:
- type: string
- type: 'null'
title: Memo
description: An optional memo supplied on the credit note.
type: object
required:
- id
- credit_note_number
- reason
- total
- voided_at
- type
- memo
title: CreditNoteSummary
PaymentAttempt:
properties:
id:
type: string
title: Id
description: The ID of the payment attempt.
payment_provider:
oneOf:
- type: string
enum:
- stripe
- adyen
- type: 'null'
title: Payment Provider
description: The payment provider that attempted to collect the payment.
payment_provider_id:
oneOf:
- type: string
- type: 'null'
title: Payment Provider Id
description: The ID of the payment attempt in the payment provider.
amount:
type: string
title: Amount
description: The amount of the payment attempt.
succeeded:
type: boolean
title: Succeeded
description: Whether the payment attempt succeeded.
created_at:
type: string
format: date-time
title: Created At
description: The time at which the payment attempt was created.
receipt_pdf:
oneOf:
- type: string
- type: 'null'
title: Receipt Pdf
description: >-
URL to the downloadable PDF version of the receipt. This field will
be `null` for payment attempts that did not succeed.
examples:
- >-
https://assets.withorb.com/receipt/rUHdhmg45vY45DX/qEAeuYePaphGMdFb
type: object
required:
- id
- payment_provider
- payment_provider_id
- amount
- succeeded
- created_at
- receipt_pdf
title: PaymentAttempt
DEPRECATED_InvoiceLevelDiscount:
title: DEPRECATED_InvoiceLevelDiscount
deprecated: true
InvoiceLevelDiscount:
oneOf:
- $ref: '#/components/schemas/PercentageDiscount'
- $ref: '#/components/schemas/AmountDiscount'
- $ref: '#/components/schemas/TrialDiscount'
- $ref: '#/components/schemas/TieredPercentageDiscount'
discriminator:
propertyName: discount_type
mapping:
amount:
$ref: '#/components/schemas/AmountDiscount'
percentage:
$ref: '#/components/schemas/PercentageDiscount'
tiered_percentage:
$ref: '#/components/schemas/TieredPercentageDiscount'
trial:
$ref: '#/components/schemas/TrialDiscount'
InvoiceLineItem:
properties:
amount:
type: string
title: Amount
description: >-
The final amount for a line item after all adjustments and pre paid
credits have been applied.
examples:
- '7.00'
end_date:
type: string
format: date-time
title: End Date
description: >-
The end date of the range of time applied for this line item's
price.
examples:
- '2022-02-01T08:00:00+00:00'
grouping:
oneOf:
- type: string
- type: 'null'
title: Grouping
description: >-
[DEPRECATED] For configured prices that are split by a grouping key,
this will be populated with the key and a value. The `amount` and
`subtotal` will be the values for this particular grouping.
adjustments:
items:
$ref: '#/components/schemas/MonetaryAdjustment'
type: array
title: Adjustments
description: >-
All adjustments applied to the line item in the order they were
applied based on invoice calculations (ie. usage discounts -> amount
discounts -> percentage discounts -> minimums -> maximums).
name:
type: string
title: Name
description: The name of the price associated with this line item.
examples:
- Fixed Fee
quantity:
type: number
title: Quantity
description: >-
Either the fixed fee quantity or the usage during the service
period.
examples:
- 1
start_date:
type: string
format: date-time
title: Start Date
description: >-
The start date of the range of time applied for this line item's
price.
examples:
- '2022-02-01T08:00:00+00:00'
subtotal:
type: string
title: Subtotal
description: The line amount before any adjustments.
examples:
- '9.00'
adjusted_subtotal:
type: string
title: Adjusted Subtotal
description: >-
The line amount after any adjustments and before overage conversion,
credits and partial invoicing.
examples:
- '5.00'
credits_applied:
type: string
title: Credits Applied
description: The number of prepaid credits applied.
examples:
- '6.00'
partially_invoiced_amount:
type: string
title: Partially Invoiced Amount
description: Any amount applied from a partial invoice
examples:
- '4.00'
sub_line_items:
items:
$ref: '#/components/schemas/InvoiceSubLineItem'
type: array
title: Sub Line Items
description: >-
For complex pricing structures, the line item can be broken down
further in `sub_line_items`.
tax_amounts:
items:
$ref: '#/components/schemas/TaxAmount'
type: array
title: Tax Amounts
description: >-
An array of tax rates and their incurred tax amounts. Empty if no
tax integration is configured.
id:
type: string
title: Id
description: A unique ID for this line item.
price:
$ref: '#/components/schemas/Price'
usage_customer_ids:
oneOf:
- items:
type: string
type: array
- type: 'null'
title: Usage Customer Ids
description: >-
A list of customer ids that were used to calculate the usage for
this line item.
filter:
oneOf:
- type: string
- type: 'null'
title: Filter
description: >-
An additional filter that was used to calculate the usage for this
line item.
type: object
required:
- amount
- end_date
- grouping
- adjustments
- name
- quantity
- start_date
- subtotal
- adjusted_subtotal
- credits_applied
- partially_invoiced_amount
- sub_line_items
- tax_amounts
- id
- price
- usage_customer_ids
- filter
title: InvoiceLineItem
UnitConfig:
properties:
unit_amount:
type: string
title: Unit Amount
description: Rate per unit of usage
prorated:
type: boolean
title: Prorated
description: >-
If true, subtotals from this price are prorated based on the service
period
default: false
additionalProperties: false
type: object
required:
- unit_amount
title: UnitConfig
description: Configuration for unit pricing
NewDimensionalPriceConfiguration:
properties:
dimensional_price_group_id:
oneOf:
- type: string
- type: 'null'
title: Dimensional Price Group Id
description: The id of the dimensional price group to include this price in
external_dimensional_price_group_id:
oneOf:
- type: string
- type: 'null'
title: External Dimensional Price Group Id
description: >-
The external id of the dimensional price group to include this price
in
dimension_values:
items:
type: string
type: array
title: Dimension Values
description: >-
The list of dimension values matching (in order) the dimensions of
the price group
additionalProperties: false
type: object
required:
- dimension_values
title: NewDimensionalPriceConfiguration
NewBillingCycleConfiguration:
properties:
duration:
type: integer
title: Duration
description: The duration of the billing period.
duration_unit:
type: string
enum:
- day
- month
title: Duration Unit
description: The unit of billing period duration.
additionalProperties: false
type: object
required:
- duration
- duration_unit
title: NewBillingCycleConfiguration
ConversionRateConfig:
oneOf:
- $ref: '#/components/schemas/UnitConversionRateConfig'
- $ref: '#/components/schemas/TieredConversionRateConfig'
discriminator:
propertyName: conversion_rate_type
mapping:
tiered:
$ref: '#/components/schemas/TieredConversionRateConfig'
unit:
$ref: '#/components/schemas/UnitConversionRateConfig'
TieredConfig:
properties:
tiers:
items:
$ref: '#/components/schemas/Tier'
type: array
minItems: 1
title: Tiers
description: >-
Tiers for rating based on total usage quantities into the specified
tier
prorated:
type: boolean
title: Prorated
description: >-
If true, subtotals from this price are prorated based on the service
period
default: false
additionalProperties: false
type: object
required:
- tiers
title: TieredConfig
description: Configuration for tiered pricing
BulkConfig:
properties:
tiers:
items:
$ref: '#/components/schemas/BulkTier'
type: array
minItems: 1
title: Tiers
description: Bulk tiers for rating based on total usage volume
additionalProperties: false
type: object
required:
- tiers
title: BulkConfig
description: Configuration for bulk pricing
BulkWithFiltersConfig:
properties:
tiers:
items:
$ref: '#/components/schemas/BulkWithFiltersTier'
type: array
minItems: 2
title: Tiers
description: Bulk tiers for rating based on total usage volume
filters:
items:
$ref: '#/components/schemas/FilterRule'
type: array
minItems: 1
title: Filters
description: Property filters to apply (all must match)
additionalProperties: false
type: object
required:
- tiers
- filters
title: BulkWithFiltersConfig
description: >-
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.
PackageConfig:
properties:
package_amount:
type: string
title: Package Amount
description: A currency amount to rate usage by
package_size:
type: integer
minimum: 1
title: Package Size
description: >-
An integer amount to represent package size. For example, 1000 here
would divide usage by 1000 before multiplying by package_amount in
rating
additionalProperties: false
type: object
required:
- package_amount
- package_size
title: PackageConfig
description: Configuration for package pricing
MatrixConfig:
properties:
dimensions:
items:
oneOf:
- type: string
- type: 'null'
type: array
title: Dimensions
description: One or two event property values to evaluate matrix groups by
default_unit_amount:
type: string
title: Default Unit Amount
description: >-
Default per unit rate for any usage not bucketed into a specified
matrix_value
matrix_values:
items:
$ref: '#/components/schemas/MatrixValue'
type: array
minItems: 1
title: Matrix Values
description: Matrix values configuration
additionalProperties: false
type: object
required:
- dimensions
- default_unit_amount
- matrix_values
title: MatrixConfig
description: Configuration for matrix pricing
ThresholdTotalAmountConfig:
properties:
consumption_table:
items:
$ref: '#/components/schemas/TieredTotalThreshold'
type: array
minItems: 2
title: Consumption Table
description: >-
When the quantity consumed passes a provided threshold, the
configured total will be charged
prorate:
oneOf:
- type: boolean
- type: 'null'
title: Prorate
description: If true, the unit price will be prorated to the billing period
default: false
additionalProperties: false
type: object
required:
- consumption_table
title: ThresholdTotalAmountConfig
description: Configuration for tiered total pricing
TieredPackagePricingConfig:
properties:
tiers:
items:
$ref: '#/components/schemas/TieredPackageTierItem'
type: array
minItems: 2
title: Tiers
description: >-
Apply tiered pricing after rounding up the quantity to the package
size. Tiers are defined using exclusive lower bounds. The tier
bounds are defined based on the total quantity rather than the
number of packages, so they must be multiples of the package size.
package_size:
type: string
title: Package Size
additionalProperties: false
type: object
required:
- tiers
- package_size
title: TieredPackagePricingConfig
description: Configuration for tiered package pricing
TieredPricingWithMinimumConfig:
properties:
tiers:
items:
$ref: '#/components/schemas/TieredPricingWithMinimumTierItem'
type: array
minItems: 2
title: Tiers
description: >-
Tiered pricing with a minimum amount dependent on the volume tier.
Tiers are defined using exclusive lower bounds.
hide_zero_amount_tiers:
type: boolean
title: Hide Zero Amount Tiers
description: >-
If true, tiers with an accrued amount of 0 will not be included in
the rating.
prorate:
type: boolean
title: Prorate
description: If true, the unit price will be prorated to the billing period
additionalProperties: false
type: object
required:
- tiers
title: TieredPricingWithMinimumConfig
description: Configuration for tiered pricing with minimum
GroupedTieredConfig:
properties:
tiers:
items:
$ref: '#/components/schemas/GroupedTieredTier'
type: array
minItems: 2
title: Tiers
description: >-
Apply tiered pricing to each segment generated after grouping with
the provided key
grouping_key:
type: string
minLength: 1
title: Grouping Key
description: The billable metric property used to group before tiering
additionalProperties: false
type: object
required:
- tiers
- grouping_key
title: GroupedTieredConfig
description: Configuration for grouped tiered pricing
TieredPackagePricingWithMinimumConfig:
properties:
tiers:
items:
$ref: '#/components/schemas/TieredPackageWithMinimumTierItem'
type: array
minItems: 2
title: Tiers
description: >-
Apply tiered pricing after rounding up the quantity to the package
size. Tiers are defined using exclusive lower bounds.
package_size:
type: number
title: Package Size
additionalProperties: false
type: object
required:
- tiers
- package_size
title: TieredPackagePricingWithMinimumConfig
description: Configuration for tiered package pricing with minimum
PackageWithAllocationConfig:
properties:
package_amount:
type: string
title: Package Amount
package_size:
type: string
title: Package Size
allocation:
type: string
title: Allocation
additionalProperties: false
type: object
required:
- package_amount
- package_size
- allocation
title: PackageWithAllocationConfig
description: Configuration for package pricing with usage allocation
UnitWithPercentConfig:
properties:
unit_amount:
type: string
title: Unit Amount
description: Rate per unit of usage
percent:
type: string
title: Percent
description: What percent, out of 100, of the calculated total to charge
additionalProperties: false
type: object
required:
- unit_amount
- percent
title: UnitWithPercentConfig
description: Configuration for unit pricing with percentage
MatrixWithAllocationConfig:
properties:
dimensions:
items:
oneOf:
- type: string
- type: 'null'
type: array
title: Dimensions
description: One or two event property values to evaluate matrix groups by
default_unit_amount:
type: string
title: Default Unit Amount
description: >-
Default per unit rate for any usage not bucketed into a specified
matrix_value
allocation:
type: string
title: Allocation
description: Usage allocation
matrix_values:
items:
$ref: '#/components/schemas/MatrixWithAllocationValueItem'
type: array
minItems: 1
title: Matrix Values
description: Matrix values configuration
additionalProperties: false
type: object
required:
- dimensions
- default_unit_amount
- allocation
- matrix_values
title: MatrixWithAllocationConfig
description: Configuration for matrix pricing with usage allocation
MatrixWithThresholdDiscountsConfig:
properties:
first_dimension:
type: string
title: First Dimension
description: First matrix dimension key.
second_dimension:
oneOf:
- type: string
- type: 'null'
title: Second Dimension
description: Optional second matrix dimension key.
default_unit_amount:
type: string
title: Default Unit Amount
description: >-
Unit price used for usage that does not match any defined matrix
cell.
matrix_values:
items:
$ref: '#/components/schemas/MatrixCell'
type: array
minItems: 1
title: Matrix Values
description: Per-cell unit prices.
threshold_discount_groups:
items:
$ref: '#/components/schemas/ThresholdDiscountGroup'
type: array
title: Threshold Discount Groups
additionalProperties: false
type: object
required:
- first_dimension
- default_unit_amount
- matrix_values
title: MatrixWithThresholdDiscountsConfig
description: >-
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.
TieredWithProrationConfig:
properties:
tiers:
items:
$ref: '#/components/schemas/TieredWithProrationTier'
type: array
minItems: 1
title: Tiers
description: >-
Tiers for rating based on total usage quantities into the specified
tier with proration
additionalProperties: false
type: object
required:
- tiers
title: TieredWithProrationConfig
description: Configuration for tiered pricing with proration
UnitWithProrationConfig:
properties:
unit_amount:
type: string
title: Unit Amount
description: Rate per unit of usage
additionalProperties: false
type: object
required:
- unit_amount
title: UnitWithProrationConfig
description: Configuration for unit pricing with proration
GroupedAllocationConfig:
properties:
grouping_key:
type: string
minLength: 1
title: Grouping Key
description: >-
How to determine the groups that should each be allocated some
quantity
overage_unit_rate:
type: string
title: Overage Unit Rate
description: Unit rate for post-allocation
allocation:
type: string
title: Allocation
description: Usage allocation per group
additionalProperties: false
type: object
required:
- grouping_key
- overage_unit_rate
- allocation
title: GroupedAllocationConfig
description: Configuration for grouped allocation pricing
BulkWithProrationConfig:
properties:
tiers:
items:
$ref: '#/components/schemas/BulkTierWithProration'
type: array
minItems: 2
title: Tiers
description: Bulk tiers for rating based on total usage volume
additionalProperties: false
type: object
required:
- tiers
title: BulkWithProrationConfig
description: Configuration for bulk pricing with proration
GroupedWithProratedMinimumConfig:
properties:
grouping_key:
type: string
minLength: 1
title: Grouping Key
description: How to determine the groups that should each have a minimum
unit_rate:
type: string
title: Unit Rate
description: The amount to charge per unit
minimum:
type: string
title: Minimum
description: The minimum amount to charge per group
additionalProperties: false
type: object
required:
- grouping_key
- unit_rate
- minimum
title: GroupedWithProratedMinimumConfig
description: Configuration for grouped with prorated minimum pricing
GroupedWithMeteredMinimumConfig:
properties:
grouping_key:
type: string
minLength: 1
title: Grouping Key
description: >-
Used to partition the usage into groups. The minimum amount is
applied to each group.
pricing_key:
type: string
title: Pricing Key
description: Used to determine the unit rate
scaling_key:
type: string
title: Scaling Key
description: Used to determine the unit rate scaling factor
scaling_factors:
items:
$ref: '#/components/schemas/GroupedWithMeteredMinimumScalingFactorItem'
type: array
minItems: 1
title: Scaling Factors
description: Scale the unit rates by the scaling factor.
unit_amounts:
items:
$ref: '#/components/schemas/GroupedWithMeteredMinimumUnitAmountItem'
type: array
minItems: 1
title: Unit Amounts
description: >-
Apply per unit pricing to each pricing value. The minimum amount is
applied any unmatched usage.
minimum_unit_amount:
type: string
title: Minimum Unit Amount
description: The minimum amount to charge per group per unit
additionalProperties: false
type: object
required:
- grouping_key
- pricing_key
- scaling_key
- scaling_factors
- unit_amounts
- minimum_unit_amount
title: GroupedWithMeteredMinimumConfig
description: Configuration for grouped with metered minimum pricing
GroupedWithMinMaxThresholdsConfig:
properties:
grouping_key:
type: string
minLength: 1
title: Grouping Key
description: The event property used to group before applying thresholds
per_unit_rate:
type: string
title: Per Unit Rate
description: The base price charged per group
minimum_charge:
type: string
title: Minimum Charge
description: The minimum amount to charge each group, regardless of usage
maximum_charge:
type: string
title: Maximum Charge
description: The maximum amount to charge each group
additionalProperties: false
type: object
required:
- grouping_key
- per_unit_rate
- minimum_charge
- maximum_charge
title: GroupedWithMinMaxThresholdsConfig
description: Configuration for grouped with minimum and maximum thresholds pricing
MatrixWithDisplayNameConfig:
properties:
dimension:
type: string
title: Dimension
description: Used to determine the unit rate
unit_amounts:
items:
$ref: '#/components/schemas/MatrixWithDisplayNameUnitAmountItem'
type: array
minItems: 1
title: Unit Amounts
description: Apply per unit pricing to each dimension value
additionalProperties: false
type: object
required:
- dimension
- unit_amounts
title: MatrixWithDisplayNameConfig
description: Configuration for matrix with display name pricing
GroupedTieredPackagePricingConfig:
properties:
tiers:
items:
$ref: '#/components/schemas/GroupedTieredPackageTierItem'
type: array
minItems: 2
title: Tiers
description: >-
Apply tiered pricing after rounding up the quantity to the package
size. Tiers are defined using exclusive lower bounds.
package_size:
type: string
title: Package Size
grouping_key:
type: string
minLength: 1
title: Grouping Key
description: The event property used to group before tiering
additionalProperties: false
type: object
required:
- tiers
- package_size
- grouping_key
title: GroupedTieredPackagePricingConfig
description: Configuration for grouped tiered package pricing
MaxGroupTieredPackageConfig:
properties:
tiers:
items:
$ref: '#/components/schemas/MaxGroupTieredTierItem'
type: array
minItems: 2
title: Tiers
description: >-
Apply tiered pricing to the largest group after grouping with the
provided key.
package_size:
type: string
title: Package Size
grouping_key:
type: string
minLength: 1
title: Grouping Key
description: >-
The event property used to group before tiering the group with the
highest value
additionalProperties: false
type: object
required:
- tiers
- package_size
- grouping_key
title: MaxGroupTieredPackageConfig
description: Configuration for max group tiered package pricing
ScalableMatrixWithUnitPricingConfig:
properties:
grouping_key:
oneOf:
- type: string
minLength: 1
- type: 'null'
title: Grouping Key
description: The property used to group this price
unit_price:
type: string
title: Unit Price
description: The final unit price to rate against the output of the matrix
first_dimension:
type: string
title: First Dimension
description: Used to determine the unit rate
second_dimension:
oneOf:
- type: string
- type: 'null'
title: Second Dimension
description: Used to determine the unit rate (optional)
matrix_scaling_factors:
items:
$ref: '#/components/schemas/ScalableMatrixWithUnitScalingFactor'
type: array
minItems: 1
title: Matrix Scaling Factors
description: Apply a scaling factor to each dimension
prorate:
oneOf:
- type: boolean
- type: 'null'
title: Prorate
description: If true, the unit price will be prorated to the billing period
default: false
additionalProperties: false
type: object
required:
- unit_price
- first_dimension
- matrix_scaling_factors
title: ScalableMatrixWithUnitPricingConfig
description: Configuration for scalable matrix with unit pricing
ScalableMatrixWithTieredPricingConfig:
properties:
tiers:
items:
$ref: '#/components/schemas/ScalableMatrixWithTieredTierEntry'
type: array
minItems: 2
title: Tiers
first_dimension:
type: string
title: First Dimension
description: Used for the scalable matrix first dimension
second_dimension:
oneOf:
- type: string
- type: 'null'
title: Second Dimension
description: Used for the scalable matrix second dimension (optional)
matrix_scaling_factors:
items:
$ref: '#/components/schemas/ScalableMatrixWithTieredScalingFactor'
type: array
minItems: 1
title: Matrix Scaling Factors
description: Apply a scaling factor to each dimension
additionalProperties: false
type: object
required:
- tiers
- first_dimension
- matrix_scaling_factors
title: ScalableMatrixWithTieredPricingConfig
description: Configuration for scalable matrix with tiered pricing
CumulativeGroupedBulkConfig:
properties:
group:
type: string
title: Group
dimension_values:
items:
$ref: '#/components/schemas/CumulativeGroupedBulkDimensionValue'
type: array
minItems: 1
title: Dimension Values
description: Each tier lower bound must have the same group of values.
additionalProperties: false
type: object
required:
- group
- dimension_values
title: CumulativeGroupedBulkConfig
description: Configuration for cumulative grouped bulk pricing
CumulativeGroupedAllocationConfig:
properties:
grouping_key:
type: string
minLength: 1
title: Grouping Key
description: The event property used to group usage before applying allocations
group_allocation:
type: string
title: Group Allocation
description: The allocation per individual group
cumulative_allocation:
type: string
title: Cumulative Allocation
description: The overall allocation across all groups
unit_amount:
type: string
title: Unit Amount
description: The amount to charge for each unit outside of the allocation
additionalProperties: false
type: object
required:
- grouping_key
- group_allocation
- cumulative_allocation
- unit_amount
title: CumulativeGroupedAllocationConfig
description: >-
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.
DailyCreditAllowanceConfig:
properties:
event_day_property:
type: string
minLength: 1
title: Event Day Property
description: >-
Event property whose value identifies the day bucket the event
belongs to (e.g. 'event_day' set to an ISO date string in the
customer's timezone). The allowance resets per distinct value of
this property.
dimensions:
items:
oneOf:
- type: string
- type: 'null'
type: array
maxItems: 2
minItems: 1
title: Dimensions
description: One or two event property values to evaluate matrix groups by
default_unit_amount:
type: string
title: Default Unit Amount
description: >-
Default per-unit credit rate for any usage not bucketed into a
specified matrix_value
daily_allowance:
type: string
title: Daily Allowance
description: Credits granted per day. Lose-it-or-use-it; does not roll over.
matrix_values:
items:
$ref: '#/components/schemas/DailyCreditAllowanceMatrixValue'
type: array
minItems: 1
title: Matrix Values
description: Per-dimension credit rates
additionalProperties: false
type: object
required:
- event_day_property
- dimensions
- default_unit_amount
- daily_allowance
- matrix_values
title: DailyCreditAllowanceConfig
description: >-
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.
MeteredAllowanceConfig:
properties:
grouping_key:
type: string
minLength: 1
title: Grouping Key
description: >-
Event property used to partition the metric into consumption and
allowance quantities (e.g. 'event_name'). The metric is queried with
this key and the two values below select which partition is which.
consumption_grouping_value:
type: string
minLength: 1
title: Consumption Grouping Value
description: >-
The grouping_key value whose summed quantity represents consumption
(e.g. 'download'). Charged at unit_amount.
allowance_grouping_value:
type: string
minLength: 1
title: Allowance Grouping Value
description: >-
The grouping_key value whose summed quantity represents the
allowance for this period (e.g. 'storage_snapshot' emitting 3 × avg
storage). Capped at consumption — credit can never exceed actual
usage.
unit_amount:
type: string
title: Unit Amount
description: >-
Per-unit price applied to gross consumption and to the allowance
credit.
consumption_display_name:
type: string
minLength: 1
title: Consumption Display Name
description: Sub-line label for the gross consumption row (e.g. 'bytes gotten').
default: Consumption
allowance_display_name:
type: string
minLength: 1
title: Allowance Display Name
description: Sub-line label for the credit row (e.g. 'Up to 3x free egress').
default: Allowance credit
additionalProperties: false
type: object
required:
- grouping_key
- consumption_grouping_value
- allowance_grouping_value
- unit_amount
title: MeteredAllowanceConfig
description: >-
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.
MinimumCompositeConfig:
properties:
minimum_amount:
type: string
title: Minimum Amount
description: The minimum amount to apply
prorated:
type: boolean
title: Prorated
description: >-
If true, subtotals from this price are prorated based on the service
period
additionalProperties: false
type: object
required:
- minimum_amount
title: MinimumCompositeConfig
description: Configuration for minimum composite price
PercentCompositeConfig:
properties:
percent:
type: number
maximum: 1
exclusiveMinimum: 0
title: Percent
description: Fraction of the component subtotals to charge (0 < percent <= 1).
minimum_amount:
oneOf:
- type: string
- type: 'null'
title: Minimum Amount
description: Minimum amount to charge. If unset, the fee is bounded below by 0.
maximum_amount:
oneOf:
- type: string
- type: 'null'
title: Maximum Amount
description: Maximum amount to charge. If unset, the fee has no upper bound.
prorated:
type: boolean
title: Prorated
description: >-
If true, the minimum_amount is prorated based on the service period.
The maximum_amount is an absolute cap (never prorated), and the
percent applied to upstream subtotals is never prorated either.
additionalProperties: false
type: object
required:
- percent
title: PercentCompositeConfig
description: >-
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)
EventOutputConfig:
properties:
unit_rating_key:
type: string
minLength: 1
title: Unit Rating Key
description: The key in the event data to extract the unit rate from.
grouping_key:
oneOf:
- type: string
- type: 'null'
title: Grouping Key
description: >-
An optional key in the event data to group by (e.g., event ID). All
events will also be grouped by their unit rate.
default_unit_rate:
oneOf:
- type: string
- type: 'null'
title: Default Unit Rate
description: >-
If provided, this amount will be used as the unit rate when an event
does not have a value for the `unit_rating_key`. If not provided,
events missing a unit rate will be ignored.
additionalProperties: false
type: object
required:
- unit_rating_key
title: EventOutputConfig
NewTieredPercentageDiscountTier:
properties:
lower_bound:
type: number
minimum: 0
title: Lower Bound
description: Exclusive lower bound of cumulative spend for this tier.
upper_bound:
oneOf:
- type: number
- type: 'null'
title: Upper Bound
description: >-
Inclusive upper bound of cumulative spend; null for the final
open-ended tier.
percentage:
type: number
title: Percentage
description: The percentage (0-1) discounted from spend in this tier.
ge: 0
le: 1
type: object
required:
- lower_bound
- percentage
title: NewTieredPercentageDiscountTier
BillingCycleConfiguration:
properties:
duration:
type: integer
title: Duration
duration_unit:
type: string
enum:
- day
- month
title: Duration Unit
type: object
required:
- duration
- duration_unit
title: BillingCycleConfiguration
BillableMetricTiny:
properties:
id:
type: string
title: Id
type: object
required:
- id
title: BillableMetricTiny
DimensionalPriceConfiguration:
properties:
dimensional_price_group_id:
type: string
title: Dimensional Price Group Id
dimension_values:
items:
type: string
type: array
title: Dimension Values
type: object
required:
- dimensional_price_group_id
- dimension_values
title: DimensionalPriceConfiguration
ItemSlim:
properties:
id:
type: string
title: Id
description: The Orb-assigned unique identifier for the item.
name:
type: string
title: Name
description: The name of the item.
type: object
required:
- id
- name
title: ItemSlim
description: >-
A minimal representation of an Item containing only the essential
identifying information.
Allocation:
properties:
currency:
type: string
title: Currency
allows_rollover:
type: boolean
title: Allows Rollover
custom_expiration:
oneOf:
- $ref: '#/components/schemas/CustomExpiration'
- type: 'null'
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
license_type_id:
oneOf:
- type: string
- type: 'null'
title: License Type Id
type: object
required:
- currency
- allows_rollover
- custom_expiration
title: Allocation
LicenseType:
properties:
id:
type: string
title: Id
description: The Orb-assigned unique identifier for the license type.
name:
type: string
title: Name
description: The name of the license type.
grouping_key:
type: string
title: Grouping Key
description: >-
The key used for grouping licenses of this type. This is typically a
user identifier field.
type: object
required:
- id
- name
- grouping_key
title: LicenseType
description: >-
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.
CreditNoteDiscountAppliesToPrice:
properties:
id:
type: string
title: Id
name:
type: string
title: Name
type: object
required:
- id
- name
title: CreditNoteDiscountAppliesToPrice
CreditNoteLineItemDiscount:
properties:
id:
type: string
title: Id
discount_type:
type: string
enum:
- percentage
- amount
title: Discount Type
percentage_discount:
type: number
title: Percentage Discount
amount_discount:
oneOf:
- type: string
- type: 'null'
title: Amount Discount
amount_applied:
type: string
title: Amount Applied
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
type: object
required:
- id
- discount_type
- percentage_discount
- amount_applied
- applies_to_price_ids
title: CreditNoteLineItemDiscount
TaxAmount:
properties:
tax_rate_description:
type: string
title: Tax Rate Description
description: The human-readable description of the applied tax rate.
tax_rate_percentage:
oneOf:
- type: string
- type: 'null'
title: Tax Rate Percentage
description: The tax rate percentage, out of 100.
amount:
type: string
title: Amount
description: The amount of additional tax incurred by this tax rate.
type: object
required:
- tax_rate_description
- tax_rate_percentage
- amount
title: TaxAmount
InvoiceTiny:
properties:
id:
type: string
title: Id
description: The Invoice id
examples:
- gXcsPTVyC4YZa3Sc
type: object
required:
- id
title: InvoiceTiny
CreditNoteTiny:
properties:
id:
type: string
title: Id
description: The id of the Credit note
type: object
required:
- id
title: CreditNoteTiny
MonetaryAdjustment:
oneOf:
- $ref: '#/components/schemas/MonetaryUsageDiscountAdjustment'
- $ref: '#/components/schemas/MonetaryAmountDiscountAdjustment'
- $ref: '#/components/schemas/MonetaryPercentageDiscountAdjustment'
- $ref: '#/components/schemas/MonetaryTieredPercentageDiscountAdjustment'
- $ref: '#/components/schemas/MonetaryMinimumAdjustment'
- $ref: '#/components/schemas/MonetaryMaximumAdjustment'
discriminator:
propertyName: adjustment_type
mapping:
amount_discount:
$ref: '#/components/schemas/MonetaryAmountDiscountAdjustment'
maximum:
$ref: '#/components/schemas/MonetaryMaximumAdjustment'
minimum:
$ref: '#/components/schemas/MonetaryMinimumAdjustment'
percentage_discount:
$ref: '#/components/schemas/MonetaryPercentageDiscountAdjustment'
tiered_percentage_discount:
$ref: '#/components/schemas/MonetaryTieredPercentageDiscountAdjustment'
usage_discount:
$ref: '#/components/schemas/MonetaryUsageDiscountAdjustment'
InvoiceSubLineItem:
oneOf:
- $ref: '#/components/schemas/MatrixSubLineItem'
- $ref: '#/components/schemas/TierSubLineItem'
- $ref: '#/components/schemas/OtherSubLineItem'
discriminator:
propertyName: type
mapping:
'''null''':
$ref: '#/components/schemas/OtherSubLineItem'
matrix:
$ref: '#/components/schemas/MatrixSubLineItem'
tier:
$ref: '#/components/schemas/TierSubLineItem'
UnitConversionRateConfig:
properties:
conversion_rate_type:
type: string
enum:
- unit
title: Conversion Rate Type
unit_config:
$ref: '#/components/schemas/ConversionRateUnitConfig'
additionalProperties: false
type: object
required:
- conversion_rate_type
- unit_config
title: UnitConversionRateConfig
TieredConversionRateConfig:
properties:
conversion_rate_type:
type: string
enum:
- tiered
title: Conversion Rate Type
tiered_config:
$ref: '#/components/schemas/ConversionRateTieredConfig'
additionalProperties: false
type: object
required:
- conversion_rate_type
- tiered_config
title: TieredConversionRateConfig
Tier:
properties:
first_unit:
type: number
title: First Unit
description: Exclusive tier starting value
last_unit:
oneOf:
- type: number
- type: 'null'
title: Last Unit
description: >-
Inclusive tier ending value. This value is null if and only if this
is the last tier.
unit_amount:
type: string
title: Unit Amount
description: Amount per unit
additionalProperties: false
type: object
required:
- first_unit
- unit_amount
title: Tier
description: Configuration for a single tier
BulkTier:
properties:
maximum_units:
oneOf:
- type: number
- type: 'null'
title: Maximum Units
description: Upper bound for this tier
unit_amount:
type: string
title: Unit Amount
description: Amount per unit
additionalProperties: false
type: object
required:
- unit_amount
title: BulkTier
description: Configuration for a single bulk pricing tier
BulkWithFiltersTier:
properties:
tier_lower_bound:
oneOf:
- type: string
- type: 'null'
title: Tier Lower Bound
description: The lower bound for this tier
unit_amount:
type: string
title: Unit Amount
description: Amount per unit
additionalProperties: false
type: object
required:
- unit_amount
title: BulkWithFiltersTier
description: Configuration for a single bulk pricing tier
FilterRule:
properties:
property_key:
type: string
minLength: 1
title: Property Key
description: Event property key to filter on
property_value:
type: string
minLength: 1
title: Property Value
description: Event property value to match
additionalProperties: false
type: object
required:
- property_key
- property_value
title: FilterRule
description: Configuration for a single property filter
MatrixValue:
properties:
unit_amount:
type: string
title: Unit Amount
description: Unit price for the specified dimension_values
dimension_values:
items:
oneOf:
- type: string
- type: 'null'
type: array
title: Dimension Values
description: One or two matrix keys to filter usage to this Matrix value by
additionalProperties: false
type: object
required:
- unit_amount
- dimension_values
title: MatrixValue
description: Configuration for a single matrix value
TieredTotalThreshold:
properties:
threshold:
type: string
title: Threshold
total_amount:
type: string
title: Total Amount
description: Total amount for this threshold
additionalProperties: false
type: object
required:
- threshold
- total_amount
title: TieredTotalThreshold
description: Configuration for a single threshold
TieredPackageTierItem:
properties:
tier_lower_bound:
type: string
title: Tier Lower Bound
per_unit:
type: string
title: Per Unit
description: Price per package
additionalProperties: false
type: object
required:
- tier_lower_bound
- per_unit
title: TieredPackageTierItem
description: Configuration for a single tier with business logic
TieredPricingWithMinimumTierItem:
properties:
tier_lower_bound:
type: string
title: Tier Lower Bound
unit_amount:
type: string
title: Unit Amount
description: Per unit amount
minimum_amount:
type: string
title: Minimum Amount
additionalProperties: false
type: object
required:
- tier_lower_bound
- unit_amount
- minimum_amount
title: TieredPricingWithMinimumTierItem
description: Configuration for a single tier
GroupedTieredTier:
properties:
tier_lower_bound:
type: string
title: Tier Lower Bound
unit_amount:
type: string
title: Unit Amount
description: Per unit amount
additionalProperties: false
type: object
required:
- tier_lower_bound
- unit_amount
title: GroupedTieredTier
description: Configuration for a single tier
TieredPackageWithMinimumTierItem:
properties:
tier_lower_bound:
type: string
title: Tier Lower Bound
per_unit:
type: string
title: Per Unit
minimum_amount:
type: string
title: Minimum Amount
additionalProperties: false
type: object
required:
- tier_lower_bound
- per_unit
- minimum_amount
title: TieredPackageWithMinimumTierItem
description: Configuration for a single tier
MatrixWithAllocationValueItem:
properties:
unit_amount:
type: string
title: Unit Amount
description: Unit price for the specified dimension_values
dimension_values:
items:
oneOf:
- type: string
- type: 'null'
type: array
title: Dimension Values
description: >-
One or two matrix keys to filter usage to this Matrix value by. For
example, ["region", "tier"] could be used to filter cloud usage by a
cloud region and an instance tier.
additionalProperties: false
type: object
required:
- unit_amount
- dimension_values
title: MatrixWithAllocationValueItem
description: Configuration for a single matrix value
MatrixCell:
properties:
first_dimension_value:
type: string
title: First Dimension Value
second_dimension_value:
oneOf:
- type: string
- type: 'null'
title: Second Dimension Value
unit_amount:
type: string
title: Unit Amount
additionalProperties: false
type: object
required:
- first_dimension_value
- unit_amount
title: MatrixCell
ThresholdDiscountGroup:
properties:
description:
oneOf:
- type: string
- type: 'null'
title: Description
cell_coordinates:
type: string
title: Cell Coordinates
description: >-
Semicolon-separated list of matrix cell coordinates targeted by this
group. Each coordinate is `first,second` when the matrix has two
dimensions, or just `first` for a single-dimension matrix. Example:
`blue,circle;green,triangle`.
threshold_amount:
type: string
title: Threshold Amount
below_threshold_discount_percentage:
type: string
title: Below Threshold Discount Percentage
description: >-
Discount rate applied to spend at or below the threshold. Set to 0
for no baseline discount.
above_threshold_discount_percentage:
type: string
title: Above Threshold Discount Percentage
description: Discount rate applied to spend above the threshold.
additionalProperties: false
type: object
required:
- cell_coordinates
- threshold_amount
- below_threshold_discount_percentage
- above_threshold_discount_percentage
title: ThresholdDiscountGroup
TieredWithProrationTier:
properties:
tier_lower_bound:
type: string
title: Tier Lower Bound
description: Inclusive tier starting value
unit_amount:
type: string
title: Unit Amount
description: Amount per unit
additionalProperties: false
type: object
required:
- tier_lower_bound
- unit_amount
title: TieredWithProrationTier
description: Configuration for a single tiered with proration tier
BulkTierWithProration:
properties:
tier_lower_bound:
oneOf:
- type: string
- type: 'null'
title: Tier Lower Bound
description: The lower bound for this tier
unit_amount:
type: string
title: Unit Amount
description: Cost per unit
additionalProperties: false
type: object
required:
- unit_amount
title: BulkTierWithProration
description: Configuration for a single bulk pricing tier with proration
GroupedWithMeteredMinimumScalingFactorItem:
properties:
scaling_value:
type: string
title: Scaling Value
scaling_factor:
type: string
title: Scaling Factor
additionalProperties: false
type: object
required:
- scaling_value
- scaling_factor
title: GroupedWithMeteredMinimumScalingFactorItem
description: Configuration for a scaling factor
GroupedWithMeteredMinimumUnitAmountItem:
properties:
pricing_value:
type: string
title: Pricing Value
unit_amount:
type: string
title: Unit Amount
description: Per unit amount
additionalProperties: false
type: object
required:
- pricing_value
- unit_amount
title: GroupedWithMeteredMinimumUnitAmountItem
description: Configuration for a unit amount
MatrixWithDisplayNameUnitAmountItem:
properties:
display_name:
type: string
title: Display Name
description: Display name for this dimension value
dimension_value:
type: string
title: Dimension Value
description: The dimension value
unit_amount:
type: string
title: Unit Amount
description: Per unit amount
additionalProperties: false
type: object
required:
- display_name
- dimension_value
- unit_amount
title: MatrixWithDisplayNameUnitAmountItem
description: Configuration for a unit amount item
GroupedTieredPackageTierItem:
properties:
tier_lower_bound:
type: string
title: Tier Lower Bound
per_unit:
type: string
title: Per Unit
description: Per package
additionalProperties: false
type: object
required:
- tier_lower_bound
- per_unit
title: GroupedTieredPackageTierItem
description: Configuration for a single tier
MaxGroupTieredTierItem:
properties:
tier_lower_bound:
type: string
title: Tier Lower Bound
unit_amount:
type: string
title: Unit Amount
description: Per unit amount
additionalProperties: false
type: object
required:
- tier_lower_bound
- unit_amount
title: MaxGroupTieredTierItem
description: Configuration for a single tier
ScalableMatrixWithUnitScalingFactor:
properties:
first_dimension_value:
type: string
title: First Dimension Value
second_dimension_value:
oneOf:
- type: string
- type: 'null'
title: Second Dimension Value
scaling_factor:
type: string
title: Scaling Factor
additionalProperties: false
type: object
required:
- first_dimension_value
- scaling_factor
title: ScalableMatrixWithUnitScalingFactor
description: Configuration for a single matrix scaling factor
ScalableMatrixWithTieredTierEntry:
properties:
tier_lower_bound:
type: string
title: Tier Lower Bound
unit_amount:
type: string
title: Unit Amount
additionalProperties: false
type: object
required:
- tier_lower_bound
- unit_amount
title: ScalableMatrixWithTieredTierEntry
description: Configuration for a single tier entry with business logic
ScalableMatrixWithTieredScalingFactor:
properties:
first_dimension_value:
type: string
title: First Dimension Value
second_dimension_value:
oneOf:
- type: string
- type: 'null'
title: Second Dimension Value
scaling_factor:
type: string
title: Scaling Factor
additionalProperties: false
type: object
required:
- first_dimension_value
- scaling_factor
title: ScalableMatrixWithTieredScalingFactor
description: Configuration for a single matrix scaling factor
CumulativeGroupedBulkDimensionValue:
properties:
tier_lower_bound:
type: string
title: Tier Lower Bound
description: Tier lower bound
grouping_key:
type: string
minLength: 1
title: Grouping Key
description: Grouping key value
unit_amount:
type: string
title: Unit Amount
description: Unit amount for this combination
additionalProperties: false
type: object
required:
- tier_lower_bound
- grouping_key
- unit_amount
title: CumulativeGroupedBulkDimensionValue
description: Configuration for a dimension value entry
DailyCreditAllowanceMatrixValue:
properties:
unit_amount:
type: string
title: Unit Amount
description: >-
Credits charged per unit of usage matching the specified
dimension_values
dimension_values:
items:
oneOf:
- type: string
- type: 'null'
type: array
title: Dimension Values
description: >-
One or two matrix keys to filter usage to this value by. For
example, ["model"] could be used to apply a different credit rate to
each AI model.
additionalProperties: false
type: object
required:
- unit_amount
- dimension_values
title: DailyCreditAllowanceMatrixValue
description: Per-dimension credit price for the daily credit allowance model.
MonetaryUsageDiscountAdjustment:
properties:
id:
type: string
title: Id
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
True for adjustments that apply to an entire invoice, false for
adjustments that apply to only one price.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: The filters that determine which prices to apply this adjustment to.
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
description: The price IDs that this adjustment applies to.
deprecated: true
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
description: The reason for the adjustment.
replaces_adjustment_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Adjustment Id
description: >-
The adjustment id this adjustment replaces. This adjustment will
take the place of the replaced adjustment in plan version
migrations.
adjustment_type:
type: string
enum:
- usage_discount
title: Adjustment Type
usage_discount:
type: number
title: Usage Discount
description: >-
The number of usage units by which to discount the price this
adjustment applies to in a given billing period.
amount:
type: string
title: Amount
description: The value applied by an adjustment.
type: object
required:
- id
- is_invoice_level
- filters
- applies_to_price_ids
- reason
- replaces_adjustment_id
- adjustment_type
- usage_discount
- amount
title: MonetaryUsageDiscountAdjustment
MonetaryAmountDiscountAdjustment:
properties:
id:
type: string
title: Id
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
True for adjustments that apply to an entire invoice, false for
adjustments that apply to only one price.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: The filters that determine which prices to apply this adjustment to.
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
description: The price IDs that this adjustment applies to.
deprecated: true
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
description: The reason for the adjustment.
replaces_adjustment_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Adjustment Id
description: >-
The adjustment id this adjustment replaces. This adjustment will
take the place of the replaced adjustment in plan version
migrations.
adjustment_type:
type: string
enum:
- amount_discount
title: Adjustment Type
amount_discount:
type: string
title: Amount Discount
description: >-
The amount by which to discount the prices this adjustment applies
to in a given billing period.
amount:
type: string
title: Amount
description: The value applied by an adjustment.
type: object
required:
- id
- is_invoice_level
- filters
- applies_to_price_ids
- reason
- replaces_adjustment_id
- adjustment_type
- amount_discount
- amount
title: MonetaryAmountDiscountAdjustment
MonetaryPercentageDiscountAdjustment:
properties:
id:
type: string
title: Id
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
True for adjustments that apply to an entire invoice, false for
adjustments that apply to only one price.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: The filters that determine which prices to apply this adjustment to.
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
description: The price IDs that this adjustment applies to.
deprecated: true
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
description: The reason for the adjustment.
replaces_adjustment_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Adjustment Id
description: >-
The adjustment id this adjustment replaces. This adjustment will
take the place of the replaced adjustment in plan version
migrations.
adjustment_type:
type: string
enum:
- percentage_discount
title: Adjustment Type
percentage_discount:
type: number
maximum: 1
minimum: 0
title: Percentage Discount
description: >-
The percentage (as a value between 0 and 1) by which to discount the
price intervals this adjustment applies to in a given billing
period.
amount:
type: string
title: Amount
description: The value applied by an adjustment.
type: object
required:
- id
- is_invoice_level
- filters
- applies_to_price_ids
- reason
- replaces_adjustment_id
- adjustment_type
- percentage_discount
- amount
title: MonetaryPercentageDiscountAdjustment
MonetaryTieredPercentageDiscountAdjustment:
properties:
id:
type: string
title: Id
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
True for adjustments that apply to an entire invoice, false for
adjustments that apply to only one price.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: The filters that determine which prices to apply this adjustment to.
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
description: The price IDs that this adjustment applies to.
deprecated: true
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
description: The reason for the adjustment.
replaces_adjustment_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Adjustment Id
description: >-
The adjustment id this adjustment replaces. This adjustment will
take the place of the replaced adjustment in plan version
migrations.
adjustment_type:
type: string
enum:
- tiered_percentage_discount
title: Adjustment Type
tiers:
items:
$ref: '#/components/schemas/PercentageTier'
type: array
title: Tiers
description: >-
The ordered, contiguous bands of cumulative eligible spend, each
discounted at its own percentage (progressive fill-a-tier), applied
to the prices this adjustment covers in a given billing period.
amount:
type: string
title: Amount
description: The value applied by an adjustment.
type: object
required:
- id
- is_invoice_level
- filters
- applies_to_price_ids
- reason
- replaces_adjustment_id
- adjustment_type
- tiers
- amount
title: MonetaryTieredPercentageDiscountAdjustment
MonetaryMinimumAdjustment:
properties:
id:
type: string
title: Id
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
True for adjustments that apply to an entire invoice, false for
adjustments that apply to only one price.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: The filters that determine which prices to apply this adjustment to.
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
description: The price IDs that this adjustment applies to.
deprecated: true
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
description: The reason for the adjustment.
replaces_adjustment_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Adjustment Id
description: >-
The adjustment id this adjustment replaces. This adjustment will
take the place of the replaced adjustment in plan version
migrations.
adjustment_type:
type: string
enum:
- minimum
title: Adjustment Type
minimum_amount:
type: string
title: Minimum Amount
description: >-
The minimum amount to charge in a given billing period for the
prices this adjustment applies to.
item_id:
type: string
title: Item Id
description: The item ID that revenue from this minimum will be attributed to.
amount:
type: string
title: Amount
description: The value applied by an adjustment.
type: object
required:
- id
- is_invoice_level
- filters
- applies_to_price_ids
- reason
- replaces_adjustment_id
- adjustment_type
- minimum_amount
- item_id
- amount
title: MonetaryMinimumAdjustment
MonetaryMaximumAdjustment:
properties:
id:
type: string
title: Id
is_invoice_level:
type: boolean
title: Is Invoice Level
description: >-
True for adjustments that apply to an entire invoice, false for
adjustments that apply to only one price.
filters:
items:
$ref: '#/components/schemas/PriceFilter'
type: array
title: Filters
description: The filters that determine which prices to apply this adjustment to.
applies_to_price_ids:
items:
type: string
type: array
title: Applies To Price Ids
description: The price IDs that this adjustment applies to.
deprecated: true
reason:
oneOf:
- type: string
- type: 'null'
title: Reason
description: The reason for the adjustment.
replaces_adjustment_id:
oneOf:
- type: string
- type: 'null'
title: Replaces Adjustment Id
description: >-
The adjustment id this adjustment replaces. This adjustment will
take the place of the replaced adjustment in plan version
migrations.
adjustment_type:
type: string
enum:
- maximum
title: Adjustment Type
maximum_amount:
type: string
title: Maximum Amount
description: >-
The maximum amount to charge in a given billing period for the
prices this adjustment applies to.
amount:
type: string
title: Amount
description: The value applied by an adjustment.
type: object
required:
- id
- is_invoice_level
- filters
- applies_to_price_ids
- reason
- replaces_adjustment_id
- adjustment_type
- maximum_amount
- amount
title: MonetaryMaximumAdjustment
MatrixSubLineItem:
properties:
amount:
type: string
title: Amount
description: The total amount for this sub line item.
examples:
- '9.00'
name:
type: string
title: Name
examples:
- Tier One
quantity:
type: number
title: Quantity
examples:
- 5
grouping:
oneOf:
- $ref: '#/components/schemas/SubLineItemGrouping'
- type: 'null'
type:
type: string
enum:
- matrix
title: Type
scaled_quantity:
oneOf:
- type: number
- type: 'null'
title: Scaled Quantity
description: >-
The scaled quantity for this line item for specific pricing
structures
matrix_config:
$ref: '#/components/schemas/SubLineItemMatrixConfig'
type: object
required:
- amount
- name
- quantity
- grouping
- type
- matrix_config
title: MatrixSubLineItem
TierSubLineItem:
properties:
amount:
type: string
title: Amount
description: The total amount for this sub line item.
examples:
- '9.00'
name:
type: string
title: Name
examples:
- Tier One
quantity:
type: number
title: Quantity
examples:
- 5
grouping:
oneOf:
- $ref: '#/components/schemas/SubLineItemGrouping'
- type: 'null'
type:
type: string
enum:
- tier
title: Type
tier_config:
$ref: '#/components/schemas/TierSubLineItemTierConfig'
type: object
required:
- amount
- name
- quantity
- grouping
- type
- tier_config
title: TierSubLineItem
OtherSubLineItem:
properties:
amount:
type: string
title: Amount
description: The total amount for this sub line item.
examples:
- '9.00'
name:
type: string
title: Name
examples:
- Tier One
quantity:
type: number
title: Quantity
examples:
- 5
grouping:
oneOf:
- $ref: '#/components/schemas/SubLineItemGrouping'
- type: 'null'
type:
type: string
enum:
- '''null'''
title: Type
type: object
required:
- amount
- name
- quantity
- grouping
- type
title: OtherSubLineItem
ConversionRateUnitConfig:
properties:
unit_amount:
type: string
title: Unit Amount
description: Amount per unit of overage
additionalProperties: false
type: object
required:
- unit_amount
title: ConversionRateUnitConfig
ConversionRateTieredConfig:
properties:
tiers:
items:
$ref: '#/components/schemas/ConversionRateTier'
type: array
title: Tiers
description: >-
Tiers for rating based on total usage quantities into the specified
tier
additionalProperties: false
type: object
required:
- tiers
title: ConversionRateTieredConfig
SubLineItemGrouping:
properties:
key:
type: string
title: Key
examples:
- region
value:
oneOf:
- type: string
- type: 'null'
title: Value
description: No value indicates the default group
examples:
- west
type: object
required:
- key
- value
title: SubLineItemGrouping
SubLineItemMatrixConfig:
properties:
dimension_values:
items:
oneOf:
- type: string
- type: 'null'
type: array
title: Dimension Values
description: The ordered dimension values for this line item.
type: object
required:
- dimension_values
title: SubLineItemMatrixConfig
TierSubLineItemTierConfig:
properties:
first_unit:
type: number
title: First Unit
examples:
- 1
last_unit:
oneOf:
- type: number
- type: 'null'
title: Last Unit
examples:
- 1000
unit_amount:
type: string
title: Unit Amount
examples:
- '3.00'
type: object
required:
- first_unit
- last_unit
- unit_amount
title: TierSubLineItemTierConfig
ConversionRateTier:
properties:
first_unit:
type: number
title: First Unit
description: Exclusive tier starting value
last_unit:
oneOf:
- type: number
- type: 'null'
title: Last Unit
description: >-
Inclusive tier ending value. If null, this is treated as the last
tier
unit_amount:
type: string
title: Unit Amount
description: Amount per unit of overage
additionalProperties: false
type: object
required:
- first_unit
- unit_amount
title: ConversionRateTier
securitySchemes:
APIKeyAuth:
type: http
description: API Keys can be issued in the Orb's web application.
scheme: bearer
````