import Stigg from '@stigg/typescript';
const client = new Stigg({
apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});
const response = await client.v1.events.addons.retrieveAddon('x');
console.log(response.data);{
"data": {
"id": "addon-extra-seats",
"displayName": "Extra Seats",
"description": "Additional team member seats",
"productId": "product-starter",
"status": "PUBLISHED",
"pricingType": "PAID",
"billingId": "price_1234567890",
"versionNumber": 1,
"isLatest": true,
"entitlements": [
{
"type": "FEATURE",
"id": "feature-advanced-analytics"
},
{
"type": "CREDIT",
"id": "api-calls"
}
],
"metadata": {},
"createdAt": "2026-12-25T16:19:04.237Z",
"updatedAt": "2026-04-04T18:40:30.337Z",
"maxQuantity": 100,
"dependencies": [
"addon-premium-support"
]
}
}Retrieves an addon by its unique identifier, including entitlements and pricing details.
import Stigg from '@stigg/typescript';
const client = new Stigg({
apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});
const response = await client.v1.events.addons.retrieveAddon('x');
console.log(response.data);{
"data": {
"id": "addon-extra-seats",
"displayName": "Extra Seats",
"description": "Additional team member seats",
"productId": "product-starter",
"status": "PUBLISHED",
"pricingType": "PAID",
"billingId": "price_1234567890",
"versionNumber": 1,
"isLatest": true,
"entitlements": [
{
"type": "FEATURE",
"id": "feature-advanced-analytics"
},
{
"type": "CREDIT",
"id": "api-calls"
}
],
"metadata": {},
"createdAt": "2026-12-25T16:19:04.237Z",
"updatedAt": "2026-04-04T18:40:30.337Z",
"maxQuantity": 100,
"dependencies": [
"addon-premium-support"
]
}
}Server API Key
Server API Key
The unique identifier of the entity
1 - 255The addon object with full details.
Response object
Addon configuration object
Show child attributes