Tax Transactions

A Tax Transaction records the tax collected from or refunded to your customer.

Related guide: Calculate tax in your custom payment flow

Was this section helpful? Yes No

Create a Transaction from a Calculation

POST / v1 / tax / transactions / create_from_calculation

Create a reversal Transaction

POST / v1 / tax / transactions / create_reversal

Retrieve a Transaction

GET / v1 / tax / transactions /:id

Retrieve a Transaction's line items

GET / v1 / tax / transactions /:id / line_items

The Tax Transaction object

Attributes

• id string Unique identifier for the transaction.
• object string, value is "tax.transaction" String representing the object’s type. Objects of the same type share the same value.
• currency string Three-letter ISO currency code, in lowercase. Must be a supported currency.
• customer _ details object The customer’s details, such as address and tax IDs.
• line _ items nullable object Includable The tax collected or refunded, by line item.
• metadata nullable map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
• reference string A custom unique identifier, such as ‘myOrder_123’.
• type enum If reversal, this transaction reverses an earlier transaction. Possible enum values reversal Represents a partial or full reversal of an earlier transaction. transaction Represents a customer sale or order.

More attributes

• created timestamp
• customer nullable string
• livemode boolean
• posted _ at timestamp
• reversal nullable object
• ship _ from _ details nullable object
• shipping _ cost nullable object
• tax _ date timestamp

The Tax Transaction object

Create a Transaction from a Calculation

POST / v1 / tax / transactions / create_from_calculation

Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.

Parameters

• calculation string Required Tax Calculation ID to be used as input when creating the transaction.
• reference string Required A custom order or sale identifier, such as ‘myOrder_123’. Must be unique across all transactions, including reversals. The maximum length is 500 characters.
• metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More parameters

• posted _ at timestamp

Returns

A Tax Transaction object.

Response