> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Intercom: List Subscription Types

> List the subscription types, such as email newsletters, in an Intercom workspace. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List the subscription types, such as email newsletters, in an Intercom workspace.

> [!NOTE]
>
> Tool ID: `intercom_list_subscription_types`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_list_subscription_types',
  {},
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_list_subscription_types --input '{}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "type": "list",
    "data": [
      {
        "type": "example",
        "id": "id_123",
        "state": "live"
      }
    ]
  }
}
```

Use `deepline describe intercom_list_subscription_types --json` for the latest machine-readable contract.

## Input reference

You can list all subscription types. A list of subscription type objects will be returned.

This action requires no input fields.

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "You can list all subscription types. A list of subscription type objects will be returned.",
    "properties": {},
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | A list of subscription type objects. |
| `result.data.type` | `"list"` | No | — | The type of the object Allowed: `list`. |
| `result.data.data` | `array` | No | — | A list of subscription type objects associated with the workspace . |
| `result.data.data[].type` | `string` | No | — | The type of the object - subscription |
| `result.data.data[].id` | `string` | No | — | The unique identifier representing the subscription type. |
| `result.data.data[].state` | `"live" \| "draft" \| "archived"` | No | — | The state of the subscription type. Allowed: `live`, `draft`, `archived`. |
| `result.data.data[].default_translation` | `object` | No | — | A translation object contains the localised details of a subscription type. |
| `result.data.data[].default_translation.name` | `string` | No | — | The localised name of the subscription type. |
| `result.data.data[].default_translation.description` | `string` | No | — | The localised description of the subscription type. |
| `result.data.data[].default_translation.locale` | `string` | No | — | The two character identifier for the language of the translation object. |
| `result.data.data[].translations` | `array` | No | — | An array of translations objects with the localised version of the subscription type in each available locale within your translation settings. |
| `result.data.data[].translations[].name` | `string` | No | — | The localised name of the subscription type. |
| `result.data.data[].translations[].description` | `string` | No | — | The localised description of the subscription type. |
| `result.data.data[].translations[].locale` | `string` | No | — | The two character identifier for the language of the translation object. |
| `result.data.data[].consent_type` | `"opt_out" \| "opt_in"` | No | — | Describes the type of consent. Allowed: `opt_out`, `opt_in`. |
| `result.data.data[].content_types` | `array` | No | — | The message types that this subscription supports - can contain `email` or `sms_message`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "A list of subscription type objects.",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of the object",
            "enum": [
              "list"
            ]
          },
          "data": {
            "type": "array",
            "description": "A list of subscription type objects associated with the workspace .",
            "items": {
              "type": "object",
              "description": "A subscription type lets customers easily opt out of non-essential communications without missing what's important to them.",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "The type of the object - subscription"
                },
                "id": {
                  "type": "string",
                  "description": "The unique identifier representing the subscription type."
                },
                "state": {
                  "type": "string",
                  "description": "The state of the subscription type.",
                  "enum": [
                    "live",
                    "draft",
                    "archived"
                  ]
                },
                "default_translation": {
                  "type": "object",
                  "description": "A translation object contains the localised details of a subscription type.",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "The localised name of the subscription type."
                    },
                    "description": {
                      "type": "string",
                      "description": "The localised description of the subscription type."
                    },
                    "locale": {
                      "type": "string",
                      "description": "The two character identifier for the language of the translation object."
                    }
                  },
                  "additionalProperties": false
                },
                "translations": {
                  "type": "array",
                  "description": "An array of translations objects with the localised version of the subscription type in each available locale within your translation settings.",
                  "items": {
                    "type": "object",
                    "description": "A translation object contains the localised details of a subscription type.",
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "The localised name of the subscription type."
                      },
                      "description": {
                        "type": "string",
                        "description": "The localised description of the subscription type."
                      },
                      "locale": {
                        "type": "string",
                        "description": "The two character identifier for the language of the translation object."
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "consent_type": {
                  "type": "string",
                  "description": "Describes the type of consent.",
                  "enum": [
                    "opt_out",
                    "opt_in"
                  ]
                },
                "content_types": {
                  "type": "array",
                  "description": "The message types that this subscription supports - can contain `email` or `sms_message`.",
                  "items": {
                    "type": "string",
                    "enum": [
                      "email",
                      "sms_message"
                    ]
                  }
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Intercom provider guide](https://deepline.com/docs/providers/intercom/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.