> ## 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: Detach Subscription Type To Contact

> Remove a subscription type from an Intercom contact. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Remove a subscription type from an Intercom contact.

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

## 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_detach_subscription_type_to_contact',
  {
    "contact_id": "contact_123",
    "subscription_id": "subscription_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_detach_subscription_type_to_contact --input '{
  "contact_id": "contact_123",
  "subscription_id": "subscription_123"
}' --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": "example",
    "id": "id_123",
    "state": "live"
  }
}
```

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

## Input reference

You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.contact_id` | `string` | Yes | — | The unique identifier for the contact which is given by Intercom |
| `payload.subscription_id` | `string` | Yes | — | The unique identifier for the subscription type which is given by Intercom |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.",
    "properties": {
      "contact_id": {
        "type": "string",
        "description": "The unique identifier for the contact which is given by Intercom"
      },
      "subscription_id": {
        "type": "string",
        "description": "The unique identifier for the subscription type which is given by Intercom"
      }
    },
    "required": [
      "contact_id",
      "subscription_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | A subscription type lets customers easily opt out of non-essential communications without missing what's important to them. |
| `result.data.type` | `string` | No | — | The type of the object - subscription |
| `result.data.id` | `string` | No | — | The unique identifier representing the subscription type. |
| `result.data.state` | `"live" \| "draft" \| "archived"` | No | — | The state of the subscription type. Allowed: `live`, `draft`, `archived`. |
| `result.data.default_translation` | `object` | No | — | A translation object contains the localised details of a subscription type. |
| `result.data.default_translation.name` | `string` | No | — | The localised name of the subscription type. |
| `result.data.default_translation.description` | `string` | No | — | The localised description of the subscription type. |
| `result.data.default_translation.locale` | `string` | No | — | The two character identifier for the language of the translation object. |
| `result.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.translations[].name` | `string` | No | — | The localised name of the subscription type. |
| `result.data.translations[].description` | `string` | No | — | The localised description of the subscription type. |
| `result.data.translations[].locale` | `string` | No | — | The two character identifier for the language of the translation object. |
| `result.data.consent_type` | `"opt_out" \| "opt_in"` | No | — | Describes the type of consent. Allowed: `opt_out`, `opt_in`. |
| `result.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 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
      },
      "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.