GET
Retrieve a connect session

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

Path Parameters

id
string
required

Response

OK

id
string
required
object
enum<string>
required
Available options:
connect_session
status
enum<string>
required
Available options:
open,
completed,
failed,
expired
carrier
string
required
url
string<uri>
required
expires_at
integer<unix-time>
required

Unix timestamp (seconds)

livemode
boolean
created
integer<unix-time>

Unix timestamp (seconds)

mode
enum<string>
Available options:
redirect,
device
app
string | null
user_code
string | null
return_url
string | null
connection
string | null
error
object | null