Edit

GET Subscription Details

Use the API to programmatically Get Subscription Details.

Request

Path

GET /v1/subscription/{subscriptionId}

Parameters

Name	Type	In	Description	Required	Example
subscriptionId	String	path	This is the subscriptionId returned from the Create New subscription API function.	true

Response

200 OK

Example Value

Schema

{
  "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": "2021-02-24T21:38:05.407Z",
  "isActive": true,
  "deactivatedDate": "2021-02-24T21:38:05.407Z",
  "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": "2021-02-24T21:38:05.407Z",
      "startDateTimeUtc": "2021-02-24T21:38:05.407Z",
      "endDateTime": "2021-02-24T21:38:05.407Z",
      "allDayEvent": true,
      "reminderMinutes": null,
      "merchantId": "string",
      "accountId": "string",
      "eventOccurrenceType": 0,
      "isSubscriptionEvent": true,
      "recurrenceFrequency": null,
      "recurrenceUntilDateTime": "2021-02-24T21:38:05.407Z",
      "recurrenceUntilCount": null,
      "recurrenceInterval": null,
      "recurrenceWeeklyDays": null,
      "recurrenceMonthlyDayOfWeek": true
    }
  ],
  "eventReminderMinutes": null,
  "allowPromotionalContent": true,
  "additionalOptIn": true,
  "isEventReminderDisabled": true
}

Object {

subscriptionId: String

calendar: Object {

id: String

code: String

name: String

image: String

}

tags: Array [

Object {

id: String

name: String

}

]

timezoneId: String

subscriptionType: String

subscriberId: String

emailAddress: String

marketingAllowed: Boolean

providerName: String

channelFinderLineUpId: String

channelFinderZipCode: String

createdAt: Date

isActive: Boolean

deactivatedDate: Date

events: Array [

Object {

id: String

name: String

externalId: String

isExcluded: Boolean

}

]

eventsVisibleToSubscription: Array [

Object {

title: String

location: String

description: String

subscriptionEventId: String

calendarEventId: String

timezone: String

timezoneIanaId: String

startDateTime: Date

startDateTimeUtc: Date

endDateTime: Date

allDayEvent: Boolean

reminderMinutes: Enum

merchantId: String

accountId: String

eventOccurrenceType: Enum

isSubscriptionEvent: Boolean

recurrenceFrequency: Enum

recurrenceUntilDateTime: Date

recurrenceUntilCount: Enum

recurrenceInterval: Enum

recurrenceWeeklyDays: Enum

recurrenceMonthlyDayOfWeek: Boolean

}

]

eventReminderMinutes: Enum

allowPromotionalContent: Boolean

additionalOptIn: Boolean

isEventReminderDisabled: Boolean

}

Error

400 BadRequest