Subscription Administration
Learn how to manage your users’ subscriptions
The subscription overview feature provides a centralized hub for managing all subscriptions within Unidy. It allows you to search, view, edit, and delete subscriptions, ensuring streamlined workflows and quick access to essential information. Additionally, you can view the subscription history log in the history section.
Subscription overview
In the Subscription interface, you can view, edit, and delete all subscriptions stored in Unidy. You can search for subscriptions by entering the Subscription ID, title, or the users email address in the search bar. For a more detailed view on the respective subscription data, please click on the respective subscription ID. You can also directly access the editing mode or delete a subscription by clicking on the respective symbol on the right hand side. The user profile can be accessed by clicking on the email address.
Detailed subscription view
Relevant data fields and descriptions
Field | Description |
ID | Unique identifier of the subscription in Unidy. It is required to update or delete the subscription through external systems |
Created At | Timestamp of the subscription creation in Unidy |
Update At | Timestamp of the last subscription update in Unidy |
Starts At | Timestamp when the subscription started / got valid |
Ends At | Timestamp when the subscription expires |
Next Payment At | Timestamp when the next payment for the subscription is processed/required |
State | The status of the subscription:
- Active: subscription is valid
- Passive: subscription is valid (e.g. used by sports clubs for members, who are not active players)
- Inactive: subscription is invalid; Based on the Ends at timestamp, expired Subscriptions are set to invalid automatically |
Payment State | States whether a payment was processed successfully
- payed = payment processed successfully
- not payed = payment still not processed successfully |
Payment Frequency | Frequency of payments required for the subscriptions (daily, weekly, monthly, quarterly, six_monthly, yearly, onetime) |
Subscription Category | Category of the Subscription in Unidy |
Title | Name of the Subscription |
Reference | Reference for the external subscription provider |
Price | Recurring price of the subscription |
Description | Description of the subscription |
User | Connected user to the subscription |
Service | External services that are enabled to access the respective subscription information |
Wallet Export | Marks subscriptions that can be exported as wallet passes in Unidy |
Additional Information | Includes all additional subscription data that can not be stored in the standard unidy data fields |
Please note, that subscriptions created or changed in Unidy are not necessarily synced to the subscription management system. Please contact your CSM Team in case of any questions.
History
In the History section, you can view all activity logs for the selected subscription. Use the search bar in the top right corner to find specific logs. For a more optimized view, you can choose to hide entries with no changes (right corner). Clicking on the subscription's title (left corner) will direct you back to the user profile.
Relevant data fields and description
Field | Description |
Property | Subscription data field that was changed |
New Value | Current value of the data field |
Old Value | Value of the data field before the change |
Source | • Service: Change was made by a third party service
• API: Change was made by a third party API
• Admin: Change was made by the administrator |
Author | Party that made the change (if known) |
Update At | Date and time of the change |
How to Guides
The following chapter contains all relevant use cases, you need to know to work with subscriptions.
How to create a subscription
- Open the Subscriptions section in Unidy Admin.
- Click on the New button in the top right corner.
- Enter all the relevant information.
- Click on the Create Subscription button at the bottom of the page.
- The subscription is created in Unidy
How to edit a subscription
- Open the Subscriptions section in Unidy Admin.
- Search for the relevant subscription using the corresponding ID, title or user email address.
- Ensure that this is the subscription you want to edit.
- Click on the pen icon or open the subscription and click on the Edit button in the top right corner.
- Update the respective data fields in the subscription.
- Save changes by clicking on the Update Subscription button at the bottom of the page.
- The subscription is updated in Unidy.
How to delete a subscription
- Open the Subscriptions section in Unidy Admin.
- Search for the relevant subscription using the corresponding ID, title or user email address.
- Ensure that this is the subscription you want to delete.
- Click on the trash bin icon or open the subscription by clicking on the ID or title and click on the Destroy button in the top right corner.
- Confirm the deletion of the subscription.
- The subscription is deleted from Unidy.
Subscription Categories
This feature provides an overview of all available subscription categories. The administrator can access this area to modify or remove existing categories and create new ones. Subscription categories are used to group certain kind of subscriptions that belong together (i.e. different kind of memberships like gold, silver, bronze).
Not only can administrators create, update, and delete subscriptions (see … , but connected services can also perform these actions. Furthermore, connected services can receive notifications about new, updated, and deleted subscriptions.
Subscription categories overview
Here you can view, edit, and delete all subscription categories stored in Unidy. You can search for subscription category by entering the ID or title in the search bar. For a more detailed view on the respective subscription category data, please click on the subscription category ID. You can also directly access the editing mode or delete a subscription category by clicking on the respective symbol on the right hand side.
Subscription category information
Only admin-authorized users are allowed to create new subscription categories. By clicking on the New button in the upper right corner, the administrator will be directed to a page where they must provide certain information to create a new subscription category.
Required fields and description
Field | Description |
Title | Title of your subscription category. You are free to choose its phrasing. It should be considered that this item is visual to the user. |
Logo | The logo has to be in a square format (min. 60x60 px and max. 500x500 px), can not be bigger than 1 MB and has to be a PNG image. An app we can recommend to optimize your images is https://squoosh.app/. |
Background image (optional) | A background image is not required. If you choose to not upload one, it will be the background color of your ID. The background image has to be at least 400x100 px and the maximum image size can be 2000x500 px, the format has to be a JPEG and it can’t be bigger than 2 MB. An app we can recommend to optimize your images is https://squoosh.app/. |
Description | Description of your subscription category. You are free to choose its phrasing. It should be considered that these item is visual to the user. |
Currency | Subscriptions also have an attribute to define the currency of a price. This field is programmed according to the currency standard codes (ISO_4217). Here you can define a default currency for respective subscription category. UI displays the price with the correct symbol for the given currency. When currency in the single subscription is left blank, the default currency of the respective category is used instead.
Currency is stored with the subscription, so that service provider also see the correct currency associated to a price when fetching subscription information from Unidy. In that case, the currency will also be returned when someone fetches the subscription information through API. |
Show | It can sometimes be useful to prepare subscriptions in advance or to hide them if the subscription is unavailable for a short period of time. If enabled, this subscription category will be visible to the user as a tile with Call-to-Action (CTA) button (see below). |
Show subscriptions | You can choose whether the subscription should be shown to the user or not. If enabled, the respective subscriptions from this subscription category will be shown to the user. |
CTA-URL (Call-to-action) | User will be redirected to this URL (subscription or website) when clicking on the CTA button of the subscription category (see below). |
Visible for brand | Only applicable for multibrand instances. You can set up for which brand this subscription category should be visible. |
Visibility and hiding of subscriptions and subscription categories
Hiding subscription categories or individual subscriptions can be useful when their primary purpose is background synchronization between systems rather than user-facing functionality. By default, all subscriptions are visible in the user interface, but you have two options for concealing them:
- Configure a subscription category to hide all associated subscriptions.
- Enable the setting to hide inactive subscriptions, displaying only active subscriptions (default behavior includes active, inactive, and passive subscriptions).
Additionally, entire subscription categories can be hidden if needed, providing flexibility in managing what is shown to users.
If no subscriptions and no subscription categories are displayed for a customer, then the menu link for subscriptions won’t be displayed at all.
How to Guides
The following chapter contains all relevant use cases, you need to know to work with subscription categories.
How to create a subscription category
- Open the Subscription categories section in Unidy Admin Settings.
- Click on the New button in the top right corner.
- Enter all the relevant information.
- Click on the Create Subscription category button at the bottom of the page.
- The subscription category is created in Unidy
How to delete a subscription category
- Open the Subscription categories section in Unidy Admin Settings.
- Search for the relevant subscription category using the corresponding ID or title.
- Ensure that this is the subscription category you want to delete.
- Click on the trash bin icon or open the subscription category by clicking on the ID or title and click on the Destroy button in the top right corner.
- Confirm the deletion of the subscription category.
- The subscription category is deleted from Unidy.
How to edit a subscription category
- Open the Subscriptions categories section in Unidy Admin Settings.
- Search for the relevant subscription using the corresponding ID or title.
- Ensure that this is the subscription you want to edit.
- Click on the pen icon or open the subscription category and click on the Edit button in the top right corner.
- Update the respective data fields in the subscription category.
- Save changes by clicking on the Update Subscription category button at the bottom of the page.
- The subscription category is updated in Unidy.