Intercom: List Subscription Types

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

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.

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

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.

{
  "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.

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).

Deepline cost

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

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation