POST
Buy coverage

Authorizations

Authorization
string
header
required

sk_test_ / sk_live_ / rk_test_ / rk_live_ keys

Headers

Shipping-Version
string
Shipping-Account
string

Act on behalf of a connected account (acct_...)

Idempotency-Key
string
required
Maximum string length: 255

Body

application/json
quote
string
shipment
string
connection
string
insured_value
object
user_metadata
object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

Response

OK

id
string
required

Prefixed cov_

Example:

"cov_1Q2w3E4r"

object
enum<string>
required
Available options:
coverage
livemode
boolean
required
created
integer<unix-time>
required

Unix timestamp (seconds)

status
enum<string>
required
Available options:
pending,
active,
expired,
cancelled,
claimed
shipment
string
required
insured_value
object
required
updated
integer<unix-time>

Unix timestamp (seconds)

connection
string
policy_number
string | null
premium
object
coverage_types
string[]
period
object
certificate
string | null
claims
string[]
user_metadata
object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

carrier_metadata
object
read-only

Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.

system_metadata
object
read-only

Read-only. Implementer provenance. Implementer-specific keys are prefixed x_.