SubscriptionGroup

Preview

This schema is currently in preview and might change in the future.

We’re excited to hear your feedback and ideas. Please send an email to support@gigs.com to share your thoughts.

A subscription group represents a collection of subscriptions.

  • Name
    object
    Type
    string
    Description

    Type of object is always subscriptionGroup.

    Allowed values: subscriptionGroup 
  • Name
    id
    Type
    string
    Description

    Unique identifier for the subscription group.

    Example: "sgr_0SNlurA049MEWV26leJMWPp4o23C"
  • Name
    subscriptions
    Type
    array
    Description

    List of subscription identifiers that belong to this group.

  • Name
    createdAt
    Type
    string
    Description

    Time when the subscription group was created.

    Example: "2021-01-21T19:32:13Z"

Example

{
  "object": "subscriptionGroup",
  "id": "sgr_0SNlurA049MEWV26leJMWPp4o23C",
  "subscriptions": [
    "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
  ],
  "createdAt": "2021-01-21T19:32:13.0Z"
}