| Property | Description |
|---|---|
| applyToDigitals |
If set to true, the profile will apply to digital items. |
| applyToShipping |
If set to true, the profile will apply to shipping charges. |
| countryCode nullable |
Two-character ISO-3166 code identifying the destination country where this tax profile option is available. If not provided, the profile will apply to all countries where products are offered. This field is required if |
| created read-only |
The date on which the entity was created. |
| id read-only |
The identifier for the tax profile. |
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
| name |
Name of the Tax Profile |
| stateCode nullable |
Two-character state/province code identifying the destination country where this tax profile option is available. If not provided, the profile will apply to all states/provinces within the The property |
| taxBreakdownName1 nullable |
Tax breakdowns allow a user to split the tax rate ( Name of the 1st tax breakdown. If the This property is required if |
| taxBreakdownName2 nullable |
Name of the 2nd tax breakdown. If the This property is required if |
| taxBreakdownPercentage1 nullable |
Percentage of the 1st tax breakdown. If the This property is required if |
| taxBreakdownPercentage2 nullable |
Percentage of the 2nd tax breakdown. If the This property is required if |
| taxPercentage |
Tax percentage |
| type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"properties": {
"applyToDigitals": {
"description": "If set to true, the profile will apply to digital items.",
"type": "boolean"
},
"applyToShipping": {
"description": "If set to true, the profile will apply to shipping charges.",
"type": "boolean"
},
"countryCode": {
"description": "Two-character ISO-3166 code identifying the destination country where this\ntax profile option is available. If not provided, the profile will apply\nto all countries where products are offered.\n\nThis field is required if `stateCode` is provided.",
"example": "US",
"nullable": true,
"type": "string"
},
"created": {
"$ref": "#/components/schemas/Signature/properties/created"
},
"id": {
"description": "The identifier for the tax profile.",
"readOnly": true,
"type": "integer"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"name": {
"description": "Name of the Tax Profile",
"type": "string"
},
"stateCode": {
"description": "Two-character state/province code identifying the destination country where this\ntax profile option is available. If not provided, the profile will apply\nto all states/provinces within the `countryCode`.\n\nThe property `countryCode` is required for this property, and the region\nidentified by the `stateCode` must be located within the country identified\nby the `countryCode`.",
"example": "NY",
"nullable": true,
"type": "string"
},
"taxBreakdownName1": {
"description": "Tax breakdowns allow a user to split the tax rate (`taxPercentage`) value above into 2 pieces for more\ngranularity on what the taxes represent that are being charged. If set, this breakdown will display in the\nshopping cart and on invoices.\n\nName of the 1st tax breakdown. If the `taxPercentage` should be broken down, this specifies the name of the\nfirst percentage in the breakdown.\n\nThis property is required if `taxBreakdownPercentage1` is provided.",
"nullable": true,
"type": "string"
},
"taxBreakdownName2": {
"description": "Name of the 2nd tax breakdown. If the `taxPercentage` should be broken down, this specifies the name of the\nsecond percentage in the breakdown. Refer to the `taxBreakdownName1` documentation for more information about\ntax breakdowns.\n\nThis property is required if `taxBreakdownPercentage2` is provided.",
"nullable": true,
"type": "string"
},
"taxBreakdownPercentage1": {
"description": "Percentage of the 1st tax breakdown. If the `taxPercentage` should be broken down, this specifies the first\npercentage in the breakdown. Refer to the `taxBreakdownName1` documentation for more information about tax\nbreakdowns.\n\nThis property is required if `taxBreakdownName1` is provided.",
"format": "float",
"nullable": true,
"type": "number"
},
"taxBreakdownPercentage2": {
"description": "Percentage of the 2nd tax breakdown. If the `taxPercentage` should be broken down, this specifies the second\npercentage in the breakdown. Refer to the `taxBreakdownName1` documentation for more information about tax\nbreakdowns.\n\nThis property is required if `taxBreakdownName2` is provided.",
"format": "float",
"nullable": true,
"type": "number"
},
"taxPercentage": {
"description": "Tax percentage",
"format": "float",
"type": "number"
},
"type": {
"allOf": [
{
"enum": [
"tax-profile"
]
},
{
"$ref": "#/components/schemas/Type"
}
]
}
},
"required": [
"type",
"name",
"taxPercentage"
],
"title": "Tax Profile",
"type": "object"
}