AvailableAddOns Resource
Migrate from Preview to v1
Marketplace v1 API is now available, and the Preview API for this Resource will be discontinued in December 2024. See the API Preview to v1 Migration Guide
for more information.
The AvailableAddOns resource provides detailed descriptions of the Add-on Listings currently available to be installed by an Account.
The AvailableAddOns resource allows you to read a list of all available Add-on Listings or to fetch a specific Add-on Listing's detailed description.
Info
This API only supports Add-on Listings that are in General Availability (GA) or Beta state. Listings that are labeled as Coming Soon or Developer Preview are not accessible via the API and must be managed in the Console.
Property nameTypeRequiredDescriptionChild properties
The unique string that we created to identify the AvailableAddOn resource.
Pattern: ^XB[0-9a-fA-F]{32}$Min length: 34Max length: 34
friendly_namestringOptional The string that you assigned to describe the resource.
descriptionstringOptional A short description of the Add-on's functionality.
pricing_typestringOptional How customers are charged for using this Add-on.
configuration_schemaobjectOptional The JSON object with the configuration that must be provided when installing a given Add-on.
The absolute URL of the resource.
linksobject<uri-map>Optional The URLs of related resources.
GET https://marketplace.twilio.com/v1/AvailableAddOns/{Sid}
Property nameTypeRequiredPIIDescription
The SID of the AvailableAddOn resource to fetch.
Pattern: ^XB[0-9a-fA-F]{32}$Min length: 34Max length: 34
_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18async function fetchAvailableAddOn() {
_18 const availableAddOn = await client.marketplace.v1
_18 .availableAddOns("XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18 console.log(availableAddOn.sid);
_18fetchAvailableAddOn();
_21 "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_21 "friendly_name": "VoiceBase High Accuracy Transcription",
_21 "description": "Automatic Transcription and Keyword Extract...",
_21 "pricing_type": "per minute",
_21 "configuration_schema": {
_21 "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_21 "extensions": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions"
GET https://marketplace.twilio.com/v1/AvailableAddOns
Property nameTypeRequiredPIIDescription
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Minimum: 1Maximum: 1000
The page index. This value is simply for client state.
Minimum: 0
The page token. This is provided by the API.
_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18async function listAvailableAddOn() {
_18 const availableAddOns = await client.marketplace.v1.availableAddOns.list({
_18 availableAddOns.forEach((a) => console.log(a.sid));
_34 "available_add_ons": [
_34 "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_34 "friendly_name": "VoiceBase High Accuracy Transcription",
_34 "description": "Automatic Transcription and Keyword Extract...",
_34 "pricing_type": "per minute",
_34 "configuration_schema": {
_34 "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_34 "extensions": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions"
_34 "first_page_url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0",
_34 "previous_page_url": null,
_34 "url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0",
_34 "next_page_url": null,
_34 "key": "available_add_ons"