UserSubscriptionEndpoint
The following resources are applicable:
- /user/subscription/activate
- /user/subscription/deactivate
- /user/subscription/get
- /user/subscription/launch
- /user/subscription/log
/user/subscription/activate
Mount Point: /rest/user/subscription/activate
POST
Activates a subscription. The subscription will not be extended anymore, but the current period can be used normally.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 110 | The user already is an active subscriber |
| 112 | The user subscription validation failed (should be retried after some time) |
| 600 | The api key is invalid |
Request Body
| element: | userSubscriptionActivateRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userSubscriptionActivateResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/subscription/deactivate
Mount Point: /rest/user/subscription/deactivate
POST
Deactivates a subscription. The subscription will not be extended anymore, but the current period can be used normally.
Error Codes
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userSubscriptionDeactivateRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userSubscriptionDeactivateResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/subscription/get
Mount Point: /rest/user/subscription/get
POST
Returns the user's subscription status.
Error Codes
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userSubscriptionGetRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userSubscriptionGetResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/subscription/launch
Mount Point: /rest/user/subscription/launch
POST
Launches the subscription flow on the master device.
Error Codes
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userSubscriptionLaunchRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userSubscriptionLaunchResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/subscription/log
Mount Point: /rest/user/subscription/log
POST
Logs an subscription flow event
Error Codes
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userSubscriptionLogRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userSubscriptionLogResponse |
| media types: | */* application/xml application/json |
(no documentation provided)