Add-ons
ATUM
JSON response example
The add-ons API allows you to view the installed ATUM add-ons and their licenses.
Add-on properties
| Attribute | Type | Description |
|---|---|---|
name | string | The add-on name (in lowercase, as it's stored with the license). read-only |
key | string | The license key for the purchased add-on. read-only |
status | string | The license key status. Possible values include valid, invalid, expired, disabled and trial_used. read-only |
expires | string | The license expiration date, when known (e.g. 2027-05-12 23:59:59 or lifetime). read-only |
trial | boolean | Whether the license belongs to a trial version of the add-on. Only present for trials. read-only |
extended | boolean | Whether the trial license has already been extended. Only present for extended trials. read-only |
List all add-ons
This API helps you to view all the add-ons with a registered license key.
HTTP request
GET
/wp-json/wc/v3/atum/addonscurl https://example.com/wp-json/wc/v3/atum/addons \
-u consumer_key:consumer_secret[
{
"name": "product levels",
"key": "XXXXXX",
"status": "valid",
"expires": "2027-05-12 23:59:59"
},
{
"name": "stock takes",
"key": "",
"status": "invalid"
},
{
"name": "stock logs",
"key": "",
"status": "invalid"
},
{
"name": "dashboard statistics pro",
"key": "",
"status": "invalid"
},
{
"name": "user restrictions",
"key": "",
"status": "invalid"
},
{
"name": "data export",
"key": "",
"status": "invalid"
},
{
"name": "multi-inventory",
"key": "XXXXXX",
"status": "valid",
"expires": "lifetime"
},
{
"name": "export pro",
"key": "",
"status": "invalid"
}
]Available parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Get only the add-on with the specified name (case-insensitive). When it's found, the response is a single add-on object instead of an array. If there is no key for that add-on, the response is an empty array. |
The add-ons endpoint requires the manage_woocommerce capability (the same as the WooCommerce settings endpoints).