Skip to main content

GET Subscription Details

Use the API to programmatically Get Subscription Details.

Request#

Path

GET /v1/subscription/{subscriptionId}

Parameters

NameTypeInDescriptionRequiredExample
subscriptionIdStringpathThis is the subscriptionId returned from the Create New subscription API function.true 

Response#

200 OK

{  "subscriptionId": "string",  "calendar": {    "id": "string",    "code": "string",    "name": "string",    "image": "string"  },  "tags": [    {      "id": "string",      "name": "string"    }  ],  "timezoneId": "string",  "subscriptionType": "string",  "subscriberId": "string",  "emailAddress": "string",  "marketingAllowed": true,  "providerName": "string",  "channelFinderLineUpId": "string",  "channelFinderZipCode": "string",  "createdAt": "2025-10-04T10:00:00.000Z",  "isActive": true,  "deactivatedDate": "2025-10-04T10:00:00.000Z",  "events": [    {      "id": "string",      "name": "string",      "externalId": "string",      "isExcluded": true    }  ],  "eventsVisibleToSubscription": [    {      "title": "string",      "location": "string",      "description": "string",      "subscriptionEventId": "string",      "calendarEventId": "string",      "timezone": "string",      "timezoneIanaId": "string",      "startDateTime": "2025-10-04T10:00:00.000Z",      "startDateTimeUtc": "2025-10-04T10:00:00.000Z",      "endDateTime": "2025-10-04T10:00:00.000Z",      "allDayEvent": true,      "reminderMinutes": null,      "merchantId": "string",      "accountId": "string",      "eventOccurrenceType": 0,      "isSubscriptionEvent": true,      "recurrenceFrequency": null,      "recurrenceUntilDateTime": "2025-10-04T10:00:00.000Z",      "recurrenceUntilCount": null,      "recurrenceInterval": null,      "recurrenceWeeklyDays": null,      "recurrenceMonthlyDayOfWeek": true    }  ],  "eventReminderMinutes": null,  "allowPromotionalContent": true,  "additionalOptIn": true,  "isEventReminderDisabled": true}

Error#

400 BadRequest

Was this article helpful?