Core resources
Leasing resources
Billing resources
Payments resources
Loyalty resources
Guardrails resources
Owners resources
curl --request POST \
--url https://api.yorlet.com/v1/invoice_items \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 123,
"currency": "<string>",
"customer": "<string>",
"description": "<string>",
"tax_percent": 50,
"transfer_behavior": "automatic",
"type": "charge",
"apply_after": 123,
"invoice": "<string>",
"metadata": {},
"period_end": 123,
"period_start": 123,
"price": "<string>",
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
'{
"id": "<string>",
"created": 123,
"object": "invoice_item",
"amount": 123,
"apply_after": 123,
"credit_amount": 123,
"currency": "<string>",
"customer": "<string>",
"description": "<string>",
"discount_amount": 123,
"invoice": "<string>",
"price_data": {
"amount": 123,
"currency": "<string>",
"recurring": {
"interval": "<string>",
"interval_count": 123
},
"tax_percent": 50,
"type": "recurring"
},
"price": "<string>",
"proration_amount": 123,
"tax_percent": 50,
"total_credit_grant_amount": 123,
"transfer_destination": "<string>",
"type": "charge",
"unit": "<string>",
"account": "<string>",
"deleted": false,
"metadata": {},
"transfer_behavior": "automatic"
}Create a invoice item
Create a invoice item
curl --request POST \
--url https://api.yorlet.com/v1/invoice_items \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 123,
"currency": "<string>",
"customer": "<string>",
"description": "<string>",
"tax_percent": 50,
"transfer_behavior": "automatic",
"type": "charge",
"apply_after": 123,
"invoice": "<string>",
"metadata": {},
"period_end": 123,
"period_start": 123,
"price": "<string>",
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
'{
"id": "<string>",
"created": 123,
"object": "invoice_item",
"amount": 123,
"apply_after": 123,
"credit_amount": 123,
"currency": "<string>",
"customer": "<string>",
"description": "<string>",
"discount_amount": 123,
"invoice": "<string>",
"price_data": {
"amount": 123,
"currency": "<string>",
"recurring": {
"interval": "<string>",
"interval_count": 123
},
"tax_percent": 50,
"type": "recurring"
},
"price": "<string>",
"proration_amount": 123,
"tax_percent": 50,
"total_credit_grant_amount": 123,
"transfer_destination": "<string>",
"type": "charge",
"unit": "<string>",
"account": "<string>",
"deleted": false,
"metadata": {},
"transfer_behavior": "automatic"
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
The amount to be charged, represented as a whole integer if possible.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
The ID of the customer the invoice item is for.
The description for the invoice item, to be displayed to the customer.
The tax percentage to use when calculating the tax amount.
0 <= x <= 100The invoice item transfer behavior. The default is automatic.
automatic, owner, none The type of the invoice item.
charge, rent, product The date after which the invoice item will be applied.
The ID of the invoice the invoice item is for.
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.
Show child attributes
Show child attributes
The end date of the invoice item.
The start date of the invoice item.
The ID of the price object.
The ID of the tax rate object.
ID of the owner that will be the transfer destination. Only allowed when the invoice item transfer behavior is owner.
The ID of the unit the invoice item is for.
Response
Create a invoice item
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
invoice_item The amount to be charged, represented as a whole integer if possible.
The date after which the invoice item will be applied.
The amount of the credit to be applied to the invoice item.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
The ID of the customer the invoice item is for.
The description for the invoice item, to be displayed to the customer.
The amount of the discount to be applied to the invoice item.
The ID of the invoice the invoice item is for.
^[a-zA-Z0-9_]+$Show child attributes
Show child attributes
The ID of the price object.
^[a-zA-Z0-9_]+$The amount of the proration to be applied to the invoice item.
The tax percentage to use when calculating the tax amount.
0 <= x <= 100The total credit grant amount for the invoice item.
ID of the owner that will be the transfer destination. Only allowed when the invoice item transfer behavior is owner.
The type of the invoice item.
charge, rent, product The ID of the unit the invoice item is for.
^[a-zA-Z0-9_]+$The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
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.
Show child attributes
Show child attributes
The invoice item transfer behavior. The default is automatic.
automatic, owner, none Was this page helpful?