Skip to main content
GET
Fetch a Specific Reason Code

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

reason_code
string
required

The id or the vid of the reason code to retrieve. A unique identifier. Optionally, this object can also be identified by its vid. Using a unique custom identifier is strongly encouraged.

Maximum string length: 128

Response

JSON A full Reason Code object.

object
enum<string>

Value is “ReasonCode”

Available options:
ReasonCode
reason_type
string

Constant Field – Values: Cancel, pause

reason_code
string

The reason code. Usually a numeric value. Can be 15 characters or fewer. Note: Codes 0 - 100 are reserved for Subscribe or fewer.

description
string

A description of the reason for the cancellation. Can be up to 255 characters long.