ObtainTokenResponse
April 22, 2020 ยท View on GitHub
Description
Properties
| Name | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| access_token | getAccessToken() | setAccessToken($value) | string | A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. See the Build with OAuth guide for more information. | [optional] |
| token_type | getTokenType() | setTokenType($value) | string | This value is always bearer. | [optional] |
| expires_at | getExpiresAt() | setExpiresAt($value) | string | The date when access_token expires, in ISO 8601 format. | [optional] |
| merchant_id | getMerchantId() | setMerchantId($value) | string | The ID of the authorizing merchant's business. | [optional] |
| subscription_id | getSubscriptionId() | setSubscriptionId($value) | string | LEGACY FIELD. The ID of a subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] |
| plan_id | getPlanId() | setPlanId($value) | string | T__LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] |
| id_token | getIdToken() | setIdToken($value) | string | Then OpenID token belonging to this this person. Only present if the OPENID scope is included in the authorize request. | [optional] |
| refresh_token | getRefreshToken() | setRefreshToken($value) | string | A refresh token. OAuth refresh tokens are 64 bytes long. For more information, see OAuth access token management. | [optional] |
Note: All properties are protected and only accessed via getters and setters.