Rokt Documentation
  • Documentation
  • User Guide
  • SDK
  • API
  • Third-Party Integrations
  • Help

›Subscription

Getting Started

  • Introduction

Transactions

    Events

    • Overview
    • Authentication
    • POST Events

    Cart

    • Overview
    • POST Reserve Cart Items
    • POST Confirm Cart Items
    • POST Release Cart Items

    Confirmation

    • POST Cancel Confirmed Item

    Placements

    • POST Any Placements

Customer Data

  • Referral Export
  • Transaction Export
  • Custom Audience Import
  • Unsubscribe Import
  • Attributes

Reporting

  • Overview
  • Authentication
  • Account Level

    • GET Account Summary
    • GET Account Campaigns Overview
    • GET Account Campaigns Breakdown
    • GET Account Campaigns Histogram
    • GET Account Transactions Overview
    • GET Account Transactions Breakdown

    Campaign Level

    • GET Campaign Overview
    • GET Campaign Breakdown
    • GET Campaign Histogram

    Creative Level

    • GET Creative Overview
    • GET Creative Breakdown

    Metadata

    • GET Campaign Metadata
    • GET Audience Metadata
    • GET Creative Metadata
    • GET Accounts Metadata

Rokt Calendar

  • Overview
  • Authentication
  • Subscription

    • DELETE Subscription Event
    • DELETE Deactivate Subscriptions
    • GET Subscription Details

    Subscription Event

    • DELETE Delete Subscription Event
    • POST Create New Subscription Event
    • POST Update Subscription Event

    Calendar

    • GET Calendar Events

    Schedule

    • GET Subscription Schedule

    Subscribe

    • POST Create New Subscription
Edit

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

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

← DELETE Deactivate SubscriptionsDELETE Delete Subscription Event →
  • Request
  • Response
  • Error
RESOURCES
DocumentationUser GuideSDKAPIIntegration PartnersHelp
COMPANY
About UsContact UsCareersEngineering Blog
Rokt Documentation
Copyright © Rokt 2021 - All Rights Reserved