The tax rule object
A comprehensive list of the tax rule resource's attributes and relationships
A tax rule object is returned as part of the response body of each successful list, retrieve, create or update API call to the
/api/tax_rules
endpoint.Field | Type | Description |
---|---|---|
type | string | tax_rules |
id | string | The tax rule unique identifier |
links.self | string | The tax rule endpoint URL |
attributes.name | string | The tax rule internal name. |
attributes.tax_rate | float | The tax rate for this rule. |
attributes.country_code_regex | string | The regex that will be evaluated to match the shipping address country code. |
attributes.not_country_code_regex | string | The regex that will be evaluated as negative match for the shipping address country code. |
attributes.state_code_regex | string | The regex that will be evaluated to match the shipping address state code. |
attributes.not_state_code_regex | string | The regex that will be evaluated as negative match for the shipping address state code. |
attributes.zip_code_regex | string | The regex that will be evaluated to match the shipping address zip code. |
attributes.not_zip_code_regex | string | The regex that will be evaluated as negative match for the shipping zip country code. |
attributes.freight_taxable | boolean | Indicates if the freight is taxable. |
attributes.payment_method_taxable | boolean | Indicates if the payment method is taxable. |
attributes.gift_card_taxable | boolean | Indicates if gift cards are taxable. |
attributes.adjustment_taxable | boolean | Indicates if adjustemnts are taxable. |
attributes.breakdown | object | The breakdown for this tax rule (if calculated). |
attributes.created_at | datetime | Time at which the resource was created. |
attributes.updated_at | datetime | Time at which the resource was last updated. |
attributes.reference | string | A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin | string | Any identifier of the third party system that defines the reference code |
attributes.metadata | object | Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
relationships.manual_tax_calculator | object | The associated manual tax calculator. |
relationships.versions | array | The associated changes. |
meta.mode | string | The resource environment (can be one of test or live ) |
Last modified 29d ago