# Plans

## Introduction

The Plans Dashboard provides administrators with a centralized interface to manage all subscription plans available in the marketplace.

## Dashboards menu

### Export

At the top of the dashboard, administrators can export all details from the Plans Dashboard in CSV format. This functionality enables data analysis using third-party software.

<figure><img src="https://2306631548-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4EIoqjZx1xWQIo6LnjB%2Fuploads%2FsT97GHGTBMNOEUQBrPRW%2Fimage.png?alt=media&#x26;token=c929bf98-490f-4481-9469-dba8cb0548e8" alt=""><figcaption></figcaption></figure>

### Create a Subscription Plan

To create a new marketplace subscription plan, the administrator can initiate the process by clicking the "Create a plan" button.

<figure><img src="https://2306631548-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4EIoqjZx1xWQIo6LnjB%2Fuploads%2FkAOjUB79Av35N82AOCVM%2Fimage.png?alt=media&#x26;token=f54bfcbf-9efb-47ac-bfe1-072e89692a1e" alt=""><figcaption></figcaption></figure>

When the process of creating a new subscription plan is initiated, the administrator is directed to a new window where the following information is required to complete the process:

* **Name**: This refers to the subscription name, which is prominently displayed to attract the user's attention.
* **Subtitle**: A brief text that appears below the subscription name. Its purpose is to provide a concise description of the subscription for the user.
* **Description**: This field allows the administrator to provide a detailed explanation of the subscription, including its features and benefits.
* **Price**: The monthly cost associated with the subscription.
* **Role**: The administrator assigns the role that users subscribing to this plan will receive. Roles are created within the[ **role management** ](https://features.scnd.com/v2.0/superadmin/access-rights/roles-management)section, and permissions are assigned to these roles in the [**rights management** ](https://features.scnd.com/v2.0/superadmin/access-rights/rights-management)menu. Only one role can be assigned to each subscription plan.

<figure><img src="https://2306631548-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4EIoqjZx1xWQIo6LnjB%2Fuploads%2FxBS36BXdo74JvwvZzt2D%2Fimage.png?alt=media&#x26;token=aa35dadf-bec6-4f12-869d-6232ff97c3ef" alt=""><figcaption></figcaption></figure>

### Filters

At the top of the dashboard, users can filter subscription plans based on two criteria: **Created At** and **Updated At**.

* **Created At**: A selected date allows the administrator to filter subscription plans created within the chosen time frame.
* **Updated At**:  A selected date allows the administrator to filter subscription plans updated within the chosen time frame.

<figure><img src="https://2306631548-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4EIoqjZx1xWQIo6LnjB%2Fuploads%2FzA8ptCjjgwTLnrgAI7r4%2Fimage.png?alt=media&#x26;token=57f9259a-1457-460d-8b9c-3482937c76df" alt=""><figcaption></figcaption></figure>

## Subscription Plans Card

Once a subscription plan is created, it appears on the plan dashboard as a card. Each card displays the following details:

* **Plan Name**
* **Plan Subtitle**
* **Current Status** (Active/Inactive)
* **Plan Description**
* **Date of Last Update**
* **Assigned Role**
* **Number of Active Users -** Clicking on it displays the active subscriptions
* **Monthly Price**
* **Plan ID**

This information provides a comprehensive overview of the plan’s status, pricing, and user assignments, facilitating efficient management.

<figure><img src="https://2306631548-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4EIoqjZx1xWQIo6LnjB%2Fuploads%2F1skS4B9MFKKh24ERRYe0%2Fimage.png?alt=media&#x26;token=2f75dd9d-dc52-4855-af53-1ad88b883705" alt=""><figcaption><p>4</p></figcaption></figure>

### Front-end displaying order

A six-dot icon is displayed in the top left corner of each card, enabling the administrator to adjust the display order of subscription plans in the front-end user interface. To rearrange the plans, the administrator can simply drag and drop the cards into the desired order.

<figure><img src="https://2306631548-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4EIoqjZx1xWQIo6LnjB%2Fuploads%2F36oNY4Pg5wxhSCJ12PWa%2Fimage.png?alt=media&#x26;token=15789912-9641-43c4-8db2-b7d673146dfe" alt=""><figcaption></figcaption></figure>

### Status

Each plan card includes a dropdown menu that allows users to configure the subscription status. A plan's status can be set to either "Active" or "Inactive."

{% hint style="info" %} <mark style="color:blue;">A plan can not be set as inactive if it has at least one user with a subscription plan active.</mark>
{% endhint %}

<figure><img src="https://2306631548-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4EIoqjZx1xWQIo6LnjB%2Fuploads%2FyhOt2Fo5wLQ0L8T2Lr81%2Fimage.png?alt=media&#x26;token=c0cef20f-c509-4ada-9754-7484559d7101" alt=""><figcaption></figcaption></figure>

#### Edit a Subscription Plan

When the mouse hovers over the right side of the card, an edit icon appears, enabling the administrator to modify and update the plan information.

<figure><img src="https://2306631548-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4EIoqjZx1xWQIo6LnjB%2Fuploads%2FWYzozhyEmkQemMYvQlwK%2Fimage.png?alt=media&#x26;token=5249e968-96e1-4cee-91a6-f74197459bb9" alt=""><figcaption></figcaption></figure>

{% hint style="info" %} <mark style="color:blue;">The administrator is unable to modify the monthly subscription price after the plan has been created. Additionally, the administrator cannot delete a subscription plan if at least one active user is subscribed.</mark>
{% endhint %}

#### Subscription Information

On the left side of the subscription edit page, the administrator has access to the following information and actions:

* Subscription ID
* Number of active users
* Subscription Creation date
* Subscription most recent update date

<figure><img src="https://2306631548-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4EIoqjZx1xWQIo6LnjB%2Fuploads%2F0x4mDS1TxhAYt851Eu12%2Fimage.png?alt=media&#x26;token=0e10e5e9-3190-4923-acf1-6ed0aaef01e4" alt=""><figcaption></figcaption></figure>

#### Delete a Subscription Plan

The administrator can delete the subscription and modify its status. However, these actions can only be performed if there are no active users currently subscribed.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://features.scnd.com/v2.0/superadmin/platform-subscriptions/plans.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
