POST
/
invoice_line_items

Authorizations

Authorization
string
header
required

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

Body

application/json
amount
string
required

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

end_date
string
required

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

invoice_id
string
required

The id of the Invoice to add this line item.

name
string
required

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

quantity
number
required

The number of units on the line item

start_date
string
required

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

Response

201 - application/json
amount
string
required

The final amount after any discounts or minimums.

discount
object | null
required
end_date
string
required

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

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.

id
string
required

A unique ID for this line item.

maximum
object | null
required
maximum_amount
string | null
required
minimum
object | null
required
minimum_amount
string | null
required
name
string
required

The name of the price associated with this line item.

price
object | null
required

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

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

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

quantity
number
required
start_date
string
required

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

sub_line_items
object[]
required

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

subtotal
string
required

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

tax_amounts
object[]
required

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