Schema2020-08-27object

shipping_method

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

ShippingMethod

object

amount integer

required

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the line item.

currency string

required

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

delivery_estimate

optionalnullable

The estimated delivery date for the given shipping method. Can be either a specific date or a range.

description string

required

An arbitrary string attached to the object. Often useful for displaying to users.

maxLength:5000

id string

required

Unique identifier for the object.

maxLength:5000

Root JSON Schema

{"properties":{"amount":{"description":"A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the line item.","type":"integer"},"currency":{"description":"Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).","type":"string"},"delivery_estimate":{"anyOf":[{"$ref":"#/components/schemas/delivery_estimate"}],"description":"The estimated delivery date for the given shipping method. Can be either a specific date or a range.","nullable":true},"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users.","maxLength":5000,"type":"string"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"}},"required":["amount","currency","description","id"],"title":"ShippingMethod","type":"object","x-expandableFields":["delivery_estimate"]}