POST /v1/tax/calculations
Calculates tax based on the input and returns a Tax Calculation
object.
Servers
- https://api.stripe.com/
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
customer |
String | No |
The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to |
line_items[] |
Array | Yes |
A list of items the customer is purchasing. |
line_items[].tax_code |
String | No | |
line_items[].amount |
Integer | Yes | |
line_items[].quantity |
Integer | No | |
line_items[].metadata |
Object | No | |
line_items[].product |
String | No | |
line_items[].reference |
String | No | |
line_items[].tax_behavior |
String | No |
Possible values:
|
tax_date |
Integer | No |
Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future. |
customer_details |
Object | No |
Details about the customer, including address and tax IDs. |
customer_details.ip_address |
String | No | |
customer_details.address_source |
String | No |
Possible values:
|
customer_details.tax_ids[] |
Array | No | |
customer_details.tax_ids[].type |
String | Yes |
Possible values:
|
customer_details.tax_ids[].value |
String | Yes | |
customer_details.taxability_override |
String | No |
Possible values:
|
customer_details.address |
Object | No | |
customer_details.address.line2 |
No | ||
customer_details.address.line1 |
No | ||
customer_details.address.postal_code |
No | ||
customer_details.address.country |
String | Yes | |
customer_details.address.state |
No | ||
customer_details.address.city |
No | ||
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
shipping_cost |
Object | No |
Shipping cost details to be used for the calculation. |
shipping_cost.shipping_rate |
String | No | |
shipping_cost.tax_code |
String | No | |
shipping_cost.amount |
Integer | No | |
shipping_cost.tax_behavior |
String | No |
Possible values:
|
currency |
String | Yes |
Three-letter ISO currency code, in lowercase. Must be a supported currency. |
ship_from_details |
Object | No |
Details about the address from which the goods are being shipped. |
ship_from_details.address |
Object | Yes | |
ship_from_details.address.line2 |
No | ||
ship_from_details.address.line1 |
No | ||
ship_from_details.address.postal_code |
No | ||
ship_from_details.address.country |
String | Yes | |
ship_from_details.address.state |
No | ||
ship_from_details.address.city |
No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.