Skip to main content

getAllSubscriptions

This method return all subscriptions to products. 🔐 This method requires .

Description​

It returns a Promise that resolves to an ISubscriptions object.

Events.getAllSubscriptions(

offset, limit

);

Parameters schema​

Schema

offset: number
Pagination parameter, default is 0
example: 0

limit: number
Pagination parameter, default is 30
example: 30

Examples​

Minimal example​

const response = await Events.getAllSubscriptions();

Example with attributes​

const response = await Events.getAllSubscriptions(0, 30);

Example response​

{
  "total": 100,
  "items": [
    {
      "eventMarker": "string",
      "productId": 0
    }
  ]
}

Response schema​

Schema: ISubscriptions

total: number
Total number of records found

eventMarker: string
Event marker

productId number
Product identifier