Partially or fully reverses a previously created Transaction
.
Parameters
- modeenumRequired
If
partial
, the provided line item or shipping cost amounts are reversed. Iffull
, the original transaction is fully reversed.Possible enum valuesfull
The original transaction is fully reversed.
partial
The provided line item amounts are reversed.
- original_
transactionstringRequired The ID of the Transaction to partially or fully reverse.
- referencestringRequired
A custom identifier for this reversal, such as
myOrder_
, which must be unique across all transactions. The reference helps identify this reversal transaction in exported tax reports.123-refund_ 1 - flat_
amountintegerRequired if mode=partial and line_items nor shipping_cost provided A flat amount to reverse across the entire transaction, in the smallest currency unit in negative. This value represents the total amount to refund from the transaction, including taxes.
- line_
itemsarray of objectsRequired if mode=partial and neither shipping_cost nor flat_amount is provided The line item amounts to reverse.
- line_items.
amountintegerRequired The amount to reverse, in the smallest currency unit in negative.
- line_items.
amount_ taxintegerRequired The amount of tax to reverse, in the smallest currency unit in negative.
- line_items.
original_ line_ itemstringRequired The
id
of the line item to reverse in the original transaction. - line_items.
referencestringRequired A custom identifier for this line item in the reversal transaction, such as ‘L1-refund’.
- line_items.
metadataobject 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.
- line_items.
quantityinteger The quantity reversed. Appears in tax exports, but does not affect the amount of tax reversed.
- metadataobject
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
- shipping_
costobjectRequired if mode=partial and neither line_items nor flat_amount is provided The shipping cost to reverse.
- shipping_cost.
amountintegerRequired The amount to reverse, in the smallest currency unit in negative.
- shipping_cost.
amount_ taxintegerRequired The amount of tax to reverse, in the smallest currency unit in negative.
Returns
A new Tax Transaction
object representing the reversal.
{ "id": "tax_1NaTVd2eZvKYlo2CoOX2Nf7P", "object": "tax.transaction", "created": 1690938353, "currency": "usd", "customer": null, "customer_details": { "address": { "city": null, "country": "US", "line1": "354 Oyster Point Blvd", "line2": "", "postal_code": "94080", "state": "CA" }, "address_source": "shipping", "ip_address": null, "tax_ids": [], "taxability_override": "none" }, "line_items": { "object": "list", "data": [ { "id": "tax_li_ONDxh8JZw14sP8", "object": "tax.transaction_line_item", "amount": 1499, "amount_tax": 148, "livemode": false, "metadata": null, "product": null, "quantity": 1, "reference": "Pepperoni Pizza", "reversal": null, "tax_behavior": "exclusive", "tax_code": "txcd_40060003", "type": "transaction" } ], "has_more": false, "url": "/v1/tax/transactions/tax_1NaTVd2eZvKYlo2CoOX2Nf7P/line_items" }, "livemode": false, "metadata": null, "posted_at": 1690932566, "reference": "myOrder_123", "reversal": null, "shipping_cost": { "amount": 300, "amount_tax": 0, "tax_behavior": "exclusive", "tax_code": "txcd_92010001" }, "tax_date": 1690938353, "type": "transaction"}