v1

latestOpenAPI 3.0.02026-07-2335196124.2 KB
Single Sign On

Single Sign On by subscription reference

Create Single Sign On links into 2Checkout myAccount based on subscription references.

get/subscriptions/{SubscriptionReference}/signon/{PageType}/

Path parameters

SubscriptionReferencestring required

Unique, system-generated subscription identifier.

PageTypestring required

The specific myAccount page you want the user to be redirected to. Possible values: view_order, my_license, change_card, my_products, payment_methods, user_data, order_lookup, faq - default: index page

Query parameters

Emailstring

End user email address belonging to the customers associated with the subscription.

LanguageCodestring

ISO language codes for the product - ISO 639-1.

ValidityTimeinteger

The time, in seconds, before the single sign-on URL expires. By default, the URL expires after 10 seconds.

ValidationIpstring

The IP address of the shopper, necessary for security purposes. Can be an empty string or a valid IP, or null.

Headers

Accept'application/json' required
X-Avangate-Authenticationstring required

Authentication header

Response

OK