getApplicationSubscriptionToken
Operation
getApplicationSubscriptionToken
String getApplicationSubscriptionToken ( int subscriptionLength ) throws AccountAPINGException
Used to create new subscription tokens for an application. Returns the newly generated subscription token which can be provided to the end user.
Please note: A maximum number of 15,000 subscription UNACTIVATED subscriptions tokens can be created at any one time. Attempts to create more subscription tokens will return the error TOO_MANY_REQUESTS error which will restrict creation of further tokens until existing UNACTIVATED subscription tokens have been ACTIVATED or CANCELLED
Parameter name | Type | Required | Description |
---|---|---|---|
subscriptionLength | int | How many days the subscription should last. Open ended if value not supplied. Expiry time will be rounded up to midnight on the date of expiry. | |
clientReference | String | Any client reference for this subscription token request. |
Return type | Description |
---|---|
String | Subscription token |
Throws | Description |
---|---|
Generic exception that is thrown if this operation fails for any reason. |
Since 1.0.0