Skip to main content
​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
invoice_item
​
amount
integer
required

The amount to be charged, represented as a whole integer if possible.

​
apply_after
integer | null
required

The date after which the invoice item will be applied.

​
credit_amount
integer
required

The amount of the credit to be applied to the invoice item.

​
currency
string
required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

​
customer
string
required

The ID of the customer the invoice item is for.

​
description
string | null
required

The description for the invoice item, to be displayed to the customer.

​
discount_amount
integer
required

The amount of the discount to be applied to the invoice item.

​
invoice
string | null
required

The ID of the invoice the invoice item is for.

Pattern: ^[a-zA-Z0-9_]+$
​
price_data
object
required
​
price
string | null
required

The ID of the price object.

Pattern: ^[a-zA-Z0-9_]+$
​
proration_amount
integer
required

The amount of the proration to be applied to the invoice item.

​
tax_percent
number
required

The tax percentage to use when calculating the tax amount.

Required range: 0 <= x <= 100
​
total_credit_grant_amount
integer
required

The total credit grant amount for the invoice item.

​
transfer_destination
string | null
required

ID of the owner that will be the transfer destination. Only allowed when the invoice item transfer behavior is owner.

​
type
enum<string>
required

The type of the invoice item.

Available options:
charge,
rent,
product
​
unit
string | null
required

The ID of the unit the invoice item is for.

Pattern: ^[a-zA-Z0-9_]+$
​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.

​
discount
integer
default:0

The amount of the discount applied to the invoice item.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
part_payment_amount
integer
default:0

The amount of the part payments already applied to the invoice item.

​
tax
integer
default:0

The amount of tax applied to the invoice item.

​
transfer_behavior
enum<string>
default:automatic

The invoice item transfer behavior. The default is automatic.

Available options:
automatic,
owner,
none