# shipping\_rate

From **Stripe API**.

Shipping rates describe the price of shipping presented to your customers and can be
applied to [Checkout Sessions](https://stripe.com/docs/payments/checkout/shipping) to collect shipping costs.

- Type: `object`

## Properties

### `active`

- Required: true
- Type: `boolean`

Whether the shipping rate can be used for new purchases. Defaults to `true`.

### `created`

- Required: true
- Type: `integer`
- Format: `unix-time`

Time at which the object was created. Measured in seconds since the Unix epoch.

### `delivery_estimate`

- Required: false
- Nullable: true

The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.

### `display_name`

- Required: false
- Type: `string`
- Nullable: true
- maxLength: `5000`

The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.

### `fixed_amount`

- Required: false
- Type: `object`

### `id`

- Required: true
- Type: `string`
- maxLength: `5000`

Unique identifier for the object.

### `livemode`

- Required: true
- Type: `boolean`

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

### `metadata`

- Required: true
- Type: `object`

Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

### `object`

- Required: true
- Type: `string`
- Allowed values: `"shipping_rate"`

String representing the object's type. Objects of the same type share the same value.

### `tax_behavior`

- Required: false
- Type: `string`
- Nullable: true
- Allowed values: `"exclusive"`, `"inclusive"`, `"unspecified"`

Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.

### `tax_code`

- Required: false
- Nullable: true

A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`.

### `type`

- Required: true
- Type: `string`
- Allowed values: `"fixed_amount"`

The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.

## JSON Schema

```json
{"description":"Shipping rates describe the price of shipping presented to your customers and can be\napplied to [Checkout Sessions](https://stripe.com/docs/payments/checkout/shipping) to collect shipping costs.","properties":{"active":{"description":"Whether the shipping rate can be used for new purchases. Defaults to `true`.","type":"boolean"},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"delivery_estimate":{"anyOf":[{"$ref":"#/components/schemas/shipping_rate_delivery_estimate"}],"description":"The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.","nullable":true},"display_name":{"description":"The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.","maxLength":5000,"nullable":true,"type":"string"},"fixed_amount":{"$ref":"#/components/schemas/shipping_rate_fixed_amount"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string"},"description":"Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"object"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["shipping_rate"],"type":"string"},"tax_behavior":{"description":"Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.","enum":["exclusive","inclusive","unspecified"],"nullable":true,"type":"string"},"tax_code":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/tax_code"}],"description":"A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/tax_code"}]}},"type":{"description":"The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.","enum":["fixed_amount"],"type":"string"}},"required":["active","created","id","livemode","metadata","object","type"],"title":"ShippingRate","type":"object","x-expandableFields":["delivery_estimate","fixed_amount","tax_code"],"x-resourceId":"shipping_rate"}
```