POST /v1/shipping_rates
Creates a new shipping rate 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 |
|---|---|---|---|
tax_code |
String | No |
A tax code ID. The Shipping tax code is |
delivery_estimate |
Object | No |
The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. |
delivery_estimate.minimum |
Object | No | |
delivery_estimate.minimum.value |
Integer | Yes | |
delivery_estimate.minimum.unit |
String | Yes |
Possible values:
|
delivery_estimate.maximum |
Object | No | |
delivery_estimate.maximum.value |
Integer | Yes | |
delivery_estimate.maximum.unit |
String | Yes |
Possible values:
|
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
display_name |
String | Yes |
The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. |
fixed_amount |
Object | No |
Describes a fixed amount to charge for shipping. Must be present if type is |
fixed_amount.amount |
Integer | Yes | |
fixed_amount.currency_options |
Object | No | |
fixed_amount.currency_options.name |
Object | No | |
fixed_amount.currency_options.name.amount |
Integer | Yes | |
fixed_amount.currency_options.name.tax_behavior |
String | No |
Possible values:
|
fixed_amount.currency |
String | Yes | |
metadata |
Object | No |
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 |
type |
String | No |
The type of calculation to use on the shipping rate. Possible values:
|
tax_behavior |
String | No |
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of Possible values:
|
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.