Subscriptions are special shop offers (coming in GET /shopoffers response) that have the value "Subscription" in the parameter "Type". They are purchased the first time (see Shop section to know how to purchase), a reward is given and it is automatically renewed after a month, charging the user with new payment and giving the reward again.
The API provides a couple of methods to deal with Subscriptions:
- GET /subscription-identifiers: gives a list of identifiers that are associated with the subscription (ie: they can be car plate numbers for car wash subscription).
- PUT /subscription/restart: it allows to restart of a subscription by the user once it has been cancelled.
Multi-User Subscriptions
Multi-User Subscriptions are a kind of subscription that can be used by several users. The way to distinguish this type of subscription is through parameter IsMultiUserPlan of Subscriptions array in GET /user response once the subscription has been purchased. Note that the subscription object that contains this parameter is only present for the owner of the subscription.
- Subscription Users can be added by subscription owner using POST /subscriptions/{SubscriptionId}/users method (up to indicated number on
MaxUsersAmountparameter ofSubscriptionsarray in GET /user response). - Subscription Users can be consulted using GET /subscriptions/{SubscriptionId}/users method.
- Subscription Users can be deleted using DELETE /subscriptions/{SubscriptionId}/users/{Id} method.