renew-token-response.md

Renew Token Response

Structure

RenewTokenResponse

Fields

Name	Type	Tags	Description	Getter	Setter
accessToken	?string	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	getAccessToken(): ?string	setAccessToken(?string accessToken): void
tokenType	?string	Optional	This value is always bearer. Constraints: Minimum Length: 2, Maximum Length: 10	getTokenType(): ?string	setTokenType(?string tokenType): void
expiresAt	?string	Optional	The date when the access_token expires, in ISO 8601 format. Constraints: Minimum Length: 20, Maximum Length: 48	getExpiresAt(): ?string	setExpiresAt(?string expiresAt): void
merchantId	?string	Optional	The ID of the authorizing merchant's business. Constraints: Minimum Length: 8, Maximum Length: 191	getMerchantId(): ?string	setMerchantId(?string merchantId): void
subscriptionId	?string	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.	getSubscriptionId(): ?string	setSubscriptionId(?string subscriptionId): void
planId	?string	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.	getPlanId(): ?string	setPlanId(?string planId): void
errors	?(Error[])	Optional	Any errors that occurred during the request.	getErrors(): ?array	setErrors(?array errors): void

Example (as JSON)

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