GET
Retrieve the current account

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

Response

OK

id
string
required

Prefixed acct_

Example:

"acct_1Q2w3E4r"

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

Unix timestamp (seconds)

type
enum<string>
required
Available options:
merchant,
carrier,
partner,
platform,
internal
status
enum<string>
required
Available options:
onboarding,
active,
restricted,
suspended,
closed
updated
integer<unix-time>

Unix timestamp (seconds)

carrier
object | null
parent
string | null
profile
object
settings
object
modules
string[]
requirements
object
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_.