Create subscription management session

Creates an Aura-hosted session where the authenticated customer can manage or cancel their subscription and payment details. Redirect the customer to the returned url; they return to your returnUrl when done. The customer is resolved from the access token.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
returnUrlstringRequiredformat: "uri"
Where the customer is redirected after managing their subscription.
localestringOptional
Optional locale for the hosted experience.
configurationstringOptional
Optional portal configuration identifier.

Response

Successful.
urlstringformat: "uri"
Hosted URL to redirect the customer to.

Errors

400
Bad Request Error
401
Unauthorized Error