<- Object

Object

ObtainTokenResponse

Link to section

Properties

Link to section

access_token

string

A valid OAuth access token. Provide the access token in a header with every request to Connect API endpoints. For more information, see OAuth API: Walkthrough.

Link to section

token_type

string

This value is always bearer.

Link to section

expires_at

string

The date when the access_token expires, in ISO 8601 format.

Link to section

merchant_id

string

The ID of the authorizing merchant's business.

Link to section

subscription_id

string

LEGACY FIELD. The ID of a subscription plan the merchant signed up for. The ID is only present if the merchant signed up for a subscription plan during authorization.

Link to section

plan_id

string

LEGACY FIELD. The ID of the subscription plan the merchant signed up for. The ID is only present if the merchant signed up for a subscription plan during authorization.

Link to section

id_token

string

Deprecated

The OpenID token belonging to this person. This token is only present if the OPENID scope is included in the authorization request.

Link to section

refresh_token

string

Link to section

short_lived

boolean

A Boolean indicating that the access token is a short-lived access token. The short-lived access token returned in the response expires in 24 hours.

Link to section

errors

Any errors that occurred during the request.

Link to section

refresh_token_expires_at

string

The date when the refresh_token expires, in ISO 8601 format.