> For the complete documentation index, see [llms.txt](https://docs.zapsign.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zapsign.com.br/zapsign-api/english/account/plan-information.md).

# Plan Information

To facilitate the management of your plan, you can directly consult detailed information about its status and available credits via the API. This endpoint provides essential data on the current plan, giving you more autonomy to track its status and manage usage effectively.\
\
\
Endpoint:<mark style="color:blue;">`GET`</mark> `https://api.zapsign.com.br/api/v1/info-plan`

#### Headers

<table><thead><tr><th width="211">Name</th><th width="135">Type</th><th>Description</th></tr></thead><tbody><tr><td>Authorization<mark style="color:red;">*</mark></td><td>string</td><td>API token prefixed with the word "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23</td></tr></tbody></table>

![Plan information](https://github.com/AmandaAmani/documenta-ocurso/blob/main/info%20plan.gif?raw=true)

This endpoint returns information about the plan, including:

* **Plan name** (`name`)
* **Number of credits** in the account (`number_of_credits`)
* **Plan status** (`status`): can be `paid`, `pending_payment`, `unpaid`, or `canceled`
* **Period** (`period`): monthly (`monthly`) or annual (`annual`)
* **End date** of the current period (`current_period_end`)<br>

**Example Response**

{% tabs %}
{% tab title="200-plan found" %}

```
{
    "name": "Test Plan",
    "number_of_credits": "100",
    "status": "paid",
    "period": "annual",
    "current_period_end": "dd-mm-yyyy"
}
```

{% endtab %}

{% tab title="404-Not found" %}
Unable to find information about this plan
{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zapsign.com.br/zapsign-api/english/account/plan-information.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.