# AvailableAddOns Resource

> \[!WARNING]
>
> The Preview API for this resource is deprecated. To migrate from Preview to V1, refer to the Marketplace API migration guide for [users](/docs/marketplace/listings/api-migration-users) or [publishers](/docs/marketplace/publishers/api-migration-publishers).

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.

> \[!NOTE]
>
> 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.

## AvailableAddOn Properties

```json
{"type":"object","refName":"marketplace.v1.available_add_on","modelName":"marketplace_v1_available_add_on","properties":{"sid":{"type":"string","minLength":34,"maxLength":34,"pattern":"^XB[0-9a-fA-F]{32}$","nullable":true,"description":"The unique string that we created to identify the AvailableAddOn resource."},"friendly_name":{"type":"string","nullable":true,"description":"The string that you assigned to describe the resource."},"description":{"type":"string","nullable":true,"description":"A short description of the Add-on's functionality."},"pricing_type":{"type":"string","nullable":true,"description":"How customers are charged for using this Add-on."},"configuration_schema":{"nullable":true,"type":"object","description":"The JSON object with the configuration that must be provided when installing a given Add-on."},"url":{"type":"string","format":"uri","nullable":true,"description":"The absolute URL of the resource."},"links":{"type":"object","format":"uri-map","nullable":true,"description":"The URLs of related resources."}}}
```

## Fetch a single AvailableAddOn resource by SID

`GET https://marketplace.twilio.com/v1/AvailableAddOns/{Sid}`

### Path parameters

```json
[{"name":"Sid","in":"path","description":"The SID of the AvailableAddOn resource to fetch.","schema":{"type":"string","minLength":34,"maxLength":34,"pattern":"^XB[0-9a-fA-F]{32}$"},"required":true}]
```

Fetch a single AvailableAddOn

```js
// Download the helper library from https://www.twilio.com/docs/node/install
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
const accountSid = process.env.TWILIO_ACCOUNT_SID;
const authToken = process.env.TWILIO_AUTH_TOKEN;
const client = twilio(accountSid, authToken);

async function fetchAvailableAddOn() {
  const availableAddOn = await client.marketplace.v1
    .availableAddOns("XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
    .fetch();

  console.log(availableAddOn.sid);
}

fetchAvailableAddOn();
```

```python
# Download the helper library from https://www.twilio.com/docs/python/install
import os
from twilio.rest import Client

# Find your Account SID and Auth Token at twilio.com/console
# and set the environment variables. See http://twil.io/secure
account_sid = os.environ["TWILIO_ACCOUNT_SID"]
auth_token = os.environ["TWILIO_AUTH_TOKEN"]
client = Client(account_sid, auth_token)

available_add_on = client.marketplace.v1.available_add_ons(
    "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
).fetch()

print(available_add_on.sid)
```

```csharp
// Install the C# / .NET helper library from twilio.com/docs/csharp/install

using System;
using Twilio;
using Twilio.Rest.Marketplace.V1;
using System.Threading.Tasks;

class Program {
    public static async Task Main(string[] args) {
        // Find your Account SID and Auth Token at twilio.com/console
        // and set the environment variables. See http://twil.io/secure
        string accountSid = Environment.GetEnvironmentVariable("TWILIO_ACCOUNT_SID");
        string authToken = Environment.GetEnvironmentVariable("TWILIO_AUTH_TOKEN");

        TwilioClient.Init(accountSid, authToken);

        var availableAddOn =
            await AvailableAddOnResource.FetchAsync(pathSid: "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");

        Console.WriteLine(availableAddOn.Sid);
    }
}
```

```java
// Install the Java helper library from twilio.com/docs/java/install

import com.twilio.Twilio;
import com.twilio.rest.marketplace.v1.AvailableAddOn;

public class Example {
    // Find your Account SID and Auth Token at twilio.com/console
    // and set the environment variables. See http://twil.io/secure
    public static final String ACCOUNT_SID = System.getenv("TWILIO_ACCOUNT_SID");
    public static final String AUTH_TOKEN = System.getenv("TWILIO_AUTH_TOKEN");

    public static void main(String[] args) {
        Twilio.init(ACCOUNT_SID, AUTH_TOKEN);
        AvailableAddOn availableAddOn = AvailableAddOn.fetcher("XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa").fetch();

        System.out.println(availableAddOn.getSid());
    }
}
```

```go
// Download the helper library from https://www.twilio.com/docs/go/install
package main

import (
	"fmt"
	"github.com/twilio/twilio-go"
	"os"
)

func main() {
	// Find your Account SID and Auth Token at twilio.com/console
	// and set the environment variables. See http://twil.io/secure
	// Make sure TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN exists in your environment
	client := twilio.NewRestClient()

	resp, err := client.MarketplaceV1.FetchAvailableAddOn("XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
	if err != nil {
		fmt.Println(err.Error())
		os.Exit(1)
	} else {
		if resp.Sid != nil {
			fmt.Println(*resp.Sid)
		} else {
			fmt.Println(resp.Sid)
		}
	}
}
```

```php
<?php

// Update the path below to your autoload.php,
// see https://getcomposer.org/doc/01-basic-usage.md
require_once "/path/to/vendor/autoload.php";

use Twilio\Rest\Client;

// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
$sid = getenv("TWILIO_ACCOUNT_SID");
$token = getenv("TWILIO_AUTH_TOKEN");
$twilio = new Client($sid, $token);

$available_add_on = $twilio->marketplace->v1
    ->availableAddOns("XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
    ->fetch();

print $available_add_on->sid;
```

```ruby
# Download the helper library from https://www.twilio.com/docs/ruby/install
require 'twilio-ruby'

# Find your Account SID and Auth Token at twilio.com/console
# and set the environment variables. See http://twil.io/secure
account_sid = ENV['TWILIO_ACCOUNT_SID']
auth_token = ENV['TWILIO_AUTH_TOKEN']
@client = Twilio::REST::Client.new(account_sid, auth_token)

available_add_on = @client
                   .marketplace
                   .v1
                   .available_add_ons('XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
                   .fetch

puts available_add_on.sid
```

```bash
# Install the twilio-cli from https://twil.io/cli

twilio api:marketplace:v1:available-add-ons:fetch \
   --sid XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
```

```bash
curl -X GET "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
```

```json
{
  "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "friendly_name": "VoiceBase High Accuracy Transcription",
  "description": "Automatic Transcription and Keyword Extract...",
  "pricing_type": "per minute",
  "configuration_schema": {
    "type": "object",
    "properties": {
      "bad_words": {
        "type": "boolean"
      }
    },
    "required": [
      "bad_words"
    ]
  },
  "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "extensions": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions"
  }
}
```

## List all AvailableAddOn resources

`GET https://marketplace.twilio.com/v1/AvailableAddOns`

### Query parameters

```json
[{"name":"PageSize","in":"query","description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"Page","in":"query","description":"The page index. This value is simply for client state.","schema":{"type":"integer","minimum":0}},{"name":"PageToken","in":"query","description":"The page token. This is provided by the API.","schema":{"type":"string"}}]
```

List all AvailableAddOn resources

```js
// Download the helper library from https://www.twilio.com/docs/node/install
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
const accountSid = process.env.TWILIO_ACCOUNT_SID;
const authToken = process.env.TWILIO_AUTH_TOKEN;
const client = twilio(accountSid, authToken);

async function listAvailableAddOn() {
  const availableAddOns = await client.marketplace.v1.availableAddOns.list({
    limit: 20,
  });

  availableAddOns.forEach((a) => console.log(a.sid));
}

listAvailableAddOn();
```

```python
# Download the helper library from https://www.twilio.com/docs/python/install
import os
from twilio.rest import Client

# Find your Account SID and Auth Token at twilio.com/console
# and set the environment variables. See http://twil.io/secure
account_sid = os.environ["TWILIO_ACCOUNT_SID"]
auth_token = os.environ["TWILIO_AUTH_TOKEN"]
client = Client(account_sid, auth_token)

available_add_ons = client.marketplace.v1.available_add_ons.list(limit=20)

for record in available_add_ons:
    print(record.sid)
```

```csharp
// Install the C# / .NET helper library from twilio.com/docs/csharp/install

using System;
using Twilio;
using Twilio.Rest.Marketplace.V1;
using System.Threading.Tasks;

class Program {
    public static async Task Main(string[] args) {
        // Find your Account SID and Auth Token at twilio.com/console
        // and set the environment variables. See http://twil.io/secure
        string accountSid = Environment.GetEnvironmentVariable("TWILIO_ACCOUNT_SID");
        string authToken = Environment.GetEnvironmentVariable("TWILIO_AUTH_TOKEN");

        TwilioClient.Init(accountSid, authToken);

        var availableAddOns = await AvailableAddOnResource.ReadAsync(limit: 20);

        foreach (var record in availableAddOns) {
            Console.WriteLine(record.Sid);
        }
    }
}
```

```java
// Install the Java helper library from twilio.com/docs/java/install

import com.twilio.Twilio;
import com.twilio.rest.marketplace.v1.AvailableAddOn;
import com.twilio.base.ResourceSet;

public class Example {
    // Find your Account SID and Auth Token at twilio.com/console
    // and set the environment variables. See http://twil.io/secure
    public static final String ACCOUNT_SID = System.getenv("TWILIO_ACCOUNT_SID");
    public static final String AUTH_TOKEN = System.getenv("TWILIO_AUTH_TOKEN");

    public static void main(String[] args) {
        Twilio.init(ACCOUNT_SID, AUTH_TOKEN);
        ResourceSet<AvailableAddOn> availableAddOns = AvailableAddOn.reader().limit(20).read();

        for (AvailableAddOn record : availableAddOns) {
            System.out.println(record.getSid());
        }
    }
}
```

```go
// Download the helper library from https://www.twilio.com/docs/go/install
package main

import (
	"fmt"
	"github.com/twilio/twilio-go"
	marketplace "github.com/twilio/twilio-go/rest/marketplace/v1"
	"os"
)

func main() {
	// Find your Account SID and Auth Token at twilio.com/console
	// and set the environment variables. See http://twil.io/secure
	// Make sure TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN exists in your environment
	client := twilio.NewRestClient()

	params := &marketplace.ListAvailableAddOnParams{}
	params.SetLimit(20)

	resp, err := client.MarketplaceV1.ListAvailableAddOn(params)
	if err != nil {
		fmt.Println(err.Error())
		os.Exit(1)
	} else {
		for record := range resp {
			if resp[record].Sid != nil {
				fmt.Println(*resp[record].Sid)
			} else {
				fmt.Println(resp[record].Sid)
			}
		}
	}
}
```

```php
<?php

// Update the path below to your autoload.php,
// see https://getcomposer.org/doc/01-basic-usage.md
require_once "/path/to/vendor/autoload.php";

use Twilio\Rest\Client;

// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
$sid = getenv("TWILIO_ACCOUNT_SID");
$token = getenv("TWILIO_AUTH_TOKEN");
$twilio = new Client($sid, $token);

$availableAddOns = $twilio->marketplace->v1->availableAddOns->read(20);

foreach ($availableAddOns as $record) {
    print $record->sid;
}
```

```ruby
# Download the helper library from https://www.twilio.com/docs/ruby/install
require 'twilio-ruby'

# Find your Account SID and Auth Token at twilio.com/console
# and set the environment variables. See http://twil.io/secure
account_sid = ENV['TWILIO_ACCOUNT_SID']
auth_token = ENV['TWILIO_AUTH_TOKEN']
@client = Twilio::REST::Client.new(account_sid, auth_token)

available_add_ons = @client
                    .marketplace
                    .v1
                    .available_add_ons
                    .list(limit: 20)

available_add_ons.each do |record|
   puts record.sid
end
```

```bash
# Install the twilio-cli from https://twil.io/cli

twilio api:marketplace:v1:available-add-ons:list
```

```bash
curl -X GET "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=20" \
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
```

```json
{
  "available_add_ons": [
    {
      "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "friendly_name": "VoiceBase High Accuracy Transcription",
      "description": "Automatic Transcription and Keyword Extract...",
      "pricing_type": "per minute",
      "configuration_schema": {
        "type": "object",
        "properties": {
          "bad_words": {
            "type": "boolean"
          }
        },
        "required": [
          "bad_words"
        ]
      },
      "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "links": {
        "extensions": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions"
      }
    }
  ],
  "meta": {
    "page": 0,
    "page_size": 50,
    "first_page_url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0",
    "previous_page_url": null,
    "url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0",
    "next_page_url": null,
    "key": "available_add_ons"
  }
}
```