Retrieve a subscription type

Request

You can fetch the details of a single subscription type by making a GET request to https://api.intercom.io/subscription_types/<id>.

Security

bearerAuth

Path

idstringrequired

The unique identifier for the subscription type.

Example:123

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:Preview

curl -i -X GET \
  https://api.intercom.io/subscription_types/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Preview'

Responses

Successful

Bodyapplication/json

typestring

The type of the object - subscription

Example:"subscription"

idstring

The unique identifier representing the subscription type.

Example:"123456"

statestring

The state of the subscription type.

Enum:"live""draft""archived"

Example:"live"

default_translationobject(Translation)

A translation object contains the localised details of a subscription type.

translationsArray of objects(Translation)

An array of translations objects with the localised version of the subscription type in each available locale within your translation settings.

consent_typestring

Describes the type of consent.

Enum:"opt_out""opt_in"

Example:"opt_in"

content_typesArray of strings

The message types that this subscription supports - can contain email or sms_message.

Items Enum:"email""sms_message"

Example:

[
  "email"
]

Response

{
  "type": "subscription",
  "id": "135",
  "state": "live",
  "consent_type": "opt_out",
  "default_translation": {
    "name": "Newsletters",
    "description": "Lorem ipsum dolor sit amet",
    "locale": "en"
  },
  "translations": [
    { … }
  ],
  "content_types": [
    "email"
  ]
}