Get a list of your subscriptions to MailChannels Inbound

GET 
/subscriptions

Get a list of your subscriptions to MailChannels Inbound

Responses

200

Success, a list of subscriptions is returned

application/json

Schema

Schema

• Array [

handle stringrequired

A unique identifier for this subscription. This is used to refer to this subscriptoin in other API calls.

active booleanrequired

If true, this subscription is currently enabled.

plan

object

required

The plan associated with this subscription.

handle stringrequired

A unique identifier for this plan.

name stringrequired

A friendly name for this plan.

limits

undefined[]

required

A list of limits associated with this subscription. Limits are things like the maximum number of domains that can be provisioned against this subscription, or whether some features are enabled.

Array [

featureHandle stringrequired

value stringrequired

]

activeAccountsCount int64required

The number of domains currently provisioned against this subscription.

• ]

Example (from schema)

[
  {
    "handle": "string",
    "active": true,
    "plan": {
      "handle": "string",
      "name": "string"
    },
    "limits": [
      {
        "featureHandle": "string",
        "value": "string"
      }
    ],
    "activeAccountsCount": 0
  }
]

404

We could not find a customer that matched the customerHandle

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

500

Internal Server Error

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

Loading...