Create invoice line item

This creates a one-off fixed fee invoice line item on an Invoice. This can only be done for invoices that are in a draft status.

application/json

Request Body

start_date date required

A date string to specify the line item's start date in the customer's timezone.

end_date date required

A date string to specify the line item's end date in the customer's timezone.

quantity number required

The number of units on the line item

invoice_id string required

The id of the Invoice to add this line item.

name string required

The item name associated with this line item. If an item with the same name exists in Orb, that item will be associated with the line item.

amount string required

The total amount in the invoice's currency to add to the line item.

Responses

Created

Response Headers

application/json

Schema

Example (from schema)

Schema

amount string required

The final amount after any discounts or minimums.

discount object nullable

oneOf

PercentageDiscount

TrialDiscount

UsageDiscount

AmountDiscount

discount_type string required

Possible values: [percentage]

applies_to_price_ids string[] required

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

reason string nullable

percentage_discount number required

Possible values: <= 1

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

discount_type string required

Possible values: [trial]

applies_to_price_ids string[] required

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

reason string nullable

trial_amount_discount string nullable

Only available if discount_type is trial

trial_percentage_discount number nullable

Only available if discount_type is trial

discount_type string required

Possible values: [usage]

applies_to_price_ids string[] required

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

reason string nullable

usage_discount number required

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

discount_type string required

Possible values: [amount]

applies_to_price_ids string[] required

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

reason string nullable

amount_discount string required

Only available if discount_type is amount.

end_date date-time required

The end date of the range of time applied for this line item's price.

grouping string nullable required

[DEPRECATED] For configured prices that are split by a grouping key, this will be populated with the key and a value. The amount and subtotal will be the values for this particular grouping.

minimum object nullable

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

name string required

The name of the price associated with this line item.

quantity number required

start_date date-time required

The start date of the range of time applied for this line item's price.

subtotal string required

The line amount before any line item-specific discounts or minimums.

sub_line_items object[] required

For complex pricing structures, the line item can be broken down further in sub_line_items.

Array [

oneOf

MatrixSubLineItem

TierSubLineItem

OtherSubLineItem

amount string required

The total amount for this sub line item.

name string required

quantity number required

grouping object nullable

key string required

value string nullable required

No value indicates the default group

type string required

Possible values: [matrix]

matrix_config object required

dimension_values string[] required

The ordered dimension values for this line item.

amount string required

The total amount for this sub line item.

name string required

quantity number required

grouping object nullable

key string required

value string nullable required

No value indicates the default group

type string required

Possible values: [tier]

tier_config object required

first_unit number required

last_unit number nullable required

unit_amount string required

]

tax_amounts object[] required

An array of tax rates and their incurred tax amounts. Empty if no tax integration is configured.

Array [

tax_rate_description string required

The human-readable description of the applied tax rate.

tax_rate_percentage string nullable required

The tax rate percentage, out of 100.

amount string required

The amount of additional tax incurred by this tax rate.

]

id string required

A unique ID for this line item.

price object nullable

The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.

Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.

Unit pricing

With unit pricing, each unit costs a fixed amount.

{
    ...
    "model_type": "unit",
    "unit_config": {
        "unit_amount": "0.50"
    }
    ...
}

Tiered pricing

In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter may cost $0.10 each.

{
    ...
    "model_type": "tiered",
    "tiered_config": {
        "tiers": [
            {
                "first_unit": 1,
                "last_unit": 10,
                "unit_amount": "0.50"
            },
            {
                "first_unit": 11,
                "last_unit": null,
                "unit_amount": "0.10"
            }
        ]
    }
    ...

Bulk pricing

Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may now be priced at $0.40 (i.e. 101 units total would be $40.40).

{
    ...
    "model_type": "bulk",
    "bulk_config": {
        "tiers": [
            {
                "maximum_units": 10,
                "unit_amount": "0.50"
            },
            {
                "maximum_units": 1000,
                "unit_amount": "0.40"
            }
        ]
    }
    ...
}

Package pricing

Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.

{
    ...
    "model_type": "package",
    "package_config": {
        "package_amount": "0.80",
        "package_size": 10
    }
    ...
}

BPS pricing

BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on every payment you process, with a maximum charge of $25 per payment.

{
    ...
    "model_type": "bps",
    "bps_config": {
       "bps": 125,
       "per_unit_maximum": "11.00"
    }
    ...
 }

Bulk BPS pricing

Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events. Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached, each individual payment may have a lower cap or a smaller take-rate.

    ...
    "model_type": "bulk_bps",
    "bulk_bps_config": {
        "tiers": [
           {
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}

Tiered BPS pricing

Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound. For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may incur a take-rate of 0.5 BPS each.

    ...
    "model_type": "tiered_bps",
    "tiered_bps_config": {
        "tiers": [
           {
                "minimum_amount": "0",
                "maximum_amount": "1000000.00",
                "bps": 125,
                "per_unit_maximum": "19.00"
           },
          {
                "minimum_amount": "1000000.00",
                "maximum_amount": null,
                "bps": 115,
                "per_unit_maximum": "4.00"
            }
        ]
    }
    ...
}

Matrix pricing

Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. dimensions defines the two event property values evaluated in this pricing model. In a one-dimensional matrix, the second value is null. Every configuration has a list of matrix_values which give the unit prices for specified property values. In a one-dimensional matrix, the matrix values will have dimension_values where the second value of the pair is null. If an event does not match any of the dimension values in the matrix, it will resort to the default_unit_amount.

{
    "model_type": "matrix"
    "matrix_config": {
        "default_unit_amount": "3.00",
        "dimensions": [
            "cluster_name",
            "region"
        ],
        "matrix_values": [
            {
                "dimension_values": [
                    "alpha",
                    "west"
                ],
                "unit_amount": "2.00"
            },
            ...
        ]
    }
}

Fixed fees

Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an additional parameter fixed_price_quantity. If the Price represents a fixed cost, this represents the quantity of units applied.

{
    ...
    "id": "price_id",
    "model_type": "unit",
    "unit_config": {
       "unit_amount": "2.00"
    },
    "fixed_price_quantity": 3.0
    ...
}

oneOf

UnitPrice

PackagePrice

MatrixPrice

TieredPrice

TieredBpsPrice

BpsPrice

BulkBpsPrice

BulkPrice

ThresholdTotalAmountPrice

TieredPackagePrice

GroupedTieredPrice

TieredWithMinimumPrice

TieredPackageWithMinimumPrice

PackageWithAllocationPrice

UnitWithPercentPrice

MatrixWithAllocationPrice

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [unit]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

unit_config object required

unit_amount string required

Rate per unit of usage

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [package]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

package_config object required

package_amount string required

A currency amount to rate usage by

package_size integer required

An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [matrix]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

matrix_config object required

dimensions string[] required

One or two event property values to evaluate matrix groups by

default_unit_amount string required

Default per unit rate for any usage not bucketed into a specified matrix_value

matrix_values object[] required

Matrix values for specified matrix grouping keys

Array [

unit_amount string required

Unit price for the specified dimension_values

dimension_values string[] required

One or two matrix keys to filter usage to this Matrix value by. For example, ["region", "tier"] could be used to filter cloud usage by a cloud region and an instance tier.

]

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [tiered]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

tiered_config object required

tiers object[] required

Tiers for rating based on total usage quantities into the specified tier

Array [

first_unit number required

Inclusive tier starting value

last_unit number nullable

Exclusive tier ending value. If null, this is treated as the last tier

unit_amount string required

Amount per unit

]

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [tiered_bps]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

tiered_bps_config object required

tiers object[] required

Tiers for a Graduated BPS pricing model, where usage is bucketed into specified tiers

Array [

minimum_amount string required

Inclusive tier starting value

maximum_amount string nullable

Exclusive tier ending value

bps number required

Per-event basis point rate

per_unit_maximum string nullable

Per unit maximum to charge

]

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [bps]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

bps_config object required

bps number required

Basis point take rate per event

per_unit_maximum string nullable

Optional currency amount maximum to cap spend per event

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [bulk_bps]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

bulk_bps_config object required

tiers object[] required

Tiers for a bulk BPS pricing model where all usage is aggregated to a single tier based on total volume

Array [

maximum_amount string nullable

Upper bound for tier

bps number required

Basis points to rate on

per_unit_maximum string nullable

The maximum amount to charge for any one event

]

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [bulk]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

bulk_config object required

tiers object[] required

Bulk tiers for rating based on total usage volume

Array [

maximum_units number nullable

Upper bound for this tier

unit_amount string required

Amount per unit

]

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [threshold_total_amount]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

threshold_total_amount_config object required

property name* any

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [tiered_package]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

tiered_package_config object required

property name* any

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [grouped_tiered]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

grouped_tiered_config object required

property name* any

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [tiered_with_minimum]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

tiered_with_minimum_config object required

property name* any

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [tiered_package_with_minimum]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

tiered_package_with_minimum_config object required

property name* any

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [package_with_allocation]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

package_with_allocation_config object required

property name* any

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [unit_with_percent]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

unit_with_percent_config object required

property name* any

id string required

name string required

external_price_id string nullable required

price_type string required

Possible values: [usage_price, fixed_price]

model_type string required

Possible values: [matrix_with_allocation]

created_at date-time required

cadence string required

Possible values: [one_time, monthly, quarterly, annual]

billable_metric object nullable required

id string required

fixed_price_quantity number nullable required

plan_phase_order integer nullable required

currency string required

conversion_rate number nullable required

item object required

id string required

name string required

credit_allocation object nullable required

currency string required

allows_rollover boolean required

discount object nullable required

oneOf

object

minimum object nullable required

minimum_amount string required

Minimum amount applied

applies_to_price_ids string[] required

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

minimum_amount string nullable required

maximum object nullable required

maximum_amount string required

Maximum amount applied

applies_to_price_ids string[] required

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

maximum_amount string nullable required

matrix_with_allocation_config object required

dimensions string[] required

One or two event property values to evaluate matrix groups by

default_unit_amount string required

Default per unit rate for any usage not bucketed into a specified matrix_value

matrix_values object[] required

Matrix values for specified matrix grouping keys

Array [

unit_amount string required

Unit price for the specified dimension_values

dimension_values string[] required

One or two matrix keys to filter usage to this Matrix value by. For example, ["region", "tier"] could be used to filter cloud usage by a cloud region and an instance tier.

]

allocation number required

Allocation to be used to calculate the price

{
  "amount": "7.00",
  "discount": {
    "discount_type": "percentage",
    "applies_to_price_ids": [
      "h74gfhdjvn7ujokd",
      "7hfgtgjnbvc3ujkl"
    ],
    "reason": "string",
    "percentage_discount": 0.15
  },
  "end_date": "2022-02-01T08:00:00+00:00",
  "grouping": "string",
  "minimum": {
    "minimum_amount": "string",
    "applies_to_price_ids": [
      "string"
    ]
  },
  "minimum_amount": "string",
  "maximum": {
    "maximum_amount": "string",
    "applies_to_price_ids": [
      "string"
    ]
  },
  "maximum_amount": "string",
  "name": "Fixed Fee",
  "quantity": 1,
  "start_date": "2022-02-01T08:00:00+00:00",
  "subtotal": "9.00",
  "sub_line_items": [
    {},
    {},
    {}
  ],
  "tax_amounts": [
    {
      "tax_rate_description": "string",
      "tax_rate_percentage": "string",
      "amount": "string"
    }
  ],
  "id": "string",
  "price": {
    "id": "string",
    "name": "string",
    "external_price_id": "string",
    "price_type": "usage_price",
    "model_type": "unit",
    "created_at": "2024-05-13T22:31:16.633Z",
    "cadence": "one_time",
    "billable_metric": {
      "id": "string"
    },
    "fixed_price_quantity": 0,
    "plan_phase_order": 0,
    "currency": "string",
    "conversion_rate": 0,
    "item": {
      "id": "string",
      "name": "string"
    },
    "credit_allocation": {
      "currency": "string",
      "allows_rollover": true
    },
    "discount": {
      "discount_type": "percentage",
      "applies_to_price_ids": [
        "h74gfhdjvn7ujokd",
        "7hfgtgjnbvc3ujkl"
      ],
      "reason": "string",
      "percentage_discount": 0.15
    },
    "minimum": {
      "minimum_amount": "string",
      "applies_to_price_ids": [
        "string"
      ]
    },
    "minimum_amount": "string",
    "maximum": {
      "maximum_amount": "string",
      "applies_to_price_ids": [
        "string"
      ]
    },
    "maximum_amount": "string",
    "unit_config": {
      "unit_amount": "string"
    }
  }
}

Bad Request

Response Headers

application/json

Schema

Example (from schema)

Schema

oneOf

ConstraintViolationError

DuplicateResourceCreationError

RequestValidationError

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#400-constraint-violation]

status integer required

Possible values: [400]

detail string nullable

title string nullable

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation]

status integer required

Possible values: [400]

detail string nullable

title string nullable

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#400-request-validation-errors]

status integer required

Possible values: [400]

detail string nullable

title string nullable

validation_errors undefined[] required

{}

Unauthorized

Response Headers

application/json

Schema

Example (from schema)

Schema

type string required

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

status integer required

Possible values: [401]

detail string nullable

title string nullable

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

Not Found

Response Headers

application/json

Schema

Example (from schema)

Schema

oneOf

FeatureNotAvailableError

ResourceNotFoundError

URLNotFound

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#404-feature-not-available]

status integer required

Possible values: [400]

detail string nullable

title string nullable

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#404-resource-not-found]

status integer required

Possible values: [404]

detail string nullable

title string required

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#404-url-not-found]

status integer required

Possible values: [404]

detail string nullable

title string nullable

{}

Conflict

Response Headers

application/json

Schema

Example (from schema)

Schema

type string required

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

status integer required

Possible values: [409]

detail string nullable

title string nullable

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

Request Entity Too Large

Response Headers

application/json

Schema

Example (from schema)

Schema

oneOf

RequestTooLargeError

ResourceTooLargeError

TooManyResultsError

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#413-request-too-large]

status integer required

Possible values: [413]

detail string nullable

title string nullable

type string required

Possible values: [https://docs.withorb.com/reference/error-responses#413-resource-too-large]

status integer required

Possible values: [413]

detail string nullable

title string nullable

type string required

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

status integer required

Possible values: [413]

detail string nullable

title string nullable

{}

Too Many Requests

Response Headers

application/json

Schema

Example (from schema)

Schema

type string required

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

status integer required

Possible values: [429]

detail string nullable

title string nullable

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

Internal Server Error

Response Headers

application/json

Schema

Example (from schema)

Schema

type string required

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

status integer required

detail string nullable

title string nullable

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