Object Index / Definition

You are viewing an old version of the API
Create​Order​Request​Tax

Deprecated

Please use the OrderLineItemTax type in the order field of CreateOrderRequest instead

Represents a tax that can apply to either a single line item or an entire order.

Properties

Name Description
catalog_object_id
string

Only used for catalog taxes. The catalog object ID of an existing CatalogTax.

Do not provide a value for this field if you provide values in other fields for an ad hoc tax.

Max Length 192
name
string

Only used for ad hoc taxes. The tax's name.

Do not provide a value for this field if you set catalog_object_id.

Max Length 255
percentage
string

Only used for ad hoc taxes. The percentage of the tax, as a string representation of a decimal number.

A value of 7.25 corresponds to a percentage of 7.25%. This value range between 0.0 up to 100.0

Max Length 10
type
string

Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax.

Default: ADDITIVE;

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?