Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.88 KB

renew-token-response.md

File metadata and controls

30 lines (22 loc) · 1.88 KB

Renew Token Response

Structure

RenewTokenResponse

Fields

Name Type Tags Description
accessToken string | undefined Optional The renewed access token.
This value might be different from the access_token you provided in your request.
You provide this token in a header with every request to Connect API endpoints.
See Request and response headers for the format of this header.
Constraints: Minimum Length: 2, Maximum Length: 1024
tokenType string | undefined Optional This value is always bearer.
Constraints: Minimum Length: 2, Maximum Length: 10
expiresAt string | undefined Optional The date when the access_token expires, in ISO 8601 format.
Constraints: Minimum Length: 20, Maximum Length: 48
merchantId string | undefined Optional The ID of the authorizing merchant's business.
Constraints: Minimum Length: 8, Maximum Length: 191
subscriptionId string | undefined Optional LEGACY FIELD. The ID of the merchant subscription associated with
the authorization. The ID is only present if the merchant signed up for a subscription
during authorization.
planId string | undefined Optional 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.
errors Error[] | undefined Optional Any errors that occurred during the request.

Example (as JSON)

{
  "access_token": "ACCESS_TOKEN",
  "expires_at": "2006-01-02T15:04:05Z",
  "merchant_id": "MERCHANT_ID",
  "token_type": "bearer"
}