# Subscription

Individual subscription. It's a unique combination of:
- Address,
- Subscription method,
- Hub.

Events created on a Hub Page depending on configuration will be sent
to subscriptions of that Hub.<br>
Subscription can be created for only a subset of Hub services which
will result in not receiving notifications about events affecting
services that were not selected.

In order to create or manage multiple subscriptions that should be
associated with the same person or entity, it's recommended to use
Subscriber and Subscriber Subscription endpoints.


## Create a Subscription

 - [POST /hubs/{subdomain}/subscriptions](https://api-docs.statushub.com/api-v3-openapi/subscription/createsubscription.md): Creates a new Subscription. Creates Subscriber record as well.
Besides regular validation - like address correctness - there are
a few additional constraints:
- Address has to be unique for current Hub,
- Single Subscriber can't have multiple subscriptions with same method name.
  For example it's not allowed for one Subscriber to have for example
  two email subscriptions.

## List Subscriptions

 - [GET /hubs/{subdomain}/subscriptions](https://api-docs.statushub.com/api-v3-openapi/subscription/listsubscriptions.md): Filters and returns Subscriptions with basic info for current Hub.

## Retrieve a Subscription

 - [GET /hubs/{subdomain}/subscriptions/{subscription_id}](https://api-docs.statushub.com/api-v3-openapi/subscription/getsubscription.md): Returns data about single Subscription.

## Update a Subscription

 - [PUT /hubs/{subdomain}/subscriptions/{subscription_id}](https://api-docs.statushub.com/api-v3-openapi/subscription/updatesubscription.md): Modifies existing Subscription. Only modified attributes may be passed in payload. All other attributes will remain unchanged.

## Delete a Subscription

 - [DELETE /hubs/{subdomain}/subscriptions/{subscription_id}](https://api-docs.statushub.com/api-v3-openapi/subscription/deletesubscription.md): Deletes Subscription record. Records are soft-deleted which means that such deleted record can still be viewed and potentially restored. If deleted Subscription is the last active subscription for Subscriber, Subscriber record is also deleted.

## Restore a Subscription

 - [PUT /hubs/{subdomain}/subscriptions/{subscription_id}/restore](https://api-docs.statushub.com/api-v3-openapi/subscription/restoresubscription.md): Restores deleted Subscription.
May fail if restoring would result in record
that is not valid for example because subscription with that address already
exists.
Restoring depending on data may either:
- Recreate the record as a new one with new ID,
- Undelete the record preserving it ID.