# SubscriptionGroup

A subscription group represents a collection of subscriptions.

<!-- theme: info -->
> #### 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](mailto:support@gigs.com) to share your thoughts.

## Properties

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `object` | string | Yes | Type of object is always `subscriptionGroup`. |
| `id` | string | Yes | Unique identifier for the subscription group. |
| `subscriptions` | string[] | Yes | List of subscription identifiers that belong to this group. |
| `type` | discountGroup | familyPlan | Yes | The type of the subscription group. The object with the same name holds the fields of that type. |
| `status` | active | draft | Yes | The status of the subscription group. |
| `discountGroup` | object,null | No | Fields of a group with the `discountGroup` type. Only present when `type` is `discountGroup`. |
| `familyPlan` | object,null | No | Fields of a group with the `familyPlan` type. Only present when `type` is `familyPlan`. |
| `activatedAt` | string,null | Yes | Time when the subscription group was activated. A discount group is activated when it is created. A family plan is activated through the activate subscription group endpoint. It is null while the family plan is a draft. |
| `createdAt` | string | Yes | Time when the subscription group was created. |
