Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.
Parameters
- calculationstringRequired
Tax Calculation ID to be used as input when creating the transaction.
- referencestringRequired
A custom order or sale identifier, such as ‘myOrder_123’. Must be unique across all transactions, including reversals.
The maximum length is 500 characters.
- metadatamap
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_
attimestamp
Returns
A Tax Transaction object.
curl https://api.stripe.com/v1/tax/transactions/create_from_calculation \ -u "sk_test_Hrs6SAopgFPF0bZXSN3f6ELNsk_test_Hrs6SAopgFPF0bZXSN3f6ELN:" \ -d calculation={{CALCULATION_ID}} \ -d reference=myOrder_123 \ -d "expand[]=line_items"{ "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"}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 valuesfullThe original transaction is fully reversed.
partialThe 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 The maximum length is 500 characters.
- 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.
- metadatamap
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
Returns
A new Tax Transaction object representing the reversal.
curl https://api.stripe.com/v1/tax/transactions/create_reversal \ -u "sk_test_Hrs6SAopgFPF0bZXSN3f6ELNsk_test_Hrs6SAopgFPF0bZXSN3f6ELN:" \ -d mode=partial \ -d original_transaction={{TRANSACTION_ID}} \ -d reference=myOrder_123-refund_1 \ -d "line_items[0][amount]=-1499" \ -d "line_items[0][amount_tax]=-148" \ -d "line_items[0][original_line_item]=tax_li_ONDxh8JZw14sP8" \ -d "line_items[0][reference]=refund of Pepperoni Pizza" \ -d "expand[0]=line_items"{ "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"}Retrieves a Tax Transaction object.
Parameters
No parameters.
Returns
A Tax Transaction object.
curl https://api.stripe.com/v1/tax/transactions/{{TRANSACTION_ID}} \ -u "sk_test_Hrs6SAopgFPF0bZXSN3f6ELNsk_test_Hrs6SAopgFPF0bZXSN3f6ELN:"{ "id": "tax_1NaS0I2eZvKYlo2CRuMhUcmz", "object": "tax.transaction", "created": 1690932566, "currency": "usd", "customer": null, "customer_details": { "address": { "city": "South San Francisco", "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_ONCP443tgfS8I1", "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_1NaS0I2eZvKYlo2CRuMhUcmz/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" }, "ship_from_details": { "address": { "postal_code": "75001", "state": "TX", "country": "US" } }, "tax_date": 1690932566, "type": "transaction"}