Skip to main content

TaxRateList

items object[]required

The tax rates in this page, newest first.

  • Array [
  • idstring<uuid>required

    Unique identifier for the tax rate.

    Example: 9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d
    displayNameTaxRate-DisplayNamerequired

    The name of the tax shown to the buyer.

    Possible values: non-empty and <= 50 characters

    Example: IVA
    percentageTaxRate-Percentagerequired

    The rate in percent, with up to 4 decimals. It cannot change after the tax rate is created.

    Possible values: >= 0 and <= 100

    Example: 21
    taxTypeTaxRate-TaxTyperequired

    The kind of tax: VAT, IGIC (Canary Islands) or IPSI (Ceuta and Melilla). It cannot change after the tax rate is created. Treat the set as open: more values can be added later.

    Default value: VAT
    Example: VAT
    activeTaxRate-Activerequired

    Whether the tax rate is active. Tax rates are never deleted: set active to false to archive one. An archived rate cannot be set on a product. While a product still has it, the product cannot get new prices and its prices cannot start or switch a subscription. Subscriptions that already use it keep their copy. A new tax rate is active unless created with active: false.

    Example: true
    createdAtinteger<int64>required

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

    Example: 1636366897
    updatedAtinteger<int64>

    Time at which the resource updated last time. Measured in seconds since the Unix epoch.

    Example: 1636366897
  • ]
  • nextCursorNextCursor

    Pass this value as cursor to get the next page. Absent when there are no more items. The last page can still carry it, and the next call then returns no items.

    Example: eyJpZCI6IjhmMmM2ZDFhIiwiY3JlYXRlZEF0IjoxNzYxMjE0NDAwfQ
    TaxRateList
    {
    "items": [
    {
    "id": "9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
    "displayName": "IVA",
    "percentage": 21,
    "taxType": "VAT",
    "active": true,
    "createdAt": 1636366897,
    "updatedAt": 1636366897
    }
    ],
    "nextCursor": "eyJpZCI6IjhmMmM2ZDFhIiwiY3JlYXRlZEF0IjoxNzYxMjE0NDAwfQ"
    }