Skip to main content

TaxDetails

The tax of a subscription, copied from the tax rate of its product when priceId was set. A later change of the product's tax rate does not change it: only a switch to a price does.

taxRateIdstring<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
behaviorTaxBehaviorrequired

How the tax of the product's tax rate applies to unitAmount:

  • INCLUSIVE: unitAmount holds the tax.
  • EXCLUSIVE: the tax is added to unitAmount.

No value means INCLUSIVE. Treat the set as open: more values can be added later.

Example: EXCLUSIVE
amountinteger<int32>required

The tax part of the subscription amount, in the smallest currency unit. 0 for a 0% rate.

Possible values: >= 0

Example: 210
TaxDetails
{
"taxRateId": "9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
"displayName": "IVA",
"percentage": 21,
"taxType": "VAT",
"behavior": "EXCLUSIVE",
"amount": 210
}