<- OAuth API

OAuth API

Renew token

POST

 /oauth2/clients/{client_id}/access-token/renew

RenewToken is deprecated.

For information about refreshing OAuth access tokens, see Migrate from Renew to Refresh OAuth Tokens.

Renews an OAuth access token before it expires.

OAuth access tokens besides your application's personal access token expire after 30 days. You can also renew expired tokens within 15 days of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must recomplete the OAuth flow from the beginning.

Important: The Authorization header for this endpoint must have the following format:

Authorization: Client APPLICATION_SECRET

Replace APPLICATION_SECRET with the application secret on the Credentials page in the Developer Dashboard.

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

client_id

string

Required

Link to section

Request body

Link to section

access_token

string

The token you want to renew.

Min Length
2
Max Length
1024
Link to section

Response fields

Link to section

access_token

string

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.

Min Length
2
Max Length
1024
Link to section

token_type

string

This value is always bearer.

Min Length
2
Max Length
10
Link to section

expires_at

string

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

Min Length
20
Max Length
48
Link to section

merchant_id

string

The ID of the authorizing merchant's business.

Min Length
8
Max Length
191
Link to section

subscription_id

string

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.

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

errors

Any errors that occurred during the request.