License Credits Modify

Update the number of in-app credits for a License Key.

Example Usage


http://api.cloudapplicenser.com/v1/license_credits_modify?token={TOKEN}&appuniqueid={UNIQUEID}&licensekey={LICENSEKEY}&action={ACTION}&quantity={QUANTITY}&description={DESCRIPTION}

Usage Notes

When adding or removing in-app credits for a License Key, you can decide how many to add or remove, and you must also provide a short description (for example "10 Bonus Points Awarded") and optional reference (for example an in-app payment reference to associate with the transaction). The JSON data returned will include only the updated number of credits applicable to that license.

Example Output


{
    "status": "success",
    "credits": "15"
}

Parameters
token
(int) (Required)
Your app's Security Token.
appuniqueid
(int) (Required)
Your app's Unique ID.
licensekey
(int) (Required)
The locally stored License Key.
action
(constant) (Required)
Define action as 'ADD' or 'REMOVE'.
quantity
(int) (Required)
Quantity to add or remove.
description
(string) (Required)
A short description (maximum of 150 characters) of the action. Note that this field must be urlencoded and must not contain HTML entities.
reference
(string) (Optional)
A short reference, such as a payment transaction ID (maximum of 150 characters). Note that this field must be urlencoded and must not contain HTML entities.

Examples

Add credits to a License Key with a description containing special characters:


http://api.cloudapplicenser.com/v1/license_credits_modify?token=54321&appuniqueid=12345&licensekey=99999&action=ADD&quantity=10&description=10+%22Bonus%22+Points+Awarded

Remove credits from a License Key:


http://api.cloudapplicenser.com/v1/license_credits_modify?token=54321&appuniqueid=12345&licensekey=99999&action=REMOVE&quantity=1&description=Points+Spent+on+In-App+Upgrade

Error Codes
403 Status: 001 - The App's Unique ID or Security Token is missing.
403 Status: 002 - The App's Unique ID or Security Token supplied is invalid, or the App is suspended.
400 Status: 003 - The License Key is missing.
400 Status: 005 - The License Key supplied is invalid or does not apply to the App's Unique ID.
400 Status: 007 - The License Key supplied is suspended.
400 Status: 011 - The Action supplied is not a valid value.
400 Status: 012 - The Quantity supplied is not a positive whole number.
400 Status: 013 - The Description supplied is not of valid length.
400 Status: 009 - The Reference supplied is not of valid length.
400 Status: 014 - Either the Quantity supplied is larger than the permitted number of total credits or the permitted number of credits per transaction.
400 Status: 015 - The License Key supplied does not have enough credits to remove the Quantity supplied.
Changelog
- 1.0: Introduced.

Want news and insights from SiteCenter?

Send me your newsletter about industry trends plus news of SiteCenter products and services.

You can unsubscribe at any time, and we promise to never share your email address - read our Privacy Policy.