Summary
When adding a new subscription, you can specify the length of a trial using the TrialDays resource. To extend a trial period for an existing subscription, the subscription must be deactivated and reactivated - this resets the TrialDays value.
NOTE: The amount of days available in a trial are set when creating the subscription and cannot be amended. Reactivation will reset the available days to the amount set at creation.
Process
For new subscriptions, set the length of the trial:
Specifying the length of a trial for new subscriptions
To set the number of days in a trial:
- Construct an API call using the following information:
Method POST URL https://cloudapi.exclaimer.com Endpoint EITHER exclaimerapi OR any custom endpoint you may have been provided Version 1.0 Resource subscriptions
- Construct the body of the request using the Add Subscription information.
- Within the body, ensure the SkipTrial boolean is set to false.
- Enter a numeric value after TrialDays to set the number of days available in the trial.
For existing subscriptions, deactivate and reativate to start the trial again:
Deactivating a subscription
To deactivate a subscription:
- Construct an API call using the following information:
Method PUT URL https://cloudapi.exclaimer.com Endpoint EITHER exclaimerapi OR any custom endpoint you may have been provided Version 1.0 Resource subscriptions - Construct your request by adding your subscription ID. For help locating your subscription ID, see How to locate your subscription ID in the Exclaimer portal.
- Enter deactivate.
Reactivating a subscription
To reactivate a trial subscription:
- Construct an API call using the following information:
Method PUT URL https://cloudapi.exclaimer.com Endpoint EITHER exclaimerapi OR any custom endpoint you may have been provided Version 1.0 Resource subscriptions - Construct your request by adding your subscription ID. For help locating your subscription ID, see How to locate your subscription ID in the Exclaimer portal.
- Enter reactivate.
- As the body of the request, enter InTrial followed by true.
Responses
The SUCCESS response is:
- For AddSubscription, 200 Success
- For DeactivateSubscription and ReactivateSubscription, 204 No Content
The FAILURE responses are:
- 400 Bad Request / Missing Field
- 401 Unauthorized
- For AddSubscription, 403 Forbidden
- 404 Not Found
- 415 Unsupported Media Type
- 500 Internal Server Error
NOTE: For JSON and cURL examples, see the Add Subscription, Deactivate Subscription, and Reactivate Subscription data.