Products & Licenses
Every call on this page needs an access token. To get one, see Authentication & Access.
Products
Create a Product
Creating a new product (add-on) uses the POST method. This call creates a new product entry in the Ecosystem that you can then use for licensing.
Authorization: Bearer {userID} {username} {currentToken}
Request Body Parameters
Example Request Body
Responses
HTTP 200: Product created
HTTP 400: Validation error
If your account doesn’t have vendor access, the call is denied with HTTP 403.
Code Samples
List Your Products
Getting the list of products (add-ons) you’ve created uses the GET method. This call returns the product ID of each product associated with your vendor account.
Authorization: Bearer {userID} {username} {currentToken}
Responses
HTTP 200: List of products
HTTP 401: Unauthorized
Code Samples
Licenses
Create a License
Adding a new license for a user uses the POST method. This call licenses a specific user (by email) to access one or more of your products.
Authorization: Bearer {userID} {username} {currentToken}
Request Body Parameters
Example Request Body
Responses
HTTP 200: License created (one license ID for each product)
HTTP 409: Duplicate license
If you don’t own every product in productIds, the call is denied with HTTP 403. If any check fails, no licenses are created.
Code Samples
List Licenses by Product
To get all licenses for a specific product, call List All Your Licenses and read that product’s entry in result, which is keyed by product ID. The entry’s licenses array lists every license for the product, including expired ones, with each license’s email and expiration date. A license is active when its expirationDateUTC is null or in the future. If you don’t own the product, it isn’t in result, and the samples print nothing.
Code Samples
List All Your Licenses
Get every license for every product you own, grouped by product.
Authorization: Bearer {userID} {username} {currentToken}
The response’s result object has one entry per product you own, keyed by product ID. Each entry has the productId, the productName, and a licenses array. Each license has an id (the licenseId used to update it), the productId, the email it’s licensed to, its expirationDateUTC (null for a lifetime license), and an optional name label.
- Expired licenses are included, so check each license’s
expirationDateUTC. - A product with no licenses has an empty
licensesarray, and if you don’t own any products,resultis empty. - If your account doesn’t have vendor access, the call returns
HTTP 403.
Responses
HTTP 200: Licenses grouped by product
Code Samples
List Licenses by User
To get all licenses assigned to a specific user, call List All Your Licenses and keep the licenses whose email matches the user’s email address. Emails are saved in lowercase with any spaces at either end removed, so trim and lowercase both addresses before you compare them.
Code Samples
Update a License
Update an existing license for a user. Use this call to change the expiration date of a user’s license (for example, to extend a subscription, convert a trial to a paid license, or revoke access by setting an expiration in the past). Set expirationDateUTC to null for a lifetime license.
Authorization: Bearer {userID} {username} {currentToken}
Wrap the Update a License request body in a product object, not the license object used by Create a License: { "product": { ... } }.
To change an expiration date, set expirationDateUTC to a future UTC date string to extend access, to null to grant a lifetime license with no expiration, or to the current date to expire the license immediately. For example, if today is May 26, 2026, setting it to "2026-05-26T00:00:00Z" expires the license immediately. The user loses access on their next license check.
Finding Your License ID
Before you can update a license, you need its licenseId. Call List All Your Licenses and find the license in its product’s licenses array; the id field is the licenseId you need. If you know the user’s email, match it against each license’s email (see List Licenses by User).
In this example, the id value 99201 is your licenseId.
Path Parameters
Request Body Parameters
Example Request Bodies
Expire a license immediately. Set expirationDateUTC to today’s date.
Extend a license expiration. Set expirationDateUTC to a future date to grant continued access.
Grant a lifetime license. Set expirationDateUTC to null to remove any expiration.
Responses
HTTP 200: License updated
HTTP 404: License not found
If the license belongs to a product you don’t own, the call is denied with HTTP 403.