The tax object

This object represents a customizable tax rate applicable to either the organization or a specific customer.

The tax object

{
    "tax": {
        "lago_id": "8a3b83f1-39d1-4579-b1a6-51435fb8f498",
        "name": "TVA",
        "code": "french_standard_vat",
        "rate": 20.0,
        "description": "French standard VAT",
        "applied_to_organization": true,
        "customers_count": 0,
        "created_at": "2023-07-10T12:00:02Z"
    }
}

Attributes

tax · object

Hide object

lago_id · string · required

Unique identifier of the tax created by Lago.

name · string · required

Name of the tax.

code · string · required

Unique code used to identify the tax associated with the API request.

rate · float · required

The percentage rate of the tax

description · string | null

Internal description of the tax.

applied_to_organization · boolean · required

Set to true if the tax is used as one of the organization’s default.

customers_count · integer · required

Number of customers this tax is applied to (directly or via the organization’s default).

created_at · string · required

Creation date of the tax.