POST
Grant access

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
Maximum string length: 255

Body

application/json
grantee
string
required
subjects
object
required
fields
string[]
purpose
string
expires_at
integer<unix-time>

Unix timestamp (seconds)

Response

OK

id
string
required

Prefixed grt_

Example:

"grt_1Q2w3E4r"

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

Unix timestamp (seconds)

grantor
string
required
grantee
string
required
status
enum<string>
required
Available options:
active,
revoked,
expired
updated
integer<unix-time>

Unix timestamp (seconds)

subjects
object
fields
string[]
purpose
string
expires_at
integer<unix-time> | null

Unix timestamp (seconds)

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_.