{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/stripe/main/json-schema/stripe-shipping-rate-schema.json", "title": "ShippingRate", "description": "Shipping rates describe the price of shipping presented to your customers and\napplied to a purchase. For more information, see [Charge for shipping](https://stripe.com/docs/payments/during-payment/charge-shipping).", "x-generated": "2026-10-12", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/stripe-shipping-rates-api-openapi.yml#/components/schemas/shipping_rate", "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": "#/$defs/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." }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", "maxLength": 5000, "type": [ "string", "null" ] }, "fixed_amount": { "$ref": "#/$defs/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" ], "type": [ "string", "null" ] }, "tax_code": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/$defs/tax_code" } ], "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.", "x-expansionResources": { "oneOf": [ { "$ref": "#/$defs/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" ], "type": "object", "x-expandableFields": [ "delivery_estimate", "fixed_amount", "tax_code" ], "x-resourceId": "shipping_rate", "$defs": { "shipping_rate_delivery_estimate": { "type": "object", "description": "Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.", "x-ae-placeholder": true }, "shipping_rate_fixed_amount": { "type": "object", "description": "Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.", "x-ae-placeholder": true }, "tax_code": { "type": "object", "description": "Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.", "x-ae-placeholder": true } } }