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
type
Type
string
Description
The type of the subscription group. The object with the same name holds the fields of that type.
Example: "familyPlan"
Allowed values: discountGroup familyPlan
Name
status
Type
string
Description
The status of the subscription group.
Example: "active"
Allowed values: active draft
Name
discountGroup
Type
nullable object
Description
Fields of a group with the discountGroup type. Only present when type is discountGroup.
Optional: This property may not always be included.
Name
familyPlan
Type
nullable object
Description
Fields of a group with the familyPlan type. Only present when type is familyPlan.
Optional: This property may not always be included.
Name
primarySubscription
Type
nullable string
Description
The subscription that receives the consent requests for the other subscriptions in the group. Cannot be changed once the group is active.
Example: "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
Name
plan
Type
string
Description
The plan that every subscription in the family plan must be on. Cannot be changed after creation.
Example: "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
Name
createdAt
Type
string
Description
Time when the subscription group was created.
Example: "2021-01-21T19:32:13Z"

SubscriptionGroup object

{
  "object": "subscriptionGroup",
  "id": "sgr_0SNlurA049MEWV26leJMWPp4o23C",
  "subscriptions": [
    "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
  ],
  "type": "familyPlan",
  "status": "active",
  "discountGroup": {},
  "familyPlan": {
    "primarySubscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
    "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
  },
  "createdAt": "2021-01-21T19:32:13.0Z"
}