Schema2020-08-27object

issuing_card_shipping

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

IssuingCardShipping

object

address Address object

required

carrier string

optionalnullable

The delivery company that shipped a card.

Allowed: "dhl""fedex""royal_mail""usps"

eta integer (unix-time)

optionalnullable

A unix timestamp representing a best estimate of when the card will be delivered.

name string

required

Recipient name.

maxLength:5000

service string

required

Shipment service, such as `standard` or `express`.

Allowed: "express""priority""standard"

status string

optionalnullable

The delivery status of the card.

Allowed: "canceled""delivered""failure""pending""returned""shipped"

tracking_number string

optionalnullable

A tracking number for a card shipment.

maxLength:5000

tracking_url string

optionalnullable

A link to the shipping carrier's site where you can view detailed information about a card shipment.

maxLength:5000

type string

required

Packaging options.

Allowed: "bulk""individual"

Root JSON Schema

{"properties":{"address":{"$ref":"#/components/schemas/address"},"carrier":{"description":"The delivery company that shipped a card.","enum":["dhl","fedex","royal_mail","usps"],"nullable":true,"type":"string"},"eta":{"description":"A unix timestamp representing a best estimate of when the card will be delivered.","format":"unix-time","nullable":true,"type":"integer"},"name":{"description":"Recipient name.","maxLength":5000,"type":"string"},"service":{"description":"Shipment service, such as `standard` or `express`.","enum":["express","priority","standard"],"type":"string","x-stripeBypassValidation":true},"status":{"description":"The delivery status of the card.","enum":["canceled","delivered","failure","pending","returned","shipped"],"nullable":true,"type":"string"},"tracking_number":{"description":"A tracking number for a card shipment.","maxLength":5000,"nullable":true,"type":"string"},"tracking_url":{"description":"A link to the shipping carrier's site where you can view detailed information about a card shipment.","maxLength":5000,"nullable":true,"type":"string"},"type":{"description":"Packaging options.","enum":["bulk","individual"],"type":"string"}},"required":["address","name","service","type"],"title":"IssuingCardShipping","type":"object","x-expandableFields":["address"]}