Create invoice line item
This creates a one-off fixed fee invoice line item on an Invoice.
This can only be done for invoices that are in a draft status.
Authorizations
API Keys can be issued in the Orb's web application.
Body
A date string to specify the line item's start date in the customer's timezone.
A date string to specify the line item's end date in the customer's timezone.
The number of units on the line item
The id of the Invoice to add this line item.
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.
The total amount in the invoice's currency to add to the line item.
Response
The final amount for a line item after all adjustments and pre paid credits have been applied.
The end date of the range of time applied for this line item's price.
[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.
This field is deprecated in favor of adjustments.
This field is deprecated in favor of adjustments.
This field is deprecated in favor of adjustments.
This field is deprecated in favor of adjustments.
All adjustments (ie. maximums, minimums, discounts) applied to the line item.
The name of the price associated with this line item.
Either the fixed fee quantity or the usage during the service period.
The start date of the range of time applied for this line item's price.
The line amount before before any adjustments.
The line amount after any adjustments and before overage conversion, credits and partial invoicing.
The number of prepaid credits applied.
Any amount applied from a partial invoice
For complex pricing structures, the line item can be broken down further in sub_line_items.
An array of tax rates and their incurred tax amounts. Empty if no tax integration is configured.
A unique ID for this line item.
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
Was this page helpful?