Invoice Templates

This resource represents an invoice template. An invoice template provides a reusable configuration for creating invoices with predefined line items, tax settings, and other invoice details.

All amounts are in the minor unit of the currency. For example, 1000 represents $10.00 for USD, £10.00 for GBP, or ¥1000 for JPY.

Properties

idstring

The unique identifier for this invoice template.

objectstring

The object type of this resource.

createdAtstring

The date this template was created in RFC3339 format.

updatedAtstring

The date this template was last updated in RFC3339 format.

namestring

The name of the invoice template.

memostring

An arbitrary string attached to the template, often useful for displaying to users.

taxPercentagenumber

The percentage of tax to be applied to invoices created from this template.

currencystring

The 3 letter currency code representing the settlement currency for invoices created from this template.

lineItemsarray(object)

Array of line items to be included in invoices created from this template:

• amountnumber

Amount in cents for one unit. Required if priceId not provided

• descriptionstring

Description of the line item. Optional for items with priceId where product name is used

• quantitynumber

Quantity of the item (can be decimal)

• priceIdstring

ID of the price object. Required if amount not provided

• productIdstring

ID of the associated product object

Example Invoice Template Object

{
    "id": "81108543-bc52-4202-83de-71ad52a74df9",
    "object": "invoiceTemplate",
    "createdAt": "2024-06-25T21:34:52.436152Z",
    "updatedAt": "2024-06-25T21:34:52.436152Z",
    "name": "Test template1",
    "memo": "this subscription has a product and one off item.",
    "taxPercentage": 0,
    "currency": "usd",
    "lineItems": [
        {
            "amount": 1000,
            "description": "item a",
            "quantity": 3
        },
        {
            "amount": 100000,
            "description": "Item B",
            "priceId": "ZC9UiqQSR",
            "productId": "9e1e238f-25e5-4aff-b5f3-6793f8f2703f",
            "quantity": 1
        }
    ]
}