getApplicationSubscriptionHistory
List<SubscriptionHistory> getApplicationSubscriptionHistory ( String vendorClientId ) throws Ac countAPINGException
Returns a list of subscriptions tokens that have been associated with the customers account. This allows a vendor to identify if a customer has a previous subscription to their application and the status of each subscription.
Parameter name |
Type |
Required |
Description |
vendorClientId |
String |
|
The unique customer |
applicationKey |
String |
|
identifier |
|
|
||
|
|
|
The unique application i |
|
|
|
dentifier |
Return type |
Description |
List<SubscriptionHistory> |
List of subscription tokens associated with the |
|
account |
Throws |
Description |
AccountAPINGException |
Generic exception that is thrown if this operation |
|
fails for any reason. |
*Since *
getApplicationSubscriptionToken
Operation
getApplicationSubscriptionToken
String getApplicationSubscriptionToken ( int subscriptionLength ) throws AccountAPINGExcepti on
Used to create new subscription tokens for an application. Returns the newly generated subscription token which can be provided to the end user.
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 |
AccountAPINGException |
Generic exception that is thrown if this operation |
|
fails for any reason. |
Since 1.0.0 |
|
getVendorClientId
getVendorClientId
String getVendorClientId ( ) throws AccountAPINGException
Returns the vendor client id for customer account which is a unique identifier for that customer. The vendor client Id can be used to obtain the customers application subscription history via getApplicationSu bscriptionHistory. The request requires the X-Authentication header only
Return type |
Description |
String |
Vendor client id. |
Throws |
Description |
AccountAPINGException |
Generic exception that is thrown if this operation |
|
fails for any reason. |
Since 1.0.0 |
|
listAccountSubscriptionTokens
Operation
listAccountSubscriptionTokens
List< AccountSubscription > listAccountSubscriptionTokens ( ) throws AccountAPINGException
List of subscription tokens associated with the account
Return type |
Description |
List< AccountSubscription > |
List of subscription tokens associated with the |
|
account |
Throws |
Description |
AccountAPINGException |
Generic exception that is thrown if this operation |
|
fails for any reason. |
Since 1.0.0 |
|
listApplicationSubscriptionTokens |
|
Operation
listApplicationSubscriptionTokens
List< ApplicationSubscription > listApplicationSubscriptionTokens ( SubscriptionStatus subscrip tionStatus ) throws AccountAPINGException
Returns a list of subscription tokens for an application based on the subscription status passed in the request. Returns all subscription token details, including the client reference and vendor client Id associated with the subscription token.
Parameter name |
Type |
Required |
Description |
subscriptionStatus |
SubscriptionStatus |
|
Optionally filter |
|
|
|
response by |
|
|
|
Subscription status of |
|
|
|
the token |
Return type |
Description |
List< ApplicationSubscription > |
List of subscription tokens for an application |
Throws |
Description |
AccountAPINGException |
Generic exception that is thrown if this operation |
|
fails for any reason. |
Since 1.0.0 |
|
updateApplicationSubscription
Operation