> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cocoondata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# <access-service>/api/v1/plans

## URL structure&#x20;

```text theme={null}
https://access-service.xy-company.com/api/v1/plans
```

## Supported methods and overview&#x20;

* `POST` - used to add a new [plan](/3.0/admin/managing-users-storage-quotas-through-plans.md).
* `GET` - used to retrieve a list of field information for all current plans on the Covata Platform.

> [!NOTE]
>
> The `GET` method takes no parameters.

## Detailed description&#x20;

This API endpoint serves a number of purposes:

* Adds a new plan to the Covata Platform.
* Retrieves a list of field information for all current plans on the Covata Platform.

## Supported roles&#x20;

This API endpoint supports the following Covata user [roles](/3.0/admin/administering-users.md#a-users-roles) (as described in the [Covata Platform Administrator's Guide](/3.0/admin.md)):

* [System administrator](/3.0/admin/administering-users.md#system-administrator-role)

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the [header](/3.0/api/access-service-api-v1-plans.md#access-service-api-v1-plans-required-headers) of requests to this endpoint.

## Required headers&#x20;

The appropriate access token as the `Bearer` token:

* `Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6`

The following header is required if the body of the request has a JSON object:

* `Content-Type: application/json`

## Required parameters&#x20;

The following required parameters must be sent in the body of the POST request, as individual members of a JSON object:

* **description** - .
* **name** - .
* **quota** - Specify in MB.

  **Example ():**

## Optional parameters&#x20;

The following optional parameter can also be sent in the body of the POST request, as individual members of the JSON object that includes the [Required parameters](/3.0/api/access-service-api-v1-plans.md#access-service-api-v1-plans-required-parameters) above:

* **default** - true or false.

  **Example ():**

## Returns&#x20;

A JSON-formatted response containing the following members:

* **items** - .

  * **id** - .
  * **name** - .
  * **default** - .

  **Example (response from ...):**


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.