Retrieve Subscriptions

API Documentation

Retrieve Subscriptions

The Schedule Marketing Subscriptions List API provides a paginated list of marketing subscriptions, including details such as name, modality, pricing, center, and more.

Endpoint:

Get /
/api/v1/marketing/subscriptions

Request Parameters

Header Json (Required)

Response

SubscriptionId Int(Not Nullable)

Unique identifier for the scheduled subscription.

Name String(Not Nullable)

Name of the subscription.

Modality Int(Not Nullable)

Unique identifier for the course modality

Modality Int(Nullable)

Modality Type

PricingId Int(Nullable)

Unique identifier for the price 

Pricing Int(Nullable)

Pricing plan for the subscription

CenterId Int(Not Nullable)

Unique identifier for the center

Center String(Not Nullable)

Center associated with the subscription.

CenterSiteID Int(Not Nullable)

SiteID of the center associated with the subscription

centerSiteCode String(Nullable)

CenterSiteCode of the center associated with the subscription

allCourses Boolean(Nullable)

Indicates if the subscription covers all courses.

AllClubs Boolean(Not Nullable)

Indicates if the subscription covers all clubs.

supplementalSubscription Boolean(Not Nullable)

Indicates if the subscription includes supplemental materials.

includeChildren Boolean(Not Nullable)

Indicates if the subscription includes child centers

Created String(Not Nullable)

Date when the subscription was created (format: YYYY-MM-DD).

lastModified String(Not Nullable)

Date when the subscription was last modified (format: YYYY-MM-DD).

				
					{
  "success": true,
  "message": "Data retrieved successfully.",
  "data": {
    "totalPages": 1,
    "currentPage": 1,
    "subscriptions": [
      {
        "subscriptionId": 3521,
        "name": "Nicosia courses",
        "modalityId": 3,
        "modality": "Online LIVE",
        "pricingId": 0,
        "pricing": "Local prices only",
        "centerId": 1404,
        "center": "Nicosia",
        "centerSiteId": 7934,
        "centerSiteCode": "NCO",
        "allCourses": true,
        "allClubs": false,
        "supplementalSubscription": false,
        "includeChildren": true,
        "created": "2020-10-15",
        "lastModified": "2023-12-07"
      },
      {
        "subscriptionId": 3522,
        "name": "VDP EMEA ",
        "modalityId": 3,
        "modality": "Online LIVE",
        "pricingId": 0,
        "pricing": "Local prices only",
        "centerId": 1404,
        "center": "Nicosia",
        "centerSiteId": 7934,
        "centerSiteCode": "NCO",
        "allCourses": false,
        "allClubs": false,
        "supplementalSubscription": false,
        "includeChildren": true,
        "created": "2020-10-16",
        "lastModified": "2024-08-21"
      },
      {
        "subscriptionId": 4899,
        "name": "Nexus Human Reseller Program",
        "modalityId": 3,
        "modality": "Online LIVE",
        "pricingId": 0,
        "pricing": "Local prices only",
        "centerId": 1404,
        "center": "Nicosia",
        "centerSiteId": 7934,
        "centerSiteCode": "NCO",
        "allCourses": false,
        "allClubs": false,
        "supplementalSubscription": false,
        "includeChildren": true,
        "created": "2024-02-28",
        "lastModified": "2024-08-22"
      }
    ]
  }
}