Add or edit price intervals

Authorizations

Authorization

string

header

required

API Keys can be issued in the Orb's web application.

Path Parameters

subscription_id

string

required

Body

application/json

add

AddPriceIntervalParams · object[]

A list of price intervals to add to the subscription.

Show child attributes

add.start_date

required

The start date of the price interval. This is the date that the price will start billing on the subscription.

Example:

"2023-05-01"

add.usage_customer_ids

string[] | null

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.

add.filter

string | null

An additional filter to apply to usage queries. This filter must be expressed as a boolean computed property. If null, usage queries will not include any additional filter.

Example:

"my_property > 100 AND my_other_property = 'bar'"

add.price_id

string | null

The id of the price to add to the subscription.

Example:

"h74gfhdjvn7ujokd"

add.external_price_id

string | null

The external price id of the price to add to the subscription.

Example:

"external_price_id"

add.price

NewFloatingUnitPrice · object

The definition of a new price to create and add to the subscription.

NewFloatingUnitPrice
NewFloatingTieredPrice
NewFloatingBulkPrice
NewFloatingBulkWithFiltersPrice
NewFloatingPackagePrice
NewFloatingMatrixPrice
NewFloatingThresholdTotalAmountPrice
NewFloatingTieredPackagePrice
NewFloatingTieredWithMinimumPrice
NewFloatingGroupedTieredPrice
NewFloatingTieredPackageWithMinimumPrice
NewFloatingPackageWithAllocationPrice
NewFloatingUnitWithPercentPrice
NewFloatingMatrixWithAllocationPrice
NewFloatingTieredWithProrationPrice
NewFloatingUnitWithProrationPrice
NewFloatingGroupedAllocationPrice
NewFloatingBulkWithProrationPrice
NewFloatingGroupedWithProratedMinimumPrice
NewFloatingGroupedWithMeteredMinimumPrice
NewFloatingGroupedWithMinMaxThresholdsPrice
NewFloatingMatrixWithDisplayNamePrice
NewFloatingGroupedTieredPackagePrice
NewFloatingMaxGroupTieredPackagePrice
NewFloatingScalableMatrixWithUnitPricingPrice
NewFloatingScalableMatrixWithTieredPricingPrice
NewFloatingCumulativeGroupedBulkPrice
NewFloatingCumulativeGroupedAllocationPrice
NewFloatingMinimumCompositePrice
NewFloatingPercentCompositePrice
NewFloatingEventOutputPrice

Show child attributes

add.price.model_type

enum<string>

required

The pricing model type

Available options:

unit

add.price.unit_config

UnitConfig · object

required

Configuration for unit pricing

Show child attributes

add.price.unit_config.unit_amount

string

required

Rate per unit of usage

add.price.unit_config.prorated

boolean

default:false

If true, subtotals from this price are prorated based on the service period

add.price.name

string

required

The name of the price.

add.price.item_id

string

required

The id of the item the price will be associated with.

add.price.cadence

enum<string>

required

The cadence to bill for this price on.

Available options:

annual,

semi_annual,

monthly,

quarterly,

one_time,

custom

add.price.currency

string

required

An ISO 4217 currency string for which this price is billed in.

add.price.metadata

Metadata · object

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.

Show child attributes

add.price.metadata.{key}

string | null

add.price.external_price_id

string | null

An alias for the price.

add.price.dimensional_price_configuration

NewDimensionalPriceConfiguration · object

For dimensional price: specifies a price group and dimension values

Show child attributes

add.price.dimensional_price_configuration.dimension_values

string[]

required

The list of dimension values matching (in order) the dimensions of the price group

add.price.dimensional_price_configuration.dimensional_price_group_id

string | null

The id of the dimensional price group to include this price in

add.price.dimensional_price_configuration.external_dimensional_price_group_id

string | null

The external id of the dimensional price group to include this price in

add.price.billable_metric_id

string | null

The id of the billable metric for the price. Only needed if the price is usage-based.

add.price.billed_in_advance

boolean | null

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.

add.price.fixed_price_quantity

number | null

If the Price represents a fixed cost, this represents the quantity of units applied.

add.price.invoice_grouping_key

string | null

The property used to group this price on an invoice

Minimum string length: 1

add.price.billing_cycle_configuration

NewBillingCycleConfiguration · object

For custom cadence: specifies the duration of the billing period in days or months.

Show child attributes

add.price.billing_cycle_configuration.duration

integer

required

The duration of the billing period.

add.price.billing_cycle_configuration.duration_unit

enum<string>

required

The unit of billing period duration.

Available options:

day,

month

add.price.invoicing_cycle_configuration

NewBillingCycleConfiguration · object

Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle.

Show child attributes

add.price.invoicing_cycle_configuration.duration

integer

required

The duration of the billing period.

add.price.invoicing_cycle_configuration.duration_unit

enum<string>

required

The unit of billing period duration.

Available options:

day,

month

add.price.conversion_rate

number | null

The per unit conversion rate of the price currency to the invoicing currency.

add.price.conversion_rate_config

UnitConversionRateConfig · object

The configuration for the rate of the price currency to the invoicing currency.

UnitConversionRateConfig
TieredConversionRateConfig

Show child attributes

add.price.conversion_rate_config.conversion_rate_type

enum<string>

required

Available options:

unit

add.price.conversion_rate_config.unit_config

ConversionRateUnitConfig · object

required

Show child attributes

add.price.conversion_rate_config.unit_config.unit_amount

string

required

Amount per unit of overage

add.allocation_price

NewAllocationPrice · object

The definition of a new allocation price to create and add to the subscription.

Show child attributes

add.allocation_price.currency

string

required

An ISO 4217 currency string or a custom pricing unit identifier in which to bill this price.

add.allocation_price.amount

string

required

An amount of the currency to allocate to the customer at the specified cadence.

add.allocation_price.cadence

enum<string>

required

The cadence at which to allocate the amount to the customer.

Available options:

one_time,

monthly,

quarterly,

semi_annual,

annual

add.allocation_price.expires_at_end_of_cadence

boolean | null

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.

add.allocation_price.custom_expiration

CustomExpiration · object

The custom expiration for the allocation.

Show child attributes

add.allocation_price.custom_expiration.duration

integer

required

add.allocation_price.custom_expiration.duration_unit

enum<string>

required

Available options:

day,

month

add.allocation_price.filters

BlockPriceFilter · object[] | null

The filters that determine which items the allocation applies to.

Show child attributes

add.allocation_price.filters.field

enum<string>

required

The property of the price the block applies to. Only item_id is supported.

Available options:

item_id

add.allocation_price.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

add.allocation_price.filters.values

string[]

required

The IDs or values that match this filter.

add.allocation_price.per_unit_cost_basis

string

default:0.00

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.

add.allocation_price.item_id

string | null

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

add.end_date

The end date of the price interval. This is the date that the price will stop billing on the subscription.

Example:

"2023-07-10"

add.can_defer_billing

boolean | null

If true, an in-arrears price interval ending mid-cycle will defer billing the final line item until the next scheduled invoice. If false, it will be billed on its end date.

add.fixed_fee_quantity_transitions

PriceIntervalFixedFeeQuantityTransitionParams · object[] | null

A list of fixed fee quantity transitions to initialize on the price interval.

Show child attributes

add.fixed_fee_quantity_transitions.quantity

integer

required

The quantity of the fixed fee quantity transition.

add.fixed_fee_quantity_transitions.effective_date

required

The date that the fixed fee quantity transition should take effect.

Example:

"2023-05-01"

add.discounts

(AmountDiscountCreationParams · object | PercentageDiscountCreationParams · object | UsageDiscountCreationParams · object)[] | null

A list of discounts to initialize on the price interval.

AmountDiscountCreationParams
PercentageDiscountCreationParams
UsageDiscountCreationParams

Show child attributes

add.discounts.discount_type

enum<string>

required

Available options:

amount

add.discounts.amount_discount

number

required

Only available if discount_type is amount.

Required range: x >= 0

add.minimum_amount

number | null

The minimum amount that will be billed for this price interval for a given billing period.

Example:

"1.23"

add.maximum_amount

number | null

The maximum amount that will be billed for this price interval for a given billing period.

Example:

"1.23"

edit

EditPriceIntervalParams · object[]

A list of price intervals to edit on the subscription.

Show child attributes

edit.price_interval_id

string

required

The id of the price interval to edit.

edit.usage_customer_ids

string[] | null

edit.filter

string | null

An additional filter to apply to usage queries. This filter must be expressed as a boolean computed property. If null, usage queries will not include any additional filter.

Example:

"my_property > 100 AND my_other_property = 'bar'"

edit.start_date

The updated start date of this price interval. If not specified, the start date will not be updated.

Example:

"2023-05-01"

edit.end_date

The updated end date of this price interval. If not specified, the end date will not be updated.

Example:

"2023-07-10"

edit.fixed_fee_quantity_transitions

PriceIntervalFixedFeeQuantityTransitionParams · object[] | null

A list of fixed fee quantity transitions to use for this price interval. Note that this list will overwrite all existing fixed fee quantity transitions on the price interval.

Show child attributes

edit.fixed_fee_quantity_transitions.quantity

integer

required

The quantity of the fixed fee quantity transition.

edit.fixed_fee_quantity_transitions.effective_date

required

The date that the fixed fee quantity transition should take effect.

Example:

"2023-05-01"

edit.billing_cycle_day

integer | null

The updated billing cycle day for this price interval. If not specified, the billing cycle day will not be updated. Note that overlapping price intervals must have the same billing cycle day.

edit.can_defer_billing

boolean | null

If true, an in-arrears price interval ending mid-cycle will defer billing the final line item until the next scheduled invoice. If false, it will be billed on its end date.

add_adjustments

AddAdjustmentIntervalParams · object[]

A list of adjustments to add to the subscription.

Show child attributes

add_adjustments.start_date

required

The start date of the adjustment interval. This is the date that the adjustment will start affecting prices on the subscription. The adjustment will apply to invoice dates that overlap with this start_date. This start_date is treated as inclusive for in-advance prices, and exclusive for in-arrears prices.

Example:

"2023-05-01"

add_adjustments.adjustment_id

string | null

The ID of the adjustment to add to the subscription. Adjustment IDs can be re-used from existing subscriptions or plans, but adjustments associated with coupon redemptions cannot be re-used.

Example:

"h74gfhdjvn7ujokd"

add_adjustments.adjustment

NewPercentageDiscount · object

The definition of a new adjustment to create and add to the subscription.

NewPercentageDiscount
NewUsageDiscount
NewAmountDiscount
NewMinimum
NewMaximum

Show child attributes

add_adjustments.adjustment.adjustment_type

enum<string>

required

Available options:

percentage_discount

add_adjustments.adjustment.percentage_discount

number

required

add_adjustments.adjustment.applies_to_price_ids

string[] | null

The set of price IDs to which this adjustment applies.

Example:

["price_1", "price_2"]

add_adjustments.adjustment.applies_to_item_ids

string[] | null

The set of item IDs to which this adjustment applies.

Example:

["item_1", "item_2"]

add_adjustments.adjustment.applies_to_all

enum<boolean> | null

If set, the adjustment will apply to every price on the subscription.

Available options:

true,

false

add_adjustments.adjustment.filters

PriceFilter · object[] | null

A list of filters that determine which prices this adjustment will apply to.

Show child attributes

add_adjustments.adjustment.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

add_adjustments.adjustment.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

add_adjustments.adjustment.filters.values

string[]

required

The IDs or values that match this filter.

add_adjustments.adjustment.currency

string | null

If set, only prices in the specified currency will have the adjustment applied.

Example:

["USD", "JPY", "credits"]

add_adjustments.adjustment.price_type

enum<string> | null

If set, only prices of the specified type will have the adjustment applied.

Available options:

usage,

fixed_in_advance,

fixed_in_arrears,

fixed,

in_arrears

add_adjustments.adjustment.is_invoice_level

boolean

default:true

When false, this adjustment will be applied to a single price. Otherwise, it will be applied at the invoice level, possibly to multiple prices.

add_adjustments.end_date

The end date of the adjustment interval. This is the date that the adjustment will stop affecting prices on the subscription. The adjustment will apply to invoice dates that overlap with this end_date.This end_date is treated as exclusive for in-advance prices, and inclusive for in-arrears prices.

Example:

"2023-07-10"

edit_adjustments

EditAdjustmentIntervalParams · object[]

A list of adjustments to edit on the subscription.

Show child attributes

edit_adjustments.adjustment_interval_id

string

required

The id of the adjustment interval to edit.

edit_adjustments.start_date

The updated start date of this adjustment interval. If not specified, the start date will not be updated.

Example:

"2023-05-01"

edit_adjustments.end_date

The updated end date of this adjustment interval. If not specified, the end date will not be updated.

Example:

"2023-07-10"

can_defer_billing

boolean | null

If set, the default value to use for added/edited price intervals with an end_date set.

allow_invoice_credit_or_void

boolean | null

default:true

If false, this request will fail if it would void an issued invoice or create a credit note. Consider using this as a safety mechanism if you do not expect existing invoices to be changed.

Response

metadata

Metadata · object

required

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

Show child attributes

metadata.{key}

string

required

customer

Customer · object

required

A customer is a buyer of your products, and the other party to the billing relationship.

In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an external_customer_id with your own identifier. See Customer ID Aliases for further information about how these aliases work in Orb.

In addition to having an identifier in your system, a customer may exist in a payment provider solution like Stripe. Use the payment_provider_id and the payment_provider enum field to express this mapping.

A customer also has a timezone (from the standard IANA timezone database), which defaults to your account's timezone. See Timezone localization for information on what this timezone parameter influences within Orb.

Show child attributes

customer.metadata

Metadata · object

required

Show child attributes

customer.metadata.{key}

string

customer.id

string

required

customer.external_customer_id

string | null

required

An optional user-defined ID for this customer resource, used throughout the system as an alias for this Customer. Use this field to identify a customer by an existing identifier in your system.

customer.name

string

required

The full name of the customer

customer.email

string

required

A valid customer email, to be used for notifications. When Orb triggers payment through a payment gateway, this email will be used for any automatically issued receipts.

customer.timezone

string

required

A timezone identifier from the IANA timezone database, such as "America/Los_Angeles". This "defaults to your account's timezone if not set. This cannot be changed after customer creation.

customer.payment_provider_id

string | null

required

The ID of this customer in an external payments solution, such as Stripe. This is used for creating charges or invoices in the external system via Orb.

customer.payment_provider

enum<string> | null

required

This is used for creating charges or invoices in an external system via Orb. When not in test mode, the connection must first be configured in the Orb webapp.

Available options:

quickbooks,

bill.com,

stripe_charge,

stripe_invoice,

netsuite

customer.created_at

string<date-time>

required

customer.shipping_address

Address · object

required

Show child attributes

customer.shipping_address.line1

string | null

required

customer.shipping_address.line2

string | null

required

customer.shipping_address.city

string | null

required

customer.shipping_address.state

string | null

required

customer.shipping_address.postal_code

string | null

required

customer.shipping_address.country

string | null

required

customer.billing_address

Address · object

required

Show child attributes

customer.billing_address.line1

string | null

required

customer.billing_address.line2

string | null

required

customer.billing_address.city

string | null

required

customer.billing_address.state

string | null

required

customer.billing_address.postal_code

string | null

required

customer.billing_address.country

string | null

required

customer.balance

string

required

The customer's current balance in their currency.

customer.currency

string | null

required

customer.tax_id

CustomerTaxId · object

required

Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices.

Supported Tax ID Countries and Types

Country	Type	Description
Albania	`al_tin`	Albania Tax Identification Number
Andorra	`ad_nrt`	Andorran NRT Number
Angola	`ao_tin`	Angola Tax Identification Number
Argentina	`ar_cuit`	Argentinian Tax ID Number
Armenia	`am_tin`	Armenia Tax Identification Number
Aruba	`aw_tin`	Aruba Tax Identification Number
Australia	`au_abn`	Australian Business Number (AU ABN)
Australia	`au_arn`	Australian Taxation Office Reference Number
Austria	`eu_vat`	European VAT Number
Azerbaijan	`az_tin`	Azerbaijan Tax Identification Number
Bahamas	`bs_tin`	Bahamas Tax Identification Number
Bahrain	`bh_vat`	Bahraini VAT Number
Bangladesh	`bd_bin`	Bangladesh Business Identification Number
Barbados	`bb_tin`	Barbados Tax Identification Number
Belarus	`by_tin`	Belarus TIN Number
Belgium	`eu_vat`	European VAT Number
Benin	`bj_ifu`	Benin Tax Identification Number (Identifiant Fiscal Unique)
Bolivia	`bo_tin`	Bolivian Tax ID
Bosnia and Herzegovina	`ba_tin`	Bosnia and Herzegovina Tax Identification Number
Brazil	`br_cnpj`	Brazilian CNPJ Number
Brazil	`br_cpf`	Brazilian CPF Number
Bulgaria	`bg_uic`	Bulgaria Unified Identification Code
Bulgaria	`eu_vat`	European VAT Number
Burkina Faso	`bf_ifu`	Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique)
Cambodia	`kh_tin`	Cambodia Tax Identification Number
Cameroon	`cm_niu`	Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique)
Canada	`ca_bn`	Canadian BN
Canada	`ca_gst_hst`	Canadian GST/HST Number
Canada	`ca_pst_bc`	Canadian PST Number (British Columbia)
Canada	`ca_pst_mb`	Canadian PST Number (Manitoba)
Canada	`ca_pst_sk`	Canadian PST Number (Saskatchewan)
Canada	`ca_qst`	Canadian QST Number (Québec)
Cape Verde	`cv_nif`	Cape Verde Tax Identification Number (Número de Identificação Fiscal)
Chile	`cl_tin`	Chilean TIN
China	`cn_tin`	Chinese Tax ID
Colombia	`co_nit`	Colombian NIT Number
Congo-Kinshasa	`cd_nif`	Congo (DR) Tax Identification Number (Número de Identificação Fiscal)
Costa Rica	`cr_tin`	Costa Rican Tax ID
Croatia	`eu_vat`	European VAT Number
Croatia	`hr_oib`	Croatian Personal Identification Number (OIB)
Cyprus	`eu_vat`	European VAT Number
Czech Republic	`eu_vat`	European VAT Number
Denmark	`eu_vat`	European VAT Number
Dominican Republic	`do_rcn`	Dominican RCN Number
Ecuador	`ec_ruc`	Ecuadorian RUC Number
Egypt	`eg_tin`	Egyptian Tax Identification Number
El Salvador	`sv_nit`	El Salvadorian NIT Number
Estonia	`eu_vat`	European VAT Number
Ethiopia	`et_tin`	Ethiopia Tax Identification Number
European Union	`eu_oss_vat`	European One Stop Shop VAT Number for non-Union scheme
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
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
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
Peru	`pe_ruc`	Peruvian RUC Number
Philippines	`ph_tin`	Philippines Tax Identification Number
Poland	`eu_vat`	European VAT Number
Portugal	`eu_vat`	European VAT Number
Romania	`eu_vat`	European VAT Number
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
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

Show child attributes

customer.tax_id.country

enum<string>

required

Available options:

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,

DE,

CY,

CZ,

DK,

DO,

EC,

EE,

EG,

ES,

ET,

EU,

FI,

FR,

GB,

GE,

GN,

GR,

HK,

HR,

HU,

ID,

IE,

IL,

IN,

IS,

IT,

JP,

KE,

KG,

KH,

KR,

KZ,

LA,

LI,

LT,

LU,

LV,

MA,

MD,

ME,

MK,

MR,

MT,

MX,

MY,

NG,

NL,

NO,

NP,

NZ,

OM,

PE,

PH,

PL,

PT,

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

customer.tax_id.type

enum<string>

required

Available options:

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,

gb_vat,

ge_vat,

gn_nif,

hk_br,

hr_oib,

hu_tin,

id_npwp,

il_vat,

in_gst,

is_vat,

jp_cn,

jp_rn,

jp_trn,

ke_pin,

kg_tin,

kh_tin,

kr_brn,

kz_bin,

la_tin,

li_uid,

li_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,

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

customer.tax_id.value

string

required

customer.auto_collection

boolean

required

customer.exempt_from_automated_tax

boolean | null

required

customer.email_delivery

boolean

required

customer.auto_issuance

boolean | null

required

Whether invoices for this customer should be automatically issued. If true, invoices will be automatically issued. If false, invoices will require manual approval. If null, inherits the account-level setting.

customer.additional_emails

string[]

required

customer.portal_url

string | null

required

customer.hierarchy

CustomerHierarchy · object

required

The hierarchical relationships for this customer.

Show child attributes

customer.hierarchy.parent

CustomerMinified · object

required

Show child attributes

customer.hierarchy.parent.id

string

required

customer.hierarchy.parent.external_customer_id

string | null

required

customer.hierarchy.children

CustomerMinified · object[]

required

Show child attributes

customer.hierarchy.children.id

string

required

customer.hierarchy.children.external_customer_id

string | null

required

customer.accounting_sync_configuration

AccountingSyncConfiguration · object

Show child attributes

customer.accounting_sync_configuration.excluded

boolean

required

customer.accounting_sync_configuration.accounting_providers

AccountingProvider · object[]

required

Show child attributes

customer.accounting_sync_configuration.accounting_providers.provider_type

enum<string>

required

Available options:

quickbooks,

netsuite

customer.accounting_sync_configuration.accounting_providers.external_provider_id

string | null

required

customer.reporting_configuration

ReportingConfiguration · object

Show child attributes

customer.reporting_configuration.exempt

boolean

required

customer.payment_configuration

PaymentConfiguration · object

Payment configuration for the customer, applicable when using Orb Invoicing with a supported payment provider such as Stripe.

Show child attributes

customer.payment_configuration.payment_providers

PaymentConfigurationItem · object[]

Provider-specific payment configuration.

Show child attributes

customer.payment_configuration.payment_providers.provider_type

enum<string>

required

The payment provider to configure.

Available options:

stripe

customer.payment_configuration.payment_providers.excluded_payment_method_types

string[]

List of Stripe payment method types to exclude for this customer. Excluded payment methods will not be available for the customer to select during payment, and will not be used for auto-collection. If a customer's default payment method becomes excluded, Orb will attempt to use the next available compatible payment method for auto-collection.

customer.automatic_tax_enabled

boolean | null

Whether automatic tax calculation is enabled for this customer. This field is nullable for backwards compatibility but will always return a boolean value.

plan

Plan · object

required

The Plan resource represents a plan that can be subscribed to by a customer. Plans define the billing behavior of the subscription. You can see more about how to configure prices in the Price resource.

Show child attributes

plan.metadata

Metadata · object

required

Show child attributes

plan.metadata.{key}

string

plan.id

string

required

plan.name

string

required

plan.description

string

required

plan.maximum_amount

string | null

required

deprecated

plan.minimum_amount

string | null

required

deprecated

plan.created_at

string<date-time>

required

plan.status

enum<string>

required

Available options:

active,

archived,

draft

plan.maximum

Maximum · object

required

deprecated

Show child attributes

plan.maximum.maximum_amount

string

required

Maximum amount applied

plan.maximum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this maximum to.

Show child attributes

plan.maximum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

plan.maximum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

plan.maximum.filters.values

string[]

required

The IDs or values that match this filter.

plan.maximum.applies_to_price_ids

string[]

required

deprecated

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

plan.minimum

Minimum · object

required

deprecated

Show child attributes

plan.minimum.minimum_amount

string

required

Minimum amount applied

plan.minimum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this minimum to.

Show child attributes

plan.minimum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

plan.minimum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

plan.minimum.filters.values

string[]

required

The IDs or values that match this filter.

plan.minimum.applies_to_price_ids

string[]

required

deprecated

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

plan.discount

PercentageDiscount · object

required

deprecated

PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount

Show child attributes

plan.discount.discount_type

enum<string>

required

Available options:

percentage

plan.discount.percentage_discount

number

required

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

Required range: 0 <= x <= 1

plan.discount.applies_to_price_ids

string[] | null

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

Example:

["h74gfhdjvn7ujokd", "7hfgtgjnbvc3ujkl"]

plan.discount.filters

PriceFilter · object[] | null

The filters that determine which prices to apply this discount to.

Show child attributes

plan.discount.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

plan.discount.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

plan.discount.filters.values

string[]

required

The IDs or values that match this filter.

plan.discount.reason

string | null

plan.product

Product · object

required

Show child attributes

plan.product.created_at

string<date-time>

required

plan.product.id

string

required

plan.product.name

string

required

plan.version

integer

required

plan.trial_config

TrialConfig · object

required

Show child attributes

plan.trial_config.trial_period

integer | null

required

plan.trial_config.trial_period_unit

enum<string>

required

Available options:

days

plan.plan_phases

PlanPhase · object[] | null

required

Show child attributes

plan.plan_phases.id

string

required

plan.plan_phases.description

string | null

required

plan.plan_phases.duration

integer | null

required

How many terms of length duration_unit this phase is active for. If null, this phase is evergreen and active indefinitely

plan.plan_phases.duration_unit

enum<string> | null

required

Available options:

daily,

monthly,

quarterly,

semi_annual,

annual

plan.plan_phases.name

string

required

plan.plan_phases.order

integer

required

Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.

plan.plan_phases.minimum

Minimum · object

required

Show child attributes

plan.plan_phases.minimum.minimum_amount

string

required

Minimum amount applied

plan.plan_phases.minimum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this minimum to.

Show child attributes

plan.plan_phases.minimum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

plan.plan_phases.minimum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

plan.plan_phases.minimum.filters.values

string[]

required

The IDs or values that match this filter.

plan.plan_phases.minimum.applies_to_price_ids

string[]

required

deprecated

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

plan.plan_phases.maximum

Maximum · object

required

Show child attributes

plan.plan_phases.maximum.maximum_amount

string

required

Maximum amount applied

plan.plan_phases.maximum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this maximum to.

Show child attributes

plan.plan_phases.maximum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

plan.plan_phases.maximum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

plan.plan_phases.maximum.filters.values

string[]

required

The IDs or values that match this filter.

plan.plan_phases.maximum.applies_to_price_ids

string[]

required

deprecated

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

plan.plan_phases.maximum_amount

string | null

required

plan.plan_phases.minimum_amount

string | null

required

plan.plan_phases.discount

PercentageDiscount · object

required

PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount

Show child attributes

plan.plan_phases.discount.discount_type

enum<string>

required

Available options:

percentage

plan.plan_phases.discount.percentage_discount

number

required

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

Required range: 0 <= x <= 1

plan.plan_phases.discount.applies_to_price_ids

string[] | null

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

Example:

["h74gfhdjvn7ujokd", "7hfgtgjnbvc3ujkl"]

plan.plan_phases.discount.filters

PriceFilter · object[] | null

The filters that determine which prices to apply this discount to.

Show child attributes

plan.plan_phases.discount.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

plan.plan_phases.discount.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

plan.plan_phases.discount.filters.values

string[]

required

The IDs or values that match this filter.

plan.plan_phases.discount.reason

string | null

plan.base_plan

PlanMinified · object

required

deprecated

Legacy field representing the parent plan if the current plan is a 'child plan', overriding prices from the parent.

Show child attributes

plan.base_plan.id

string | null

required

Example:

"m2t5akQeh2obwxeU"

plan.base_plan.external_plan_id

string | null

required

An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system.

Example:

"m2t5akQeh2obwxeU"

plan.base_plan.name

string | null

required

Example:

"Example plan"

plan.base_plan_id

string | null

required

deprecated

Legacy field representing the parent plan ID if the current plan is a 'child plan', overriding prices from the parent.

plan.external_plan_id

string | null

required

An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system.

plan.currency

string

required

deprecated

An ISO 4217 currency string or custom pricing unit (credits) for this plan's prices.

plan.invoicing_currency

string

required

An ISO 4217 currency string for which this plan is billed in. Matches currency unless currency is a custom pricing unit.

plan.net_terms

integer | null

required

Determines the difference between the invoice issue date and the due date. A value of "0" here signifies that invoices are due on issue, whereas a value of "30" means that the customer has a month to pay the invoice before its overdue. Note that individual subscriptions or invoices may set a different net terms configuration.

plan.default_invoice_memo

string | null

required

The default memo text on the invoices corresponding to subscriptions on this plan. Note that each subscription may configure its own memo.

plan.prices

required

Prices for this plan. If the plan has phases, this includes prices across all phases of the plan.

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

UnitPrice
TieredPrice
BulkPrice
BulkWithFiltersPrice
PackagePrice
MatrixPrice
ThresholdTotalAmountPrice
TieredPackagePrice
TieredWithMinimumPrice
GroupedTieredPrice
TieredPackageWithMinimumPrice
PackageWithAllocationPrice
UnitWithPercentPrice
MatrixWithAllocationPrice
TieredWithProrationPrice
UnitWithProrationPrice
GroupedAllocationPrice
BulkWithProrationPrice
GroupedWithProratedMinimumPrice
GroupedWithMeteredMinimumPrice
GroupedWithMinMaxThresholdsPrice
MatrixWithDisplayNamePrice
GroupedTieredPackagePrice
MaxGroupTieredPackagePrice
ScalableMatrixWithUnitPricingPrice
ScalableMatrixWithTieredPricingPrice
CumulativeGroupedBulkPrice
CumulativeGroupedAllocationPrice
MinimumCompositePrice
PercentCompositePrice
EventOutputPrice

Show child attributes

plan.prices.model_type

enum<string>

required

The pricing model type

Available options:

unit

plan.prices.unit_config

UnitConfig · object

required

Configuration for unit pricing

Show child attributes

plan.prices.unit_config.unit_amount

string

required

Rate per unit of usage

plan.prices.unit_config.prorated

boolean

default:false

If true, subtotals from this price are prorated based on the service period

plan.prices.metadata

Metadata · object

required

Show child attributes

plan.prices.metadata.{key}

string

plan.prices.id

string

required

plan.prices.name

string

required

plan.prices.external_price_id

string | null

required

plan.prices.replaces_price_id

string | null

required

The price id this price replaces. This price will take the place of the replaced price in plan version migrations.

plan.prices.price_type

enum<string>

required

Available options:

usage_price,

fixed_price,

composite_price

plan.prices.created_at

string<date-time>

required

plan.prices.cadence

enum<string>

required

Available options:

one_time,

monthly,

quarterly,

semi_annual,

annual,

custom

plan.prices.billing_mode

enum<string>

required

Available options:

in_advance,

in_arrear

plan.prices.billing_cycle_configuration

BillingCycleConfiguration · object

required

Show child attributes

plan.prices.billing_cycle_configuration.duration

integer

required

plan.prices.billing_cycle_configuration.duration_unit

enum<string>

required

Available options:

day,

month

plan.prices.invoicing_cycle_configuration

BillingCycleConfiguration · object

required

Show child attributes

plan.prices.invoicing_cycle_configuration.duration

integer

required

plan.prices.invoicing_cycle_configuration.duration_unit

enum<string>

required

Available options:

day,

month

plan.prices.billable_metric

BillableMetricTiny · object

required

Show child attributes

plan.prices.billable_metric.id

string

required

plan.prices.fixed_price_quantity

number | null

required

plan.prices.plan_phase_order

integer | null

required

plan.prices.currency

string

required

plan.prices.conversion_rate

number | null

required

plan.prices.conversion_rate_config

UnitConversionRateConfig · object

required

UnitConversionRateConfig
TieredConversionRateConfig

Show child attributes

plan.prices.conversion_rate_config.conversion_rate_type

enum<string>

required

Available options:

unit

plan.prices.conversion_rate_config.unit_config

ConversionRateUnitConfig · object

required

Show child attributes

plan.prices.conversion_rate_config.unit_config.unit_amount

string

required

Amount per unit of overage

plan.prices.item

ItemSlim · object

required

A minimal representation of an Item containing only the essential identifying information.

Show child attributes

plan.prices.item.id

string

required

The Orb-assigned unique identifier for the item.

plan.prices.item.name

string

required

The name of the item.

plan.prices.credit_allocation

Allocation · object

required

Show child attributes

plan.prices.credit_allocation.currency

string

required

plan.prices.credit_allocation.allows_rollover

boolean

required

plan.prices.credit_allocation.custom_expiration

CustomExpiration · object

required

Show child attributes

plan.prices.credit_allocation.custom_expiration.duration

integer

required

plan.prices.credit_allocation.custom_expiration.duration_unit

enum<string>

required

Available options:

day,

month

plan.prices.credit_allocation.filters

PriceFilter · object[]

Show child attributes

plan.prices.credit_allocation.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

plan.prices.credit_allocation.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

plan.prices.credit_allocation.filters.values

string[]

required

The IDs or values that match this filter.

plan.prices.composite_price_filters

PriceFilter · object[] | null

required

Show child attributes

plan.prices.composite_price_filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

plan.prices.composite_price_filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

plan.prices.composite_price_filters.values

string[]

required

The IDs or values that match this filter.

plan.prices.discount

PercentageDiscount · object

required

deprecated

PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount

Show child attributes

plan.prices.discount.discount_type

enum<string>

required

Available options:

percentage

plan.prices.discount.percentage_discount

number

required

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

Required range: 0 <= x <= 1

plan.prices.discount.applies_to_price_ids

string[] | null

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

Example:

["h74gfhdjvn7ujokd", "7hfgtgjnbvc3ujkl"]

plan.prices.discount.filters

PriceFilter · object[] | null

The filters that determine which prices to apply this discount to.

Show child attributes

plan.prices.discount.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

plan.prices.discount.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

plan.prices.discount.filters.values

string[]

required

The IDs or values that match this filter.

plan.prices.discount.reason

string | null

plan.prices.minimum

Minimum · object

required

deprecated

Show child attributes

plan.prices.minimum.minimum_amount

string

required

Minimum amount applied

plan.prices.minimum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this minimum to.

Show child attributes

plan.prices.minimum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

plan.prices.minimum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

plan.prices.minimum.filters.values

string[]

required

The IDs or values that match this filter.

plan.prices.minimum.applies_to_price_ids

string[]

required

deprecated

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

plan.prices.minimum_amount

string | null

required

deprecated

plan.prices.maximum

Maximum · object

required

deprecated

Show child attributes

plan.prices.maximum.maximum_amount

string

required

Maximum amount applied

plan.prices.maximum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this maximum to.

Show child attributes

plan.prices.maximum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

plan.prices.maximum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

plan.prices.maximum.filters.values

string[]

required

The IDs or values that match this filter.

plan.prices.maximum.applies_to_price_ids

string[]

required

deprecated

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

plan.prices.maximum_amount

string | null

required

deprecated

plan.prices.dimensional_price_configuration

DimensionalPriceConfiguration · object

Show child attributes

plan.prices.dimensional_price_configuration.dimensional_price_group_id

string

required

plan.prices.dimensional_price_configuration.dimension_values

string[]

required

plan.adjustments

(PlanPhaseUsageDiscountAdjustment · object | PlanPhaseAmountDiscountAdjustment · object | PlanPhasePercentageDiscountAdjustment · object | PlanPhaseMinimumAdjustment · object | PlanPhaseMaximumAdjustment · object)[]

required

Adjustments for this plan. If the plan has phases, this includes adjustments across all phases of the plan.

PlanPhaseUsageDiscountAdjustment
PlanPhaseAmountDiscountAdjustment
PlanPhasePercentageDiscountAdjustment
PlanPhaseMinimumAdjustment
PlanPhaseMaximumAdjustment

Show child attributes

plan.adjustments.id

string

required

plan.adjustments.is_invoice_level

boolean

required

True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price.

plan.adjustments.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this adjustment to.

Show child attributes

plan.adjustments.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

plan.adjustments.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

plan.adjustments.filters.values

string[]

required

The IDs or values that match this filter.

plan.adjustments.applies_to_price_ids

string[]

required

deprecated

The price IDs that this adjustment applies to.

plan.adjustments.reason

string | null

required

The reason for the adjustment.

plan.adjustments.replaces_adjustment_id

string | null

required

The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations.

plan.adjustments.adjustment_type

enum<string>

required

Available options:

usage_discount

plan.adjustments.usage_discount

number

required

The number of usage units by which to discount the price this adjustment applies to in a given billing period.

plan.adjustments.plan_phase_order

integer | null

required

The plan phase in which this adjustment is active.

name

string

required

The name of the subscription.

start_date

string<date-time>

required

The date Orb starts billing for this subscription.

end_date

string<date-time> | null

required

The date Orb stops billing for this subscription.

created_at

string<date-time>

required

current_billing_period_start_date

string<date-time> | null

required

The start date of the current billing period. This is an inclusive timestamp; the instant returned is exactly the beginning of the billing period. Set to null if the subscription is not currently active.

current_billing_period_end_date

string<date-time> | null

required

The end of the current billing period. This is an exclusive timestamp, such that the instant returned is not part of the billing period. Set to null for subscriptions that are not currently active.

status

enum<string>

required

Available options:

active,

ended,

upcoming

trial_info

SubscriptionTrialInfo · object

required

Show child attributes

trial_info.end_date

string<date-time> | null

required

active_plan_phase_order

integer | null

required

The current plan phase that is active, only if the subscription's plan has phases.

fixed_fee_quantity_schedule

FixedFeeQuantityScheduleEntry · object[]

required

Show child attributes

fixed_fee_quantity_schedule.price_id

string

required

fixed_fee_quantity_schedule.start_date

string<date-time>

required

fixed_fee_quantity_schedule.end_date

string<date-time> | null

required

fixed_fee_quantity_schedule.quantity

number

required

default_invoice_memo

string | null

required

Determines the default memo on this subscriptions' invoices. Note that if this is not provided, it is determined by the plan configuration.

auto_collection

boolean | null

required

Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date. This property defaults to the plan's behavior. If null, defaults to the customer's setting.

net_terms

integer

required

Determines the difference between the invoice issue date for subscription invoices as the date that they are due. A value of 0 here represents that the invoice is due on issue, whereas a value of 30 represents that the customer has a month to pay the invoice.

redeemed_coupon

CouponRedemption · object

required

Show child attributes

redeemed_coupon.coupon_id

string

required

redeemed_coupon.start_date

string<date-time>

required

redeemed_coupon.end_date

string<date-time> | null

required

billing_cycle_day

integer

required

The day of the month on which the billing cycle is anchored. If the maximum number of days in a month is greater than this value, the last day of the month is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing period begins on the 30th.

Required range: 1 <= x <= 31

billing_cycle_anchor_configuration

BillingCycleAnchorConfiguration · object

required

Show child attributes

billing_cycle_anchor_configuration.day

integer

required

Required range: 1 <= x <= 31

billing_cycle_anchor_configuration.month

integer | null

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

Required range: 1 <= x <= 12

billing_cycle_anchor_configuration.year

integer | null

The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).

invoicing_threshold

string | null

required

price_intervals

PriceInterval · object[]

required

The price intervals for this subscription.

Show child attributes

price_intervals.id

string

required

price_intervals.start_date

string<date-time>

required

The start date of the price interval. This is the date that Orb starts billing for this price.

price_intervals.end_date

string<date-time> | null

required

The end date of the price interval. This is the date that Orb stops billing for this price.

price_intervals.price

UnitPrice · object

required

For more on the types of prices, see the core concepts documentation

UnitPrice
TieredPrice
BulkPrice
BulkWithFiltersPrice
PackagePrice
MatrixPrice
ThresholdTotalAmountPrice
TieredPackagePrice
TieredWithMinimumPrice
GroupedTieredPrice
TieredPackageWithMinimumPrice
PackageWithAllocationPrice
UnitWithPercentPrice
MatrixWithAllocationPrice
TieredWithProrationPrice
UnitWithProrationPrice
GroupedAllocationPrice
BulkWithProrationPrice
GroupedWithProratedMinimumPrice
GroupedWithMeteredMinimumPrice
GroupedWithMinMaxThresholdsPrice
MatrixWithDisplayNamePrice
GroupedTieredPackagePrice
MaxGroupTieredPackagePrice
ScalableMatrixWithUnitPricingPrice
ScalableMatrixWithTieredPricingPrice
CumulativeGroupedBulkPrice
CumulativeGroupedAllocationPrice
MinimumCompositePrice
PercentCompositePrice
EventOutputPrice

Show child attributes

price_intervals.price.model_type

enum<string>

required

The pricing model type

Available options:

unit

price_intervals.price.unit_config

UnitConfig · object

required

Configuration for unit pricing

Show child attributes

price_intervals.price.unit_config.unit_amount

string

required

Rate per unit of usage

price_intervals.price.unit_config.prorated

boolean

default:false

If true, subtotals from this price are prorated based on the service period

price_intervals.price.metadata

Metadata · object

required

Show child attributes

price_intervals.price.metadata.{key}

string

price_intervals.price.id

string

required

price_intervals.price.name

string

required

price_intervals.price.external_price_id

string | null

required

price_intervals.price.replaces_price_id

string | null

required

The price id this price replaces. This price will take the place of the replaced price in plan version migrations.

price_intervals.price.price_type

enum<string>

required

Available options:

usage_price,

fixed_price,

composite_price

price_intervals.price.created_at

string<date-time>

required

price_intervals.price.cadence

enum<string>

required

Available options:

one_time,

monthly,

quarterly,

semi_annual,

annual,

custom

price_intervals.price.billing_mode

enum<string>

required

Available options:

in_advance,

in_arrear

price_intervals.price.billing_cycle_configuration

BillingCycleConfiguration · object

required

Show child attributes

price_intervals.price.billing_cycle_configuration.duration

integer

required

price_intervals.price.billing_cycle_configuration.duration_unit

enum<string>

required

Available options:

day,

month

price_intervals.price.invoicing_cycle_configuration

BillingCycleConfiguration · object

required

Show child attributes

price_intervals.price.invoicing_cycle_configuration.duration

integer

required

price_intervals.price.invoicing_cycle_configuration.duration_unit

enum<string>

required

Available options:

day,

month

price_intervals.price.billable_metric

BillableMetricTiny · object

required

Show child attributes

price_intervals.price.billable_metric.id

string

required

price_intervals.price.fixed_price_quantity

number | null

required

price_intervals.price.plan_phase_order

integer | null

required

price_intervals.price.currency

string

required

price_intervals.price.conversion_rate

number | null

required

price_intervals.price.conversion_rate_config

UnitConversionRateConfig · object

required

UnitConversionRateConfig
TieredConversionRateConfig

Show child attributes

price_intervals.price.conversion_rate_config.conversion_rate_type

enum<string>

required

Available options:

unit

price_intervals.price.conversion_rate_config.unit_config

ConversionRateUnitConfig · object

required

Show child attributes

price_intervals.price.conversion_rate_config.unit_config.unit_amount

string

required

Amount per unit of overage

price_intervals.price.item

ItemSlim · object

required

A minimal representation of an Item containing only the essential identifying information.

Show child attributes

price_intervals.price.item.id

string

required

The Orb-assigned unique identifier for the item.

price_intervals.price.item.name

string

required

The name of the item.

price_intervals.price.credit_allocation

Allocation · object

required

Show child attributes

price_intervals.price.credit_allocation.currency

string

required

price_intervals.price.credit_allocation.allows_rollover

boolean

required

price_intervals.price.credit_allocation.custom_expiration

CustomExpiration · object

required

Show child attributes

price_intervals.price.credit_allocation.custom_expiration.duration

integer

required

price_intervals.price.credit_allocation.custom_expiration.duration_unit

enum<string>

required

Available options:

day,

month

price_intervals.price.credit_allocation.filters

PriceFilter · object[]

Show child attributes

price_intervals.price.credit_allocation.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

price_intervals.price.credit_allocation.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

price_intervals.price.credit_allocation.filters.values

string[]

required

The IDs or values that match this filter.

price_intervals.price.composite_price_filters

PriceFilter · object[] | null

required

Show child attributes

price_intervals.price.composite_price_filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

price_intervals.price.composite_price_filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

price_intervals.price.composite_price_filters.values

string[]

required

The IDs or values that match this filter.

price_intervals.price.discount

PercentageDiscount · object

required

deprecated

PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount

Show child attributes

price_intervals.price.discount.discount_type

enum<string>

required

Available options:

percentage

price_intervals.price.discount.percentage_discount

number

required

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

Required range: 0 <= x <= 1

price_intervals.price.discount.applies_to_price_ids

string[] | null

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

Example:

["h74gfhdjvn7ujokd", "7hfgtgjnbvc3ujkl"]

price_intervals.price.discount.filters

PriceFilter · object[] | null

The filters that determine which prices to apply this discount to.

Show child attributes

price_intervals.price.discount.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

price_intervals.price.discount.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

price_intervals.price.discount.filters.values

string[]

required

The IDs or values that match this filter.

price_intervals.price.discount.reason

string | null

price_intervals.price.minimum

Minimum · object

required

deprecated

Show child attributes

price_intervals.price.minimum.minimum_amount

string

required

Minimum amount applied

price_intervals.price.minimum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this minimum to.

Show child attributes

price_intervals.price.minimum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

price_intervals.price.minimum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

price_intervals.price.minimum.filters.values

string[]

required

The IDs or values that match this filter.

price_intervals.price.minimum.applies_to_price_ids

string[]

required

deprecated

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

price_intervals.price.minimum_amount

string | null

required

deprecated

price_intervals.price.maximum

Maximum · object

required

deprecated

Show child attributes

price_intervals.price.maximum.maximum_amount

string

required

Maximum amount applied

price_intervals.price.maximum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this maximum to.

Show child attributes

price_intervals.price.maximum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

price_intervals.price.maximum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

price_intervals.price.maximum.filters.values

string[]

required

The IDs or values that match this filter.

price_intervals.price.maximum.applies_to_price_ids

string[]

required

deprecated

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

price_intervals.price.maximum_amount

string | null

required

deprecated

price_intervals.price.dimensional_price_configuration

DimensionalPriceConfiguration · object

Show child attributes

price_intervals.price.dimensional_price_configuration.dimensional_price_group_id

string

required

price_intervals.price.dimensional_price_configuration.dimension_values

string[]

required

price_intervals.billing_cycle_day

integer

required

The day of the month that Orb bills for this price

price_intervals.can_defer_billing

boolean

required

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.

price_intervals.fixed_fee_quantity_transitions

FixedFeeQuantityTransition · object[] | null

required

The fixed fee quantity transitions for this price interval. This is only relevant for fixed fees.

Show child attributes

price_intervals.fixed_fee_quantity_transitions.price_id

string

required

price_intervals.fixed_fee_quantity_transitions.effective_date

string<date-time>

required

price_intervals.fixed_fee_quantity_transitions.quantity

integer

required

price_intervals.current_billing_period_start_date

string<date-time> | null

required

The start date of the current billing period. This is an inclusive timestamp; the instant returned is exactly the beginning of the billing period. Set to null if this price interval is not currently active.

price_intervals.current_billing_period_end_date

string<date-time> | null

required

The end of the current billing period. This is an exclusive timestamp, such that the instant returned is exactly the end of the billing period. Set to null if this price interval is not currently active.

price_intervals.filter

string | null

required

An additional filter to apply to usage queries.

price_intervals.usage_customer_ids

string[] | null

required

A list of customer IDs whose usage events will be aggregated and billed under this price interval.

adjustment_intervals

AdjustmentInterval · object[]

required

The adjustment intervals for this subscription sorted by the start_date of the adjustment interval.

Show child attributes

adjustment_intervals.id

string

required

adjustment_intervals.adjustment

PlanPhaseUsageDiscountAdjustment · object

required

PlanPhaseUsageDiscountAdjustment
PlanPhaseAmountDiscountAdjustment
PlanPhasePercentageDiscountAdjustment
PlanPhaseMinimumAdjustment
PlanPhaseMaximumAdjustment

Show child attributes

adjustment_intervals.adjustment.id

string

required

adjustment_intervals.adjustment.is_invoice_level

boolean

required

True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price.

adjustment_intervals.adjustment.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this adjustment to.

Show child attributes

adjustment_intervals.adjustment.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

adjustment_intervals.adjustment.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

adjustment_intervals.adjustment.filters.values

string[]

required

The IDs or values that match this filter.

adjustment_intervals.adjustment.applies_to_price_ids

string[]

required

deprecated

The price IDs that this adjustment applies to.

adjustment_intervals.adjustment.reason

string | null

required

The reason for the adjustment.

adjustment_intervals.adjustment.replaces_adjustment_id

string | null

required

The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations.

adjustment_intervals.adjustment.adjustment_type

enum<string>

required

Available options:

usage_discount

adjustment_intervals.adjustment.usage_discount

number

required

The number of usage units by which to discount the price this adjustment applies to in a given billing period.

adjustment_intervals.adjustment.plan_phase_order

integer | null

required

The plan phase in which this adjustment is active.

adjustment_intervals.start_date

string<date-time>

required

The start date of the adjustment interval.

adjustment_intervals.end_date

string<date-time> | null

required

The end date of the adjustment interval.

adjustment_intervals.applies_to_price_interval_ids

string[]

required

The price interval IDs that this adjustment applies to.

discount_intervals

(AmountDiscountInterval · object | PercentageDiscountInterval · object | UsageDiscountInterval · object)[]

required

deprecated

The discount intervals for this subscription sorted by the start_date. This field is deprecated in favor of adjustment_intervals.

AmountDiscountInterval
PercentageDiscountInterval
UsageDiscountInterval

Show child attributes

discount_intervals.discount_type

enum<string>

required

Available options:

amount

discount_intervals.amount_discount

string

required

Only available if discount_type is amount.

discount_intervals.start_date

string<date-time>

required

The start date of the discount interval.

discount_intervals.end_date

string<date-time> | null

required

The end date of the discount interval.

discount_intervals.filters

PriceFilter · object[]

required

The filters that determine which prices this discount interval applies to.

Show child attributes

discount_intervals.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

discount_intervals.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

discount_intervals.filters.values

string[]

required

The IDs or values that match this filter.

discount_intervals.applies_to_price_interval_ids

string[]

required

The price interval ids that this discount interval applies to.

minimum_intervals

MinimumInterval · object[]

required

deprecated

The minimum intervals for this subscription sorted by the start_date. This field is deprecated in favor of adjustment_intervals.

Show child attributes

minimum_intervals.start_date

string<date-time>

required

The start date of the minimum interval.

minimum_intervals.end_date

string<date-time> | null

required

The end date of the minimum interval.

minimum_intervals.filters

PriceFilter · object[]

required

The filters that determine which prices this minimum interval applies to.

Show child attributes

minimum_intervals.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

minimum_intervals.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

minimum_intervals.filters.values

string[]

required

The IDs or values that match this filter.

minimum_intervals.applies_to_price_interval_ids

string[]

required

The price interval ids that this minimum interval applies to.

minimum_intervals.minimum_amount

string

required

The minimum amount to charge in a given billing period for the price intervals this minimum applies to.

maximum_intervals

MaximumInterval · object[]

required

deprecated

The maximum intervals for this subscription sorted by the start_date. This field is deprecated in favor of adjustment_intervals.

Show child attributes

maximum_intervals.start_date

string<date-time>

required

The start date of the maximum interval.

maximum_intervals.end_date

string<date-time> | null

required

The end date of the maximum interval.

maximum_intervals.filters

PriceFilter · object[]

required

The filters that determine which prices this maximum interval applies to.

Show child attributes

maximum_intervals.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

maximum_intervals.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

maximum_intervals.filters.values

string[]

required

The IDs or values that match this filter.

maximum_intervals.applies_to_price_interval_ids

string[]

required

The price interval ids that this maximum interval applies to.

maximum_intervals.maximum_amount

string

required

The maximum amount to charge in a given billing period for the price intervals this transform applies to.

pending_subscription_change

SubscriptionChangeMinified · object

required

A pending subscription change if one exists on this subscription.

Show child attributes

pending_subscription_change.id

string

required

changed_resources

ChangedSubscriptionResources · object

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.

Show child attributes

changed_resources.created_credit_notes

CreditNote · object[]

required

The credit notes that were created as part of this operation.

Show child attributes

changed_resources.created_credit_notes.id

string

required

The Orb id of this credit note.

changed_resources.created_credit_notes.created_at

string<date-time>

required

The creation time of the resource in Orb.

changed_resources.created_credit_notes.voided_at

string<date-time> | null

required

The time at which the credit note was voided in Orb, if applicable.

changed_resources.created_credit_notes.credit_note_number

string

required

The unique identifier for credit notes.

changed_resources.created_credit_notes.invoice_id

string

required

The id of the invoice resource that this credit note is applied to.

changed_resources.created_credit_notes.memo

string | null

required

An optional memo supplied on the credit note.

changed_resources.created_credit_notes.reason

enum<string> | null

required

Available options:

Duplicate,

Fraudulent,

Order change,

Product unsatisfactory

changed_resources.created_credit_notes.type

enum<string>

required

Available options:

refund,

adjustment

changed_resources.created_credit_notes.subtotal

string

required

The total prior to any creditable invoice-level discounts or minimums.

changed_resources.created_credit_notes.total

string

required

The total including creditable invoice-level discounts or minimums, and tax.

changed_resources.created_credit_notes.customer

CustomerMinified · object

required

Show child attributes

changed_resources.created_credit_notes.customer.id

string

required

changed_resources.created_credit_notes.customer.external_customer_id

string | null

required

changed_resources.created_credit_notes.credit_note_pdf

string | null

required

A URL to a PDF of the credit note.

changed_resources.created_credit_notes.minimum_amount_refunded

string | null

required

Any credited amount from the applied minimum on the invoice.

changed_resources.created_credit_notes.maximum_amount_adjustment

CreditNoteDiscount · object

required

The maximum amount applied on the original invoice

Show child attributes

changed_resources.created_credit_notes.maximum_amount_adjustment.discount_type

enum<string>

required

Available options:

percentage

changed_resources.created_credit_notes.maximum_amount_adjustment.percentage_discount

number

required

changed_resources.created_credit_notes.maximum_amount_adjustment.amount_applied

string

required

changed_resources.created_credit_notes.maximum_amount_adjustment.reason

string | null

changed_resources.created_credit_notes.maximum_amount_adjustment.applies_to_prices

CreditNoteDiscountAppliesToPrice · object[] | null

Show child attributes

changed_resources.created_credit_notes.maximum_amount_adjustment.applies_to_prices.id

string

required

changed_resources.created_credit_notes.maximum_amount_adjustment.applies_to_prices.name

string

required

changed_resources.created_credit_notes.line_items

CreditNoteLineItem · object[]

required

All of the line items associated with this credit note.

Show child attributes

changed_resources.created_credit_notes.line_items.id

string

required

The Orb id of this resource.

changed_resources.created_credit_notes.line_items.name

string

required

The name of the corresponding invoice line item.

changed_resources.created_credit_notes.line_items.subtotal

string

required

The amount of the line item, excluding any line item minimums and discounts.

changed_resources.created_credit_notes.line_items.amount

string

required

The amount of the line item, including any line item minimums and discounts.

changed_resources.created_credit_notes.line_items.quantity

number | null

required

An optional quantity credited.

changed_resources.created_credit_notes.line_items.tax_amounts

TaxAmount · object[]

required

Any tax amounts applied onto the line item.

Show child attributes

changed_resources.created_credit_notes.line_items.tax_amounts.tax_rate_description

string

required

The human-readable description of the applied tax rate.

changed_resources.created_credit_notes.line_items.tax_amounts.tax_rate_percentage

string | null

required

The tax rate percentage, out of 100.

changed_resources.created_credit_notes.line_items.tax_amounts.amount

string

required

The amount of additional tax incurred by this tax rate.

changed_resources.created_credit_notes.line_items.item_id

string

required

The id of the item associated with this line item.

changed_resources.created_credit_notes.line_items.discounts

CreditNoteLineItemDiscount · object[]

Any line item discounts from the invoice's line item.

Show child attributes

changed_resources.created_credit_notes.line_items.discounts.id

string

required

changed_resources.created_credit_notes.line_items.discounts.discount_type

enum<string>

required

Available options:

percentage,

amount

changed_resources.created_credit_notes.line_items.discounts.percentage_discount

number

required

changed_resources.created_credit_notes.line_items.discounts.amount_applied

string

required

changed_resources.created_credit_notes.line_items.discounts.applies_to_price_ids

string[]

required

changed_resources.created_credit_notes.line_items.discounts.amount_discount

string | null

changed_resources.created_credit_notes.line_items.discounts.reason

string | null

changed_resources.created_credit_notes.line_items.start_time_inclusive

string<date-time> | null

The start time of the service period for this credit note line item.

changed_resources.created_credit_notes.line_items.end_time_exclusive

string<date-time> | null

The end time of the service period for this credit note line item.

changed_resources.created_credit_notes.discounts

CreditNoteDiscount · object[]

Any discounts applied on the original invoice.

Show child attributes

changed_resources.created_credit_notes.discounts.discount_type

enum<string>

required

Available options:

percentage

changed_resources.created_credit_notes.discounts.percentage_discount

number

required

changed_resources.created_credit_notes.discounts.amount_applied

string

required

changed_resources.created_credit_notes.discounts.reason

string | null

changed_resources.created_credit_notes.discounts.applies_to_prices

CreditNoteDiscountAppliesToPrice · object[] | null

Show child attributes

changed_resources.created_credit_notes.discounts.applies_to_prices.id

string

required

changed_resources.created_credit_notes.discounts.applies_to_prices.name

string

required

changed_resources.voided_credit_notes

CreditNote · object[]

required

The credit notes that were voided as part of this operation.

Show child attributes

changed_resources.voided_credit_notes.id

string

required

The Orb id of this credit note.

changed_resources.voided_credit_notes.created_at

string<date-time>

required

The creation time of the resource in Orb.

changed_resources.voided_credit_notes.voided_at

string<date-time> | null

required

The time at which the credit note was voided in Orb, if applicable.

changed_resources.voided_credit_notes.credit_note_number

string

required

The unique identifier for credit notes.

changed_resources.voided_credit_notes.invoice_id

string

required

The id of the invoice resource that this credit note is applied to.

changed_resources.voided_credit_notes.memo

string | null

required

An optional memo supplied on the credit note.

changed_resources.voided_credit_notes.reason

enum<string> | null

required

Available options:

Duplicate,

Fraudulent,

Order change,

Product unsatisfactory

changed_resources.voided_credit_notes.type

enum<string>

required

Available options:

refund,

adjustment

changed_resources.voided_credit_notes.subtotal

string

required

The total prior to any creditable invoice-level discounts or minimums.

changed_resources.voided_credit_notes.total

string

required

The total including creditable invoice-level discounts or minimums, and tax.

changed_resources.voided_credit_notes.customer

CustomerMinified · object

required

Show child attributes

changed_resources.voided_credit_notes.customer.id

string

required

changed_resources.voided_credit_notes.customer.external_customer_id

string | null

required

changed_resources.voided_credit_notes.credit_note_pdf

string | null

required

A URL to a PDF of the credit note.

changed_resources.voided_credit_notes.minimum_amount_refunded

string | null

required

Any credited amount from the applied minimum on the invoice.

changed_resources.voided_credit_notes.maximum_amount_adjustment

CreditNoteDiscount · object

required

The maximum amount applied on the original invoice

Show child attributes

changed_resources.voided_credit_notes.maximum_amount_adjustment.discount_type

enum<string>

required

Available options:

percentage

changed_resources.voided_credit_notes.maximum_amount_adjustment.percentage_discount

number

required

changed_resources.voided_credit_notes.maximum_amount_adjustment.amount_applied

string

required

changed_resources.voided_credit_notes.maximum_amount_adjustment.reason

string | null

changed_resources.voided_credit_notes.maximum_amount_adjustment.applies_to_prices

CreditNoteDiscountAppliesToPrice · object[] | null

Show child attributes

changed_resources.voided_credit_notes.maximum_amount_adjustment.applies_to_prices.id

string

required

changed_resources.voided_credit_notes.maximum_amount_adjustment.applies_to_prices.name

string

required

changed_resources.voided_credit_notes.line_items

CreditNoteLineItem · object[]

required

All of the line items associated with this credit note.

Show child attributes

changed_resources.voided_credit_notes.line_items.id

string

required

The Orb id of this resource.

changed_resources.voided_credit_notes.line_items.name

string

required

The name of the corresponding invoice line item.

changed_resources.voided_credit_notes.line_items.subtotal

string

required

The amount of the line item, excluding any line item minimums and discounts.

changed_resources.voided_credit_notes.line_items.amount

string

required

The amount of the line item, including any line item minimums and discounts.

changed_resources.voided_credit_notes.line_items.quantity

number | null

required

An optional quantity credited.

changed_resources.voided_credit_notes.line_items.tax_amounts

TaxAmount · object[]

required

Any tax amounts applied onto the line item.

Show child attributes

changed_resources.voided_credit_notes.line_items.tax_amounts.tax_rate_description

string

required

The human-readable description of the applied tax rate.

changed_resources.voided_credit_notes.line_items.tax_amounts.tax_rate_percentage

string | null

required

The tax rate percentage, out of 100.

changed_resources.voided_credit_notes.line_items.tax_amounts.amount

string

required

The amount of additional tax incurred by this tax rate.

changed_resources.voided_credit_notes.line_items.item_id

string

required

The id of the item associated with this line item.

changed_resources.voided_credit_notes.line_items.discounts

CreditNoteLineItemDiscount · object[]

Any line item discounts from the invoice's line item.

Show child attributes

changed_resources.voided_credit_notes.line_items.discounts.id

string

required

changed_resources.voided_credit_notes.line_items.discounts.discount_type

enum<string>

required

Available options:

percentage,

amount

changed_resources.voided_credit_notes.line_items.discounts.percentage_discount

number

required

changed_resources.voided_credit_notes.line_items.discounts.amount_applied

string

required

changed_resources.voided_credit_notes.line_items.discounts.applies_to_price_ids

string[]

required

changed_resources.voided_credit_notes.line_items.discounts.amount_discount

string | null

changed_resources.voided_credit_notes.line_items.discounts.reason

string | null

changed_resources.voided_credit_notes.line_items.start_time_inclusive

string<date-time> | null

The start time of the service period for this credit note line item.

changed_resources.voided_credit_notes.line_items.end_time_exclusive

string<date-time> | null

The end time of the service period for this credit note line item.

changed_resources.voided_credit_notes.discounts

CreditNoteDiscount · object[]

Any discounts applied on the original invoice.

Show child attributes

changed_resources.voided_credit_notes.discounts.discount_type

enum<string>

required

Available options:

percentage

changed_resources.voided_credit_notes.discounts.percentage_discount

number

required

changed_resources.voided_credit_notes.discounts.amount_applied

string

required

changed_resources.voided_credit_notes.discounts.reason

string | null

changed_resources.voided_credit_notes.discounts.applies_to_prices

CreditNoteDiscountAppliesToPrice · object[] | null

Show child attributes

changed_resources.voided_credit_notes.discounts.applies_to_prices.id

string

required

changed_resources.voided_credit_notes.discounts.applies_to_prices.name

string

required

changed_resources.created_invoices

CreatedInvoice · object[]

required

The invoices that were created as part of this operation.

Show child attributes

changed_resources.created_invoices.metadata

Metadata · object

required

Show child attributes

changed_resources.created_invoices.metadata.{key}

string

changed_resources.created_invoices.voided_at

string<date-time> | null

required

If the invoice has a status of void, this gives a timestamp when the invoice was voided.

changed_resources.created_invoices.paid_at

string<date-time> | null

required

If the invoice has a status of paid, this gives a timestamp when the invoice was paid.

changed_resources.created_invoices.issued_at

string<date-time> | null

required

If the invoice has been issued, this will be the time it transitioned to issued (even if it is now in a different state.)

changed_resources.created_invoices.scheduled_issue_at

string<date-time> | null

required

If the invoice is in draft, this timestamp will reflect when the invoice is scheduled to be issued.

changed_resources.created_invoices.auto_collection

AutoCollection · object

required

Show child attributes

changed_resources.created_invoices.auto_collection.next_attempt_at

string<date-time> | null

required

If the invoice is scheduled for auto-collection, this field will reflect when the next attempt will occur. If dunning has been exhausted, or auto-collection is not enabled for this invoice, this field will be null.

changed_resources.created_invoices.auto_collection.previously_attempted_at

string<date-time> | null

required

If Orb has ever attempted payment auto-collection for this invoice, this field will reflect when that attempt occurred. In conjunction with next_attempt_at, this can be used to tell whether the invoice is currently in dunning (that is, previously_attempted_at is non-null, and next_attempt_time is non-null), or if dunning has been exhausted (previously_attempted_at is non-null, but next_attempt_time is null).

changed_resources.created_invoices.auto_collection.enabled

boolean | null

required

True only if auto-collection is enabled for this invoice.

changed_resources.created_invoices.auto_collection.num_attempts

integer | null

required

Number of auto-collection payment attempts.

changed_resources.created_invoices.issue_failed_at

string<date-time> | null

required

If the invoice failed to issue, this will be the last time it failed to issue (even if it is now in a different state.)

changed_resources.created_invoices.sync_failed_at

string<date-time> | null

required

If the invoice failed to sync, this will be the last time an external invoicing provider sync was attempted. This field will always be null for invoices using Orb Invoicing.

changed_resources.created_invoices.payment_failed_at

string<date-time> | null

required

If payment was attempted on this invoice but failed, this will be the time of the most recent attempt.

changed_resources.created_invoices.payment_started_at

string<date-time> | null

required

If payment was attempted on this invoice, this will be the start time of the most recent attempt. This field is especially useful for delayed-notification payment mechanisms (like bank transfers), where payment can take 3 days or more.

changed_resources.created_invoices.amount_due

string

required

This is the final amount required to be charged to the customer and reflects the application of the customer balance to the total of the invoice.

changed_resources.created_invoices.created_at

string<date-time>

required

The creation time of the resource in Orb.

changed_resources.created_invoices.currency

string

required

An ISO 4217 currency string or credits

changed_resources.created_invoices.customer

CustomerMinified · object

required

Show child attributes

changed_resources.created_invoices.customer.id

string

required

changed_resources.created_invoices.customer.external_customer_id

string | null

required

changed_resources.created_invoices.due_date

string<date-time> | null

required

When the invoice payment is due. The due date is null if the invoice is not yet finalized.

Example:

"2022-05-30T07:00:00+00:00"

changed_resources.created_invoices.id

string

required

changed_resources.created_invoices.invoice_pdf

string | null

required

The link to download the PDF representation of the Invoice.

Example:

"https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"

changed_resources.created_invoices.invoice_number

string

required

Automatically generated invoice number to help track and reconcile invoices. Invoice numbers have a prefix such as RFOBWG. These can be sequential per account or customer.

changed_resources.created_invoices.subscription

SubscriptionMinified · object

required

Show child attributes

changed_resources.created_invoices.subscription.id

string

required

changed_resources.created_invoices.total

string

required

The total after any minimums and discounts have been applied.

changed_resources.created_invoices.customer_balance_transactions

CustomerBalanceTransaction · object[]

required

Show child attributes

changed_resources.created_invoices.customer_balance_transactions.id

string

required

A unique id for this transaction.

changed_resources.created_invoices.customer_balance_transactions.created_at

string<date-time>

required

The creation time of this transaction.

changed_resources.created_invoices.customer_balance_transactions.starting_balance

string

required

The original value of the customer's balance prior to the transaction, in the customer's currency.

changed_resources.created_invoices.customer_balance_transactions.ending_balance

string

required

The new value of the customer's balance prior to the transaction, in the customer's currency.

changed_resources.created_invoices.customer_balance_transactions.amount

string

required

The value of the amount changed in the transaction.

changed_resources.created_invoices.customer_balance_transactions.action

enum<string>

required

Available options:

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

changed_resources.created_invoices.customer_balance_transactions.description

string | null

required

An optional description provided for manual customer balance adjustments.

Example:

"An optional description"

changed_resources.created_invoices.customer_balance_transactions.invoice

InvoiceTiny · object

required

Show child attributes

changed_resources.created_invoices.customer_balance_transactions.invoice.id

string

required

The Invoice id

changed_resources.created_invoices.customer_balance_transactions.type

enum<string>

required

Available options:

increment,

decrement

changed_resources.created_invoices.customer_balance_transactions.credit_note

CreditNoteTiny · object

required

Show child attributes

changed_resources.created_invoices.customer_balance_transactions.credit_note.id

string

required

The id of the Credit note

changed_resources.created_invoices.status

enum<string>

required

Available options:

issued,

paid,

synced,

void,

draft

changed_resources.created_invoices.invoice_source

enum<string>

required

Available options:

subscription,

partial,

one_off

changed_resources.created_invoices.shipping_address

Address · object

required

Show child attributes

changed_resources.created_invoices.shipping_address.line1

string | null

required

changed_resources.created_invoices.shipping_address.line2

string | null

required

changed_resources.created_invoices.shipping_address.city

string | null

required

changed_resources.created_invoices.shipping_address.state

string | null

required

changed_resources.created_invoices.shipping_address.postal_code

string | null

required

changed_resources.created_invoices.shipping_address.country

string | null

required

changed_resources.created_invoices.billing_address

Address · object

required

Show child attributes

changed_resources.created_invoices.billing_address.line1

string | null

required

changed_resources.created_invoices.billing_address.line2

string | null

required

changed_resources.created_invoices.billing_address.city

string | null

required

changed_resources.created_invoices.billing_address.state

string | null

required

changed_resources.created_invoices.billing_address.postal_code

string | null

required

changed_resources.created_invoices.billing_address.country

string | null

required

changed_resources.created_invoices.hosted_invoice_url

string | null

required

A URL for the customer-facing invoice portal. This URL expires 30 days after the invoice's due date, or 60 days after being re-generated through the UI.

changed_resources.created_invoices.will_auto_issue

boolean

required

This is true if the invoice will be automatically issued in the future, and false otherwise.

changed_resources.created_invoices.eligible_to_issue_at

string<date-time> | null

required

If the invoice has a status of draft, this will be the time that the invoice will be eligible to be issued, otherwise it will be null. If auto-issue is true, the invoice will automatically begin issuing at this time.

changed_resources.created_invoices.customer_tax_id

CustomerTaxId · object

required

Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices.

Supported Tax ID Countries and Types

Country	Type	Description
Albania	`al_tin`	Albania Tax Identification Number
Andorra	`ad_nrt`	Andorran NRT Number
Angola	`ao_tin`	Angola Tax Identification Number
Argentina	`ar_cuit`	Argentinian Tax ID Number
Armenia	`am_tin`	Armenia Tax Identification Number
Aruba	`aw_tin`	Aruba Tax Identification Number
Australia	`au_abn`	Australian Business Number (AU ABN)
Australia	`au_arn`	Australian Taxation Office Reference Number
Austria	`eu_vat`	European VAT Number
Azerbaijan	`az_tin`	Azerbaijan Tax Identification Number
Bahamas	`bs_tin`	Bahamas Tax Identification Number
Bahrain	`bh_vat`	Bahraini VAT Number
Bangladesh	`bd_bin`	Bangladesh Business Identification Number
Barbados	`bb_tin`	Barbados Tax Identification Number
Belarus	`by_tin`	Belarus TIN Number
Belgium	`eu_vat`	European VAT Number
Benin	`bj_ifu`	Benin Tax Identification Number (Identifiant Fiscal Unique)
Bolivia	`bo_tin`	Bolivian Tax ID
Bosnia and Herzegovina	`ba_tin`	Bosnia and Herzegovina Tax Identification Number
Brazil	`br_cnpj`	Brazilian CNPJ Number
Brazil	`br_cpf`	Brazilian CPF Number
Bulgaria	`bg_uic`	Bulgaria Unified Identification Code
Bulgaria	`eu_vat`	European VAT Number
Burkina Faso	`bf_ifu`	Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique)
Cambodia	`kh_tin`	Cambodia Tax Identification Number
Cameroon	`cm_niu`	Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique)
Canada	`ca_bn`	Canadian BN
Canada	`ca_gst_hst`	Canadian GST/HST Number
Canada	`ca_pst_bc`	Canadian PST Number (British Columbia)
Canada	`ca_pst_mb`	Canadian PST Number (Manitoba)
Canada	`ca_pst_sk`	Canadian PST Number (Saskatchewan)
Canada	`ca_qst`	Canadian QST Number (Québec)
Cape Verde	`cv_nif`	Cape Verde Tax Identification Number (Número de Identificação Fiscal)
Chile	`cl_tin`	Chilean TIN
China	`cn_tin`	Chinese Tax ID
Colombia	`co_nit`	Colombian NIT Number
Congo-Kinshasa	`cd_nif`	Congo (DR) Tax Identification Number (Número de Identificação Fiscal)
Costa Rica	`cr_tin`	Costa Rican Tax ID
Croatia	`eu_vat`	European VAT Number
Croatia	`hr_oib`	Croatian Personal Identification Number (OIB)
Cyprus	`eu_vat`	European VAT Number
Czech Republic	`eu_vat`	European VAT Number
Denmark	`eu_vat`	European VAT Number
Dominican Republic	`do_rcn`	Dominican RCN Number
Ecuador	`ec_ruc`	Ecuadorian RUC Number
Egypt	`eg_tin`	Egyptian Tax Identification Number
El Salvador	`sv_nit`	El Salvadorian NIT Number
Estonia	`eu_vat`	European VAT Number
Ethiopia	`et_tin`	Ethiopia Tax Identification Number
European Union	`eu_oss_vat`	European One Stop Shop VAT Number for non-Union scheme
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
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
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
Peru	`pe_ruc`	Peruvian RUC Number
Philippines	`ph_tin`	Philippines Tax Identification Number
Poland	`eu_vat`	European VAT Number
Portugal	`eu_vat`	European VAT Number
Romania	`eu_vat`	European VAT Number
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
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

Show child attributes

changed_resources.created_invoices.customer_tax_id.country

enum<string>

required

Available options:

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,

DE,

CY,

CZ,

DK,

DO,

EC,

EE,

EG,

ES,

ET,

EU,

FI,

FR,

GB,

GE,

GN,

GR,

HK,

HR,

HU,

ID,

IE,

IL,

IN,

IS,

IT,

JP,

KE,

KG,

KH,

KR,

KZ,

LA,

LI,

LT,

LU,

LV,

MA,

MD,

ME,

MK,

MR,

MT,

MX,

MY,

NG,

NL,

NO,

NP,

NZ,

OM,

PE,

PH,

PL,

PT,

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

changed_resources.created_invoices.customer_tax_id.type

enum<string>

required

Available options:

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,

gb_vat,

ge_vat,

gn_nif,

hk_br,

hr_oib,

hu_tin,

id_npwp,

il_vat,

in_gst,

is_vat,

jp_cn,

jp_rn,

jp_trn,

ke_pin,

kg_tin,

kh_tin,

kr_brn,

kz_bin,

la_tin,

li_uid,

li_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,

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

changed_resources.created_invoices.customer_tax_id.value

string

required

changed_resources.created_invoices.memo

string | null

required

Free-form text which is available on the invoice PDF and the Orb invoice portal.

changed_resources.created_invoices.credit_notes

CreditNoteSummary · object[]

required

A list of credit notes associated with the invoice

Show child attributes

changed_resources.created_invoices.credit_notes.id

string

required

changed_resources.created_invoices.credit_notes.credit_note_number

string

required

changed_resources.created_invoices.credit_notes.reason

string

required

changed_resources.created_invoices.credit_notes.total

string

required

changed_resources.created_invoices.credit_notes.voided_at

string<date-time> | null

required

If the credit note has a status of void, this gives a timestamp when the credit note was voided.

Example:

"2022-05-01T07:01:31+00:00"

changed_resources.created_invoices.credit_notes.type

string

required

changed_resources.created_invoices.credit_notes.memo

string | null

required

An optional memo supplied on the credit note.

changed_resources.created_invoices.payment_attempts

PaymentAttempt · object[]

required

A list of payment attempts associated with the invoice

Show child attributes

changed_resources.created_invoices.payment_attempts.id

string

required

The ID of the payment attempt.

changed_resources.created_invoices.payment_attempts.payment_provider

enum<string> | null

required

The payment provider that attempted to collect the payment.

Available options:

stripe

changed_resources.created_invoices.payment_attempts.payment_provider_id

string | null

required

The ID of the payment attempt in the payment provider.

changed_resources.created_invoices.payment_attempts.amount

string

required

The amount of the payment attempt.

changed_resources.created_invoices.payment_attempts.succeeded

boolean

required

Whether the payment attempt succeeded.

changed_resources.created_invoices.payment_attempts.created_at

string<date-time>

required

The time at which the payment attempt was created.

changed_resources.created_invoices.payment_attempts.receipt_pdf

string | null

required

URL to the downloadable PDF version of the receipt. This field will be null for payment attempts that did not succeed.

Example:

"https://assets.withorb.com/receipt/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"

changed_resources.created_invoices.discount

any | null

required

deprecated

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.

changed_resources.created_invoices.discounts

(PercentageDiscount · object | AmountDiscount · object | TrialDiscount · object)[]

required

PercentageDiscount
AmountDiscount
TrialDiscount

Show child attributes

changed_resources.created_invoices.discounts.discount_type

enum<string>

required

Available options:

percentage

changed_resources.created_invoices.discounts.percentage_discount

number

required

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

Required range: 0 <= x <= 1

changed_resources.created_invoices.discounts.applies_to_price_ids

string[] | null

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

Example:

["h74gfhdjvn7ujokd", "7hfgtgjnbvc3ujkl"]

changed_resources.created_invoices.discounts.filters

PriceFilter · object[] | null

The filters that determine which prices to apply this discount to.

Show child attributes

changed_resources.created_invoices.discounts.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.created_invoices.discounts.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.created_invoices.discounts.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.created_invoices.discounts.reason

string | null

changed_resources.created_invoices.minimum

Minimum · object

required

Show child attributes

changed_resources.created_invoices.minimum.minimum_amount

string

required

Minimum amount applied

changed_resources.created_invoices.minimum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this minimum to.

Show child attributes

changed_resources.created_invoices.minimum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.created_invoices.minimum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.created_invoices.minimum.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.created_invoices.minimum.applies_to_price_ids

string[]

required

deprecated

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

changed_resources.created_invoices.minimum_amount

string | null

required

changed_resources.created_invoices.maximum

Maximum · object

required

Show child attributes

changed_resources.created_invoices.maximum.maximum_amount

string

required

Maximum amount applied

changed_resources.created_invoices.maximum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this maximum to.

Show child attributes

changed_resources.created_invoices.maximum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.created_invoices.maximum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.created_invoices.maximum.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.created_invoices.maximum.applies_to_price_ids

string[]

required

deprecated

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

changed_resources.created_invoices.maximum_amount

string | null

required

changed_resources.created_invoices.line_items

InvoiceLineItem · object[]

required

The breakdown of prices in this invoice.

Show child attributes

changed_resources.created_invoices.line_items.amount

string

required

The final amount for a line item after all adjustments and pre paid credits have been applied.

changed_resources.created_invoices.line_items.end_date

string<date-time>

required

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

changed_resources.created_invoices.line_items.grouping

string | null

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.

changed_resources.created_invoices.line_items.adjustments

(MonetaryUsageDiscountAdjustment · object | MonetaryAmountDiscountAdjustment · object | MonetaryPercentageDiscountAdjustment · object | MonetaryMinimumAdjustment · object | MonetaryMaximumAdjustment · object)[]

required

All adjustments applied to the line item in the order they were applied based on invoice calculations (ie. usage discounts -> amount discounts -> percentage discounts -> minimums -> maximums).

MonetaryUsageDiscountAdjustment
MonetaryAmountDiscountAdjustment
MonetaryPercentageDiscountAdjustment
MonetaryMinimumAdjustment
MonetaryMaximumAdjustment

Show child attributes

changed_resources.created_invoices.line_items.adjustments.id

string

required

changed_resources.created_invoices.line_items.adjustments.is_invoice_level

boolean

required

True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price.

changed_resources.created_invoices.line_items.adjustments.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this adjustment to.

Show child attributes

changed_resources.created_invoices.line_items.adjustments.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.created_invoices.line_items.adjustments.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.created_invoices.line_items.adjustments.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.created_invoices.line_items.adjustments.applies_to_price_ids

string[]

required

deprecated

The price IDs that this adjustment applies to.

changed_resources.created_invoices.line_items.adjustments.reason

string | null

required

The reason for the adjustment.

changed_resources.created_invoices.line_items.adjustments.replaces_adjustment_id

string | null

required

The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations.

changed_resources.created_invoices.line_items.adjustments.adjustment_type

enum<string>

required

Available options:

usage_discount

changed_resources.created_invoices.line_items.adjustments.usage_discount

number

required

The number of usage units by which to discount the price this adjustment applies to in a given billing period.

changed_resources.created_invoices.line_items.adjustments.amount

string

required

The value applied by an adjustment.

changed_resources.created_invoices.line_items.name

string

required

The name of the price associated with this line item.

changed_resources.created_invoices.line_items.quantity

number

required

Either the fixed fee quantity or the usage during the service period.

changed_resources.created_invoices.line_items.start_date

string<date-time>

required

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

changed_resources.created_invoices.line_items.subtotal

string

required

The line amount before any adjustments.

changed_resources.created_invoices.line_items.adjusted_subtotal

string

required

The line amount after any adjustments and before overage conversion, credits and partial invoicing.

changed_resources.created_invoices.line_items.credits_applied

string

required

The number of prepaid credits applied.

changed_resources.created_invoices.line_items.partially_invoiced_amount

string

required

Any amount applied from a partial invoice

changed_resources.created_invoices.line_items.sub_line_items

(MatrixSubLineItem · object | TierSubLineItem · object | OtherSubLineItem · object)[]

required

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

MatrixSubLineItem
TierSubLineItem
OtherSubLineItem

Show child attributes

changed_resources.created_invoices.line_items.sub_line_items.amount

string

required

The total amount for this sub line item.

changed_resources.created_invoices.line_items.sub_line_items.name

string

required

changed_resources.created_invoices.line_items.sub_line_items.quantity

number

required

changed_resources.created_invoices.line_items.sub_line_items.grouping

SubLineItemGrouping · object

required

Show child attributes

changed_resources.created_invoices.line_items.sub_line_items.grouping.key

string

required

changed_resources.created_invoices.line_items.sub_line_items.grouping.value

string | null

required

No value indicates the default group

Example:

"west"

changed_resources.created_invoices.line_items.sub_line_items.type

enum<string>

required

Available options:

matrix

changed_resources.created_invoices.line_items.sub_line_items.matrix_config

SubLineItemMatrixConfig · object

required

Show child attributes

changed_resources.created_invoices.line_items.sub_line_items.matrix_config.dimension_values

(string | null)[]

required

The ordered dimension values for this line item.

changed_resources.created_invoices.line_items.sub_line_items.scaled_quantity

number | null

The scaled quantity for this line item for specific pricing structures

changed_resources.created_invoices.line_items.tax_amounts

TaxAmount · object[]

required

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

Show child attributes

changed_resources.created_invoices.line_items.tax_amounts.tax_rate_description

string

required

The human-readable description of the applied tax rate.

changed_resources.created_invoices.line_items.tax_amounts.tax_rate_percentage

string | null

required

The tax rate percentage, out of 100.

changed_resources.created_invoices.line_items.tax_amounts.amount

string

required

The amount of additional tax incurred by this tax rate.

changed_resources.created_invoices.line_items.id

string

required

A unique ID for this line item.

changed_resources.created_invoices.line_items.price

UnitPrice · object

required

For more on the types of prices, see the core concepts documentation

UnitPrice
TieredPrice
BulkPrice
BulkWithFiltersPrice
PackagePrice
MatrixPrice
ThresholdTotalAmountPrice
TieredPackagePrice
TieredWithMinimumPrice
GroupedTieredPrice
TieredPackageWithMinimumPrice
PackageWithAllocationPrice
UnitWithPercentPrice
MatrixWithAllocationPrice
TieredWithProrationPrice
UnitWithProrationPrice
GroupedAllocationPrice
BulkWithProrationPrice
GroupedWithProratedMinimumPrice
GroupedWithMeteredMinimumPrice
GroupedWithMinMaxThresholdsPrice
MatrixWithDisplayNamePrice
GroupedTieredPackagePrice
MaxGroupTieredPackagePrice
ScalableMatrixWithUnitPricingPrice
ScalableMatrixWithTieredPricingPrice
CumulativeGroupedBulkPrice
CumulativeGroupedAllocationPrice
MinimumCompositePrice
PercentCompositePrice
EventOutputPrice

Show child attributes

changed_resources.created_invoices.line_items.price.model_type

enum<string>

required

The pricing model type

Available options:

unit

changed_resources.created_invoices.line_items.price.unit_config

UnitConfig · object

required

Configuration for unit pricing

Show child attributes

changed_resources.created_invoices.line_items.price.unit_config.unit_amount

string

required

Rate per unit of usage

changed_resources.created_invoices.line_items.price.unit_config.prorated

boolean

default:false

If true, subtotals from this price are prorated based on the service period

changed_resources.created_invoices.line_items.price.metadata

Metadata · object

required

Show child attributes

changed_resources.created_invoices.line_items.price.metadata.{key}

string

changed_resources.created_invoices.line_items.price.id

string

required

changed_resources.created_invoices.line_items.price.name

string

required

changed_resources.created_invoices.line_items.price.external_price_id

string | null

required

changed_resources.created_invoices.line_items.price.replaces_price_id

string | null

required

The price id this price replaces. This price will take the place of the replaced price in plan version migrations.

changed_resources.created_invoices.line_items.price.price_type

enum<string>

required

Available options:

usage_price,

fixed_price,

composite_price

changed_resources.created_invoices.line_items.price.created_at

string<date-time>

required

changed_resources.created_invoices.line_items.price.cadence

enum<string>

required

Available options:

one_time,

monthly,

quarterly,

semi_annual,

annual,

custom

changed_resources.created_invoices.line_items.price.billing_mode

enum<string>

required

Available options:

in_advance,

in_arrear

changed_resources.created_invoices.line_items.price.billing_cycle_configuration

BillingCycleConfiguration · object

required

Show child attributes

changed_resources.created_invoices.line_items.price.billing_cycle_configuration.duration

integer

required

changed_resources.created_invoices.line_items.price.billing_cycle_configuration.duration_unit

enum<string>

required

Available options:

day,

month

changed_resources.created_invoices.line_items.price.invoicing_cycle_configuration

BillingCycleConfiguration · object

required

Show child attributes

changed_resources.created_invoices.line_items.price.invoicing_cycle_configuration.duration

integer

required

changed_resources.created_invoices.line_items.price.invoicing_cycle_configuration.duration_unit

enum<string>

required

Available options:

day,

month

changed_resources.created_invoices.line_items.price.billable_metric

BillableMetricTiny · object

required

Show child attributes

changed_resources.created_invoices.line_items.price.billable_metric.id

string

required

changed_resources.created_invoices.line_items.price.fixed_price_quantity

number | null

required

changed_resources.created_invoices.line_items.price.plan_phase_order

integer | null

required

changed_resources.created_invoices.line_items.price.currency

string

required

changed_resources.created_invoices.line_items.price.conversion_rate

number | null

required

changed_resources.created_invoices.line_items.price.conversion_rate_config

UnitConversionRateConfig · object

required

UnitConversionRateConfig
TieredConversionRateConfig

Show child attributes

changed_resources.created_invoices.line_items.price.conversion_rate_config.conversion_rate_type

enum<string>

required

Available options:

unit

changed_resources.created_invoices.line_items.price.conversion_rate_config.unit_config

ConversionRateUnitConfig · object

required

Show child attributes

changed_resources.created_invoices.line_items.price.conversion_rate_config.unit_config.unit_amount

string

required

Amount per unit of overage

changed_resources.created_invoices.line_items.price.item

ItemSlim · object

required

A minimal representation of an Item containing only the essential identifying information.

Show child attributes

changed_resources.created_invoices.line_items.price.item.id

string

required

The Orb-assigned unique identifier for the item.

changed_resources.created_invoices.line_items.price.item.name

string

required

The name of the item.

changed_resources.created_invoices.line_items.price.credit_allocation

Allocation · object

required

Show child attributes

changed_resources.created_invoices.line_items.price.credit_allocation.currency

string

required

changed_resources.created_invoices.line_items.price.credit_allocation.allows_rollover

boolean

required

changed_resources.created_invoices.line_items.price.credit_allocation.custom_expiration

CustomExpiration · object

required

Show child attributes

changed_resources.created_invoices.line_items.price.credit_allocation.custom_expiration.duration

integer

required

changed_resources.created_invoices.line_items.price.credit_allocation.custom_expiration.duration_unit

enum<string>

required

Available options:

day,

month

changed_resources.created_invoices.line_items.price.credit_allocation.filters

PriceFilter · object[]

Show child attributes

changed_resources.created_invoices.line_items.price.credit_allocation.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.created_invoices.line_items.price.credit_allocation.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.created_invoices.line_items.price.credit_allocation.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.created_invoices.line_items.price.composite_price_filters

PriceFilter · object[] | null

required

Show child attributes

changed_resources.created_invoices.line_items.price.composite_price_filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.created_invoices.line_items.price.composite_price_filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.created_invoices.line_items.price.composite_price_filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.created_invoices.line_items.price.discount

PercentageDiscount · object

required

deprecated

PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount

Show child attributes

changed_resources.created_invoices.line_items.price.discount.discount_type

enum<string>

required

Available options:

percentage

changed_resources.created_invoices.line_items.price.discount.percentage_discount

number

required

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

Required range: 0 <= x <= 1

changed_resources.created_invoices.line_items.price.discount.applies_to_price_ids

string[] | null

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

Example:

["h74gfhdjvn7ujokd", "7hfgtgjnbvc3ujkl"]

changed_resources.created_invoices.line_items.price.discount.filters

PriceFilter · object[] | null

The filters that determine which prices to apply this discount to.

Show child attributes

changed_resources.created_invoices.line_items.price.discount.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.created_invoices.line_items.price.discount.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.created_invoices.line_items.price.discount.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.created_invoices.line_items.price.discount.reason

string | null

changed_resources.created_invoices.line_items.price.minimum

Minimum · object

required

deprecated

Show child attributes

changed_resources.created_invoices.line_items.price.minimum.minimum_amount

string

required

Minimum amount applied

changed_resources.created_invoices.line_items.price.minimum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this minimum to.

Show child attributes

changed_resources.created_invoices.line_items.price.minimum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.created_invoices.line_items.price.minimum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.created_invoices.line_items.price.minimum.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.created_invoices.line_items.price.minimum.applies_to_price_ids

string[]

required

deprecated

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

changed_resources.created_invoices.line_items.price.minimum_amount

string | null

required

deprecated

changed_resources.created_invoices.line_items.price.maximum

Maximum · object

required

deprecated

Show child attributes

changed_resources.created_invoices.line_items.price.maximum.maximum_amount

string

required

Maximum amount applied

changed_resources.created_invoices.line_items.price.maximum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this maximum to.

Show child attributes

changed_resources.created_invoices.line_items.price.maximum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.created_invoices.line_items.price.maximum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.created_invoices.line_items.price.maximum.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.created_invoices.line_items.price.maximum.applies_to_price_ids

string[]

required

deprecated

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

changed_resources.created_invoices.line_items.price.maximum_amount

string | null

required

deprecated

changed_resources.created_invoices.line_items.price.dimensional_price_configuration

DimensionalPriceConfiguration · object

Show child attributes

changed_resources.created_invoices.line_items.price.dimensional_price_configuration.dimensional_price_group_id

string

required

changed_resources.created_invoices.line_items.price.dimensional_price_configuration.dimension_values

string[]

required

changed_resources.created_invoices.line_items.usage_customer_ids

string[] | null

required

A list of customer ids that were used to calculate the usage for this line item.

changed_resources.created_invoices.line_items.filter

string | null

required

An additional filter that was used to calculate the usage for this line item.

changed_resources.created_invoices.subtotal

string

required

The total before any discounts and minimums are applied.

changed_resources.created_invoices.invoice_date

string<date-time>

required

The scheduled date of the invoice

changed_resources.created_invoices.is_payable_now

boolean

required

True if the invoice has only in-advance fixed fees and is payable now

changed_resources.voided_invoices

Invoice · object[]

required

The invoices that were voided as part of this operation.

Show child attributes

changed_resources.voided_invoices.metadata

Metadata · object

required

Show child attributes

changed_resources.voided_invoices.metadata.{key}

string

changed_resources.voided_invoices.voided_at

string<date-time> | null

required

If the invoice has a status of void, this gives a timestamp when the invoice was voided.

changed_resources.voided_invoices.paid_at

string<date-time> | null

required

If the invoice has a status of paid, this gives a timestamp when the invoice was paid.

changed_resources.voided_invoices.issued_at

string<date-time> | null

required

If the invoice has been issued, this will be the time it transitioned to issued (even if it is now in a different state.)

changed_resources.voided_invoices.scheduled_issue_at

string<date-time> | null

required

If the invoice is in draft, this timestamp will reflect when the invoice is scheduled to be issued.

changed_resources.voided_invoices.auto_collection

AutoCollection · object

required

Show child attributes

changed_resources.voided_invoices.auto_collection.next_attempt_at

string<date-time> | null

required

changed_resources.voided_invoices.auto_collection.previously_attempted_at

string<date-time> | null

required

changed_resources.voided_invoices.auto_collection.enabled

boolean | null

required

True only if auto-collection is enabled for this invoice.

changed_resources.voided_invoices.auto_collection.num_attempts

integer | null

required

Number of auto-collection payment attempts.

changed_resources.voided_invoices.issue_failed_at

string<date-time> | null

required

If the invoice failed to issue, this will be the last time it failed to issue (even if it is now in a different state.)

changed_resources.voided_invoices.sync_failed_at

string<date-time> | null

required

If the invoice failed to sync, this will be the last time an external invoicing provider sync was attempted. This field will always be null for invoices using Orb Invoicing.

changed_resources.voided_invoices.payment_failed_at

string<date-time> | null

required

If payment was attempted on this invoice but failed, this will be the time of the most recent attempt.

changed_resources.voided_invoices.payment_started_at

string<date-time> | null

required

changed_resources.voided_invoices.amount_due

string

required

This is the final amount required to be charged to the customer and reflects the application of the customer balance to the total of the invoice.

changed_resources.voided_invoices.created_at

string<date-time>

required

The creation time of the resource in Orb.

changed_resources.voided_invoices.currency

string

required

An ISO 4217 currency string or credits

changed_resources.voided_invoices.customer

CustomerMinified · object

required

Show child attributes

changed_resources.voided_invoices.customer.id

string

required

changed_resources.voided_invoices.customer.external_customer_id

string | null

required

changed_resources.voided_invoices.due_date

string<date-time> | null

required

When the invoice payment is due. The due date is null if the invoice is not yet finalized.

Example:

"2022-05-30T07:00:00+00:00"

changed_resources.voided_invoices.id

string

required

changed_resources.voided_invoices.invoice_pdf

string | null

required

The link to download the PDF representation of the Invoice.

Example:

"https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"

changed_resources.voided_invoices.invoice_number

string

required

Automatically generated invoice number to help track and reconcile invoices. Invoice numbers have a prefix such as RFOBWG. These can be sequential per account or customer.

changed_resources.voided_invoices.subscription

SubscriptionMinified · object

required

Show child attributes

changed_resources.voided_invoices.subscription.id

string

required

changed_resources.voided_invoices.total

string

required

The total after any minimums and discounts have been applied.

changed_resources.voided_invoices.customer_balance_transactions

CustomerBalanceTransaction · object[]

required

Show child attributes

changed_resources.voided_invoices.customer_balance_transactions.id

string

required

A unique id for this transaction.

changed_resources.voided_invoices.customer_balance_transactions.created_at

string<date-time>

required

The creation time of this transaction.

changed_resources.voided_invoices.customer_balance_transactions.starting_balance

string

required

The original value of the customer's balance prior to the transaction, in the customer's currency.

changed_resources.voided_invoices.customer_balance_transactions.ending_balance

string

required

The new value of the customer's balance prior to the transaction, in the customer's currency.

changed_resources.voided_invoices.customer_balance_transactions.amount

string

required

The value of the amount changed in the transaction.

changed_resources.voided_invoices.customer_balance_transactions.action

enum<string>

required

Available options:

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

changed_resources.voided_invoices.customer_balance_transactions.description

string | null

required

An optional description provided for manual customer balance adjustments.

Example:

"An optional description"

changed_resources.voided_invoices.customer_balance_transactions.invoice

InvoiceTiny · object

required

Show child attributes

changed_resources.voided_invoices.customer_balance_transactions.invoice.id

string

required

The Invoice id

changed_resources.voided_invoices.customer_balance_transactions.type

enum<string>

required

Available options:

increment,

decrement

changed_resources.voided_invoices.customer_balance_transactions.credit_note

CreditNoteTiny · object

required

Show child attributes

changed_resources.voided_invoices.customer_balance_transactions.credit_note.id

string

required

The id of the Credit note

changed_resources.voided_invoices.status

enum<string>

required

Available options:

issued,

paid,

synced,

void,

draft

changed_resources.voided_invoices.invoice_source

enum<string>

required

Available options:

subscription,

partial,

one_off

changed_resources.voided_invoices.shipping_address

Address · object

required

Show child attributes

changed_resources.voided_invoices.shipping_address.line1

string | null

required

changed_resources.voided_invoices.shipping_address.line2

string | null

required

changed_resources.voided_invoices.shipping_address.city

string | null

required

changed_resources.voided_invoices.shipping_address.state

string | null

required

changed_resources.voided_invoices.shipping_address.postal_code

string | null

required

changed_resources.voided_invoices.shipping_address.country

string | null

required

changed_resources.voided_invoices.billing_address

Address · object

required

Show child attributes

changed_resources.voided_invoices.billing_address.line1

string | null

required

changed_resources.voided_invoices.billing_address.line2

string | null

required

changed_resources.voided_invoices.billing_address.city

string | null

required

changed_resources.voided_invoices.billing_address.state

string | null

required

changed_resources.voided_invoices.billing_address.postal_code

string | null

required

changed_resources.voided_invoices.billing_address.country

string | null

required

changed_resources.voided_invoices.hosted_invoice_url

string | null

required

A URL for the customer-facing invoice portal. This URL expires 30 days after the invoice's due date, or 60 days after being re-generated through the UI.

changed_resources.voided_invoices.will_auto_issue

boolean

required

This is true if the invoice will be automatically issued in the future, and false otherwise.

changed_resources.voided_invoices.eligible_to_issue_at

string<date-time> | null

required

changed_resources.voided_invoices.customer_tax_id

CustomerTaxId · object

required

Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices.

Supported Tax ID Countries and Types

Country	Type	Description
Albania	`al_tin`	Albania Tax Identification Number
Andorra	`ad_nrt`	Andorran NRT Number
Angola	`ao_tin`	Angola Tax Identification Number
Argentina	`ar_cuit`	Argentinian Tax ID Number
Armenia	`am_tin`	Armenia Tax Identification Number
Aruba	`aw_tin`	Aruba Tax Identification Number
Australia	`au_abn`	Australian Business Number (AU ABN)
Australia	`au_arn`	Australian Taxation Office Reference Number
Austria	`eu_vat`	European VAT Number
Azerbaijan	`az_tin`	Azerbaijan Tax Identification Number
Bahamas	`bs_tin`	Bahamas Tax Identification Number
Bahrain	`bh_vat`	Bahraini VAT Number
Bangladesh	`bd_bin`	Bangladesh Business Identification Number
Barbados	`bb_tin`	Barbados Tax Identification Number
Belarus	`by_tin`	Belarus TIN Number
Belgium	`eu_vat`	European VAT Number
Benin	`bj_ifu`	Benin Tax Identification Number (Identifiant Fiscal Unique)
Bolivia	`bo_tin`	Bolivian Tax ID
Bosnia and Herzegovina	`ba_tin`	Bosnia and Herzegovina Tax Identification Number
Brazil	`br_cnpj`	Brazilian CNPJ Number
Brazil	`br_cpf`	Brazilian CPF Number
Bulgaria	`bg_uic`	Bulgaria Unified Identification Code
Bulgaria	`eu_vat`	European VAT Number
Burkina Faso	`bf_ifu`	Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique)
Cambodia	`kh_tin`	Cambodia Tax Identification Number
Cameroon	`cm_niu`	Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique)
Canada	`ca_bn`	Canadian BN
Canada	`ca_gst_hst`	Canadian GST/HST Number
Canada	`ca_pst_bc`	Canadian PST Number (British Columbia)
Canada	`ca_pst_mb`	Canadian PST Number (Manitoba)
Canada	`ca_pst_sk`	Canadian PST Number (Saskatchewan)
Canada	`ca_qst`	Canadian QST Number (Québec)
Cape Verde	`cv_nif`	Cape Verde Tax Identification Number (Número de Identificação Fiscal)
Chile	`cl_tin`	Chilean TIN
China	`cn_tin`	Chinese Tax ID
Colombia	`co_nit`	Colombian NIT Number
Congo-Kinshasa	`cd_nif`	Congo (DR) Tax Identification Number (Número de Identificação Fiscal)
Costa Rica	`cr_tin`	Costa Rican Tax ID
Croatia	`eu_vat`	European VAT Number
Croatia	`hr_oib`	Croatian Personal Identification Number (OIB)
Cyprus	`eu_vat`	European VAT Number
Czech Republic	`eu_vat`	European VAT Number
Denmark	`eu_vat`	European VAT Number
Dominican Republic	`do_rcn`	Dominican RCN Number
Ecuador	`ec_ruc`	Ecuadorian RUC Number
Egypt	`eg_tin`	Egyptian Tax Identification Number
El Salvador	`sv_nit`	El Salvadorian NIT Number
Estonia	`eu_vat`	European VAT Number
Ethiopia	`et_tin`	Ethiopia Tax Identification Number
European Union	`eu_oss_vat`	European One Stop Shop VAT Number for non-Union scheme
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
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
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
Peru	`pe_ruc`	Peruvian RUC Number
Philippines	`ph_tin`	Philippines Tax Identification Number
Poland	`eu_vat`	European VAT Number
Portugal	`eu_vat`	European VAT Number
Romania	`eu_vat`	European VAT Number
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
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

Show child attributes

changed_resources.voided_invoices.customer_tax_id.country

enum<string>

required

Available options:

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,

DE,

CY,

CZ,

DK,

DO,

EC,

EE,

EG,

ES,

ET,

EU,

FI,

FR,

GB,

GE,

GN,

GR,

HK,

HR,

HU,

ID,

IE,

IL,

IN,

IS,

IT,

JP,

KE,

KG,

KH,

KR,

KZ,

LA,

LI,

LT,

LU,

LV,

MA,

MD,

ME,

MK,

MR,

MT,

MX,

MY,

NG,

NL,

NO,

NP,

NZ,

OM,

PE,

PH,

PL,

PT,

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

changed_resources.voided_invoices.customer_tax_id.type

enum<string>

required

Available options:

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,

gb_vat,

ge_vat,

gn_nif,

hk_br,

hr_oib,

hu_tin,

id_npwp,

il_vat,

in_gst,

is_vat,

jp_cn,

jp_rn,

jp_trn,

ke_pin,

kg_tin,

kh_tin,

kr_brn,

kz_bin,

la_tin,

li_uid,

li_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,

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

changed_resources.voided_invoices.customer_tax_id.value

string

required

changed_resources.voided_invoices.memo

string | null

required

Free-form text which is available on the invoice PDF and the Orb invoice portal.

changed_resources.voided_invoices.credit_notes

CreditNoteSummary · object[]

required

A list of credit notes associated with the invoice

Show child attributes

changed_resources.voided_invoices.credit_notes.id

string

required

changed_resources.voided_invoices.credit_notes.credit_note_number

string

required

changed_resources.voided_invoices.credit_notes.reason

string

required

changed_resources.voided_invoices.credit_notes.total

string

required

changed_resources.voided_invoices.credit_notes.voided_at

string<date-time> | null

required

If the credit note has a status of void, this gives a timestamp when the credit note was voided.

Example:

"2022-05-01T07:01:31+00:00"

changed_resources.voided_invoices.credit_notes.type

string

required

changed_resources.voided_invoices.credit_notes.memo

string | null

required

An optional memo supplied on the credit note.

changed_resources.voided_invoices.payment_attempts

PaymentAttempt · object[]

required

A list of payment attempts associated with the invoice

Show child attributes

changed_resources.voided_invoices.payment_attempts.id

string

required

The ID of the payment attempt.

changed_resources.voided_invoices.payment_attempts.payment_provider

enum<string> | null

required

The payment provider that attempted to collect the payment.

Available options:

stripe

changed_resources.voided_invoices.payment_attempts.payment_provider_id

string | null

required

The ID of the payment attempt in the payment provider.

changed_resources.voided_invoices.payment_attempts.amount

string

required

The amount of the payment attempt.

changed_resources.voided_invoices.payment_attempts.succeeded

boolean

required

Whether the payment attempt succeeded.

changed_resources.voided_invoices.payment_attempts.created_at

string<date-time>

required

The time at which the payment attempt was created.

changed_resources.voided_invoices.payment_attempts.receipt_pdf

string | null

required

URL to the downloadable PDF version of the receipt. This field will be null for payment attempts that did not succeed.

Example:

"https://assets.withorb.com/receipt/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"

changed_resources.voided_invoices.discount

any | null

required

deprecated

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.

changed_resources.voided_invoices.discounts

(PercentageDiscount · object | AmountDiscount · object | TrialDiscount · object)[]

required

PercentageDiscount
AmountDiscount
TrialDiscount

Show child attributes

changed_resources.voided_invoices.discounts.discount_type

enum<string>

required

Available options:

percentage

changed_resources.voided_invoices.discounts.percentage_discount

number

required

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

Required range: 0 <= x <= 1

changed_resources.voided_invoices.discounts.applies_to_price_ids

string[] | null

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

Example:

["h74gfhdjvn7ujokd", "7hfgtgjnbvc3ujkl"]

changed_resources.voided_invoices.discounts.filters

PriceFilter · object[] | null

The filters that determine which prices to apply this discount to.

Show child attributes

changed_resources.voided_invoices.discounts.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.voided_invoices.discounts.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.voided_invoices.discounts.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.voided_invoices.discounts.reason

string | null

changed_resources.voided_invoices.minimum

Minimum · object

required

Show child attributes

changed_resources.voided_invoices.minimum.minimum_amount

string

required

Minimum amount applied

changed_resources.voided_invoices.minimum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this minimum to.

Show child attributes

changed_resources.voided_invoices.minimum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.voided_invoices.minimum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.voided_invoices.minimum.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.voided_invoices.minimum.applies_to_price_ids

string[]

required

deprecated

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

changed_resources.voided_invoices.minimum_amount

string | null

required

changed_resources.voided_invoices.maximum

Maximum · object

required

Show child attributes

changed_resources.voided_invoices.maximum.maximum_amount

string

required

Maximum amount applied

changed_resources.voided_invoices.maximum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this maximum to.

Show child attributes

changed_resources.voided_invoices.maximum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.voided_invoices.maximum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.voided_invoices.maximum.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.voided_invoices.maximum.applies_to_price_ids

string[]

required

deprecated

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

changed_resources.voided_invoices.maximum_amount

string | null

required

changed_resources.voided_invoices.line_items

InvoiceLineItem · object[]

required

The breakdown of prices in this invoice.

Show child attributes

changed_resources.voided_invoices.line_items.amount

string

required

The final amount for a line item after all adjustments and pre paid credits have been applied.

changed_resources.voided_invoices.line_items.end_date

string<date-time>

required

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

changed_resources.voided_invoices.line_items.grouping

string | null

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.

changed_resources.voided_invoices.line_items.adjustments

required

All adjustments applied to the line item in the order they were applied based on invoice calculations (ie. usage discounts -> amount discounts -> percentage discounts -> minimums -> maximums).

MonetaryUsageDiscountAdjustment
MonetaryAmountDiscountAdjustment
MonetaryPercentageDiscountAdjustment
MonetaryMinimumAdjustment
MonetaryMaximumAdjustment

Show child attributes

changed_resources.voided_invoices.line_items.adjustments.id

string

required

changed_resources.voided_invoices.line_items.adjustments.is_invoice_level

boolean

required

True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price.

changed_resources.voided_invoices.line_items.adjustments.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this adjustment to.

Show child attributes

changed_resources.voided_invoices.line_items.adjustments.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.voided_invoices.line_items.adjustments.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.voided_invoices.line_items.adjustments.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.voided_invoices.line_items.adjustments.applies_to_price_ids

string[]

required

deprecated

The price IDs that this adjustment applies to.

changed_resources.voided_invoices.line_items.adjustments.reason

string | null

required

The reason for the adjustment.

changed_resources.voided_invoices.line_items.adjustments.replaces_adjustment_id

string | null

required

The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations.

changed_resources.voided_invoices.line_items.adjustments.adjustment_type

enum<string>

required

Available options:

usage_discount

changed_resources.voided_invoices.line_items.adjustments.usage_discount

number

required

The number of usage units by which to discount the price this adjustment applies to in a given billing period.

changed_resources.voided_invoices.line_items.adjustments.amount

string

required

The value applied by an adjustment.

changed_resources.voided_invoices.line_items.name

string

required

The name of the price associated with this line item.

changed_resources.voided_invoices.line_items.quantity

number

required

Either the fixed fee quantity or the usage during the service period.

changed_resources.voided_invoices.line_items.start_date

string<date-time>

required

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

changed_resources.voided_invoices.line_items.subtotal

string

required

The line amount before any adjustments.

changed_resources.voided_invoices.line_items.adjusted_subtotal

string

required

The line amount after any adjustments and before overage conversion, credits and partial invoicing.

changed_resources.voided_invoices.line_items.credits_applied

string

required

The number of prepaid credits applied.

changed_resources.voided_invoices.line_items.partially_invoiced_amount

string

required

Any amount applied from a partial invoice

changed_resources.voided_invoices.line_items.sub_line_items

(MatrixSubLineItem · object | TierSubLineItem · object | OtherSubLineItem · object)[]

required

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

MatrixSubLineItem
TierSubLineItem
OtherSubLineItem

Show child attributes

changed_resources.voided_invoices.line_items.sub_line_items.amount

string

required

The total amount for this sub line item.

changed_resources.voided_invoices.line_items.sub_line_items.name

string

required

changed_resources.voided_invoices.line_items.sub_line_items.quantity

number

required

changed_resources.voided_invoices.line_items.sub_line_items.grouping

SubLineItemGrouping · object

required

Show child attributes

changed_resources.voided_invoices.line_items.sub_line_items.grouping.key

string

required

changed_resources.voided_invoices.line_items.sub_line_items.grouping.value

string | null

required

No value indicates the default group

Example:

"west"

changed_resources.voided_invoices.line_items.sub_line_items.type

enum<string>

required

Available options:

matrix

changed_resources.voided_invoices.line_items.sub_line_items.matrix_config

SubLineItemMatrixConfig · object

required

Show child attributes

changed_resources.voided_invoices.line_items.sub_line_items.matrix_config.dimension_values

(string | null)[]

required

The ordered dimension values for this line item.

changed_resources.voided_invoices.line_items.sub_line_items.scaled_quantity

number | null

The scaled quantity for this line item for specific pricing structures

changed_resources.voided_invoices.line_items.tax_amounts

TaxAmount · object[]

required

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

Show child attributes

changed_resources.voided_invoices.line_items.tax_amounts.tax_rate_description

string

required

The human-readable description of the applied tax rate.

changed_resources.voided_invoices.line_items.tax_amounts.tax_rate_percentage

string | null

required

The tax rate percentage, out of 100.

changed_resources.voided_invoices.line_items.tax_amounts.amount

string

required

The amount of additional tax incurred by this tax rate.

changed_resources.voided_invoices.line_items.id

string

required

A unique ID for this line item.

changed_resources.voided_invoices.line_items.price

UnitPrice · object

required

For more on the types of prices, see the core concepts documentation

UnitPrice
TieredPrice
BulkPrice
BulkWithFiltersPrice
PackagePrice
MatrixPrice
ThresholdTotalAmountPrice
TieredPackagePrice
TieredWithMinimumPrice
GroupedTieredPrice
TieredPackageWithMinimumPrice
PackageWithAllocationPrice
UnitWithPercentPrice
MatrixWithAllocationPrice
TieredWithProrationPrice
UnitWithProrationPrice
GroupedAllocationPrice
BulkWithProrationPrice
GroupedWithProratedMinimumPrice
GroupedWithMeteredMinimumPrice
GroupedWithMinMaxThresholdsPrice
MatrixWithDisplayNamePrice
GroupedTieredPackagePrice
MaxGroupTieredPackagePrice
ScalableMatrixWithUnitPricingPrice
ScalableMatrixWithTieredPricingPrice
CumulativeGroupedBulkPrice
CumulativeGroupedAllocationPrice
MinimumCompositePrice
PercentCompositePrice
EventOutputPrice

Show child attributes

changed_resources.voided_invoices.line_items.price.model_type

enum<string>

required

The pricing model type

Available options:

unit

changed_resources.voided_invoices.line_items.price.unit_config

UnitConfig · object

required

Configuration for unit pricing

Show child attributes

changed_resources.voided_invoices.line_items.price.unit_config.unit_amount

string

required

Rate per unit of usage

changed_resources.voided_invoices.line_items.price.unit_config.prorated

boolean

default:false

If true, subtotals from this price are prorated based on the service period

changed_resources.voided_invoices.line_items.price.metadata

Metadata · object

required

Show child attributes

changed_resources.voided_invoices.line_items.price.metadata.{key}

string

changed_resources.voided_invoices.line_items.price.id

string

required

changed_resources.voided_invoices.line_items.price.name

string

required

changed_resources.voided_invoices.line_items.price.external_price_id

string | null

required

changed_resources.voided_invoices.line_items.price.replaces_price_id

string | null

required

The price id this price replaces. This price will take the place of the replaced price in plan version migrations.

changed_resources.voided_invoices.line_items.price.price_type

enum<string>

required

Available options:

usage_price,

fixed_price,

composite_price

changed_resources.voided_invoices.line_items.price.created_at

string<date-time>

required

changed_resources.voided_invoices.line_items.price.cadence

enum<string>

required

Available options:

one_time,

monthly,

quarterly,

semi_annual,

annual,

custom

changed_resources.voided_invoices.line_items.price.billing_mode

enum<string>

required

Available options:

in_advance,

in_arrear

changed_resources.voided_invoices.line_items.price.billing_cycle_configuration

BillingCycleConfiguration · object

required

Show child attributes

changed_resources.voided_invoices.line_items.price.billing_cycle_configuration.duration

integer

required

changed_resources.voided_invoices.line_items.price.billing_cycle_configuration.duration_unit

enum<string>

required

Available options:

day,

month

changed_resources.voided_invoices.line_items.price.invoicing_cycle_configuration

BillingCycleConfiguration · object

required

Show child attributes

changed_resources.voided_invoices.line_items.price.invoicing_cycle_configuration.duration

integer

required

changed_resources.voided_invoices.line_items.price.invoicing_cycle_configuration.duration_unit

enum<string>

required

Available options:

day,

month

changed_resources.voided_invoices.line_items.price.billable_metric

BillableMetricTiny · object

required

Show child attributes

changed_resources.voided_invoices.line_items.price.billable_metric.id

string

required

changed_resources.voided_invoices.line_items.price.fixed_price_quantity

number | null

required

changed_resources.voided_invoices.line_items.price.plan_phase_order

integer | null

required

changed_resources.voided_invoices.line_items.price.currency

string

required

changed_resources.voided_invoices.line_items.price.conversion_rate

number | null

required

changed_resources.voided_invoices.line_items.price.conversion_rate_config

UnitConversionRateConfig · object

required

UnitConversionRateConfig
TieredConversionRateConfig

Show child attributes

changed_resources.voided_invoices.line_items.price.conversion_rate_config.conversion_rate_type

enum<string>

required

Available options:

unit

changed_resources.voided_invoices.line_items.price.conversion_rate_config.unit_config

ConversionRateUnitConfig · object

required

Show child attributes

changed_resources.voided_invoices.line_items.price.conversion_rate_config.unit_config.unit_amount

string

required

Amount per unit of overage

changed_resources.voided_invoices.line_items.price.item

ItemSlim · object

required

A minimal representation of an Item containing only the essential identifying information.

Show child attributes

changed_resources.voided_invoices.line_items.price.item.id

string

required

The Orb-assigned unique identifier for the item.

changed_resources.voided_invoices.line_items.price.item.name

string

required

The name of the item.

changed_resources.voided_invoices.line_items.price.credit_allocation

Allocation · object

required

Show child attributes

changed_resources.voided_invoices.line_items.price.credit_allocation.currency

string

required

changed_resources.voided_invoices.line_items.price.credit_allocation.allows_rollover

boolean

required

changed_resources.voided_invoices.line_items.price.credit_allocation.custom_expiration

CustomExpiration · object

required

Show child attributes

changed_resources.voided_invoices.line_items.price.credit_allocation.custom_expiration.duration

integer

required

changed_resources.voided_invoices.line_items.price.credit_allocation.custom_expiration.duration_unit

enum<string>

required

Available options:

day,

month

changed_resources.voided_invoices.line_items.price.credit_allocation.filters

PriceFilter · object[]

Show child attributes

changed_resources.voided_invoices.line_items.price.credit_allocation.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.voided_invoices.line_items.price.credit_allocation.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.voided_invoices.line_items.price.credit_allocation.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.voided_invoices.line_items.price.composite_price_filters

PriceFilter · object[] | null

required

Show child attributes

changed_resources.voided_invoices.line_items.price.composite_price_filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.voided_invoices.line_items.price.composite_price_filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.voided_invoices.line_items.price.composite_price_filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.voided_invoices.line_items.price.discount

PercentageDiscount · object

required

deprecated

PercentageDiscount
TrialDiscount
UsageDiscount
AmountDiscount

Show child attributes

changed_resources.voided_invoices.line_items.price.discount.discount_type

enum<string>

required

Available options:

percentage

changed_resources.voided_invoices.line_items.price.discount.percentage_discount

number

required

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

Required range: 0 <= x <= 1

changed_resources.voided_invoices.line_items.price.discount.applies_to_price_ids

string[] | null

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

Example:

["h74gfhdjvn7ujokd", "7hfgtgjnbvc3ujkl"]

changed_resources.voided_invoices.line_items.price.discount.filters

PriceFilter · object[] | null

The filters that determine which prices to apply this discount to.

Show child attributes

changed_resources.voided_invoices.line_items.price.discount.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.voided_invoices.line_items.price.discount.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.voided_invoices.line_items.price.discount.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.voided_invoices.line_items.price.discount.reason

string | null

changed_resources.voided_invoices.line_items.price.minimum

Minimum · object

required

deprecated

Show child attributes

changed_resources.voided_invoices.line_items.price.minimum.minimum_amount

string

required

Minimum amount applied

changed_resources.voided_invoices.line_items.price.minimum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this minimum to.

Show child attributes

changed_resources.voided_invoices.line_items.price.minimum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.voided_invoices.line_items.price.minimum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.voided_invoices.line_items.price.minimum.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.voided_invoices.line_items.price.minimum.applies_to_price_ids

string[]

required

deprecated

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

changed_resources.voided_invoices.line_items.price.minimum_amount

string | null

required

deprecated

changed_resources.voided_invoices.line_items.price.maximum

Maximum · object

required

deprecated

Show child attributes

changed_resources.voided_invoices.line_items.price.maximum.maximum_amount

string

required

Maximum amount applied

changed_resources.voided_invoices.line_items.price.maximum.filters

PriceFilter · object[]

required

The filters that determine which prices to apply this maximum to.

Show child attributes

changed_resources.voided_invoices.line_items.price.maximum.filters.field

enum<string>

required

The property of the price to filter on.

Available options:

price_id,

item_id,

price_type,

currency,

pricing_unit_id

changed_resources.voided_invoices.line_items.price.maximum.filters.operator

enum<string>

required

Should prices that match the filter be included or excluded.

Available options:

includes,

excludes

changed_resources.voided_invoices.line_items.price.maximum.filters.values

string[]

required

The IDs or values that match this filter.

changed_resources.voided_invoices.line_items.price.maximum.applies_to_price_ids

string[]

required

deprecated

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

changed_resources.voided_invoices.line_items.price.maximum_amount

string | null

required

deprecated

changed_resources.voided_invoices.line_items.price.dimensional_price_configuration

DimensionalPriceConfiguration · object

Show child attributes

changed_resources.voided_invoices.line_items.price.dimensional_price_configuration.dimensional_price_group_id

string

required

changed_resources.voided_invoices.line_items.price.dimensional_price_configuration.dimension_values

string[]

required

changed_resources.voided_invoices.line_items.usage_customer_ids

string[] | null

required

A list of customer ids that were used to calculate the usage for this line item.

changed_resources.voided_invoices.line_items.filter

string | null

required

An additional filter that was used to calculate the usage for this line item.

changed_resources.voided_invoices.subtotal

string

required

The total before any discounts and minimums are applied.

changed_resources.voided_invoices.invoice_date

string<date-time>

required

The scheduled date of the invoice

API documentation

Alert

Coupon

Credit

Credit note

Customer

Dimensional Price Group

Event

Invoice

Item

Metric

Availability

Plan

Price

Subscription Change

Subscription

Price interval

Add or edit price intervals

Adding price intervals

Adjustment intervals

Editing price intervals

Fixed fee quantity transitions

Authorizations

Path Parameters

Body

Response

Supported Tax ID Countries and Types

Supported Tax ID Countries and Types

Supported Tax ID Countries and Types