# Fermata Documentation

## Docs

- [API Endpoints](https://fermata-preview.mintlify.app/api-endpoints.md)
- [Add Balance To User's Account](https://fermata-preview.mintlify.app/api-reference/endpoint/add-balance-to-users-account.md): Add some form of balance to a user's account and charge them for it
- [Create a new account](https://fermata-preview.mintlify.app/api-reference/endpoint/create-a-new-account.md): Creates a new user treasury account. If a valid stripe token isn't passed, then we will create a stripe customer ID for them
- [Create a new webhook](https://fermata-preview.mintlify.app/api-reference/endpoint/create-a-new-webhook.md)
- [Create Company Plan](https://fermata-preview.mintlify.app/api-reference/endpoint/create-company-plan.md): A plan basically acts as a template of account balance denominations and parameters that you can apply to an account upon creation
- [Create New User](https://fermata-preview.mintlify.app/api-reference/endpoint/create-new-user.md): Create a new user.
- [Delete webhook](https://fermata-preview.mintlify.app/api-reference/endpoint/delete-webhook.md)
- [Edit an account information](https://fermata-preview.mintlify.app/api-reference/endpoint/edit-an-account-information.md)
- [Get a single account](https://fermata-preview.mintlify.app/api-reference/endpoint/get-a-single-account.md)
- [Get all accounts](https://fermata-preview.mintlify.app/api-reference/endpoint/get-all-accounts.md): List all accounts
- [Get current balances for a given denomination for an account](https://fermata-preview.mintlify.app/api-reference/endpoint/get-current-balances-for-a-given-denomination-for-an-account.md)
- [Get transactions for account](https://fermata-preview.mintlify.app/api-reference/endpoint/get-transactions-for-account.md)
- [Get User Info by User ID](https://fermata-preview.mintlify.app/api-reference/endpoint/get-user-info-by-user-id.md): Retrieve the information of the user with the matching user ID.
- [Get webhooks](https://fermata-preview.mintlify.app/api-reference/endpoint/get-webhooks.md): List all webhooks for company
- [Mid-month modification of monthly auto-refill](https://fermata-preview.mintlify.app/api-reference/endpoint/mid-month-modification-of-monthly-auto-refill.md): This endpoint changes the auto-refill monthly setting on the account balance in a prorated way. It is only used to increase the refill amount. It follows the following process: Issue new tokens to account for given cost Figure out value of remaining tokens from previous refill and subtract that amou…
- [Modify Automatic Refill Parameters for Account](https://fermata-preview.mintlify.app/api-reference/endpoint/modify-automatic-refill-parameter.md): In the case of changing monthly refill parameters, these will take effect on the next renewal if you use this endpoint. For mid-month renewals see other endpoint
- [Push Events](https://fermata-preview.mintlify.app/api-reference/endpoint/push-events.md): Push an event to the billing engine. This endpoint can accept very high volume of requests and will be low latency. It returns a success if the data appears to be valid
- [Update a user](https://fermata-preview.mintlify.app/api-reference/endpoint/update-a-user.md)
- [General Fermata Tutorial](https://fermata-preview.mintlify.app/api-reference/introduction.md): Workflow for using the Fermata API
- [API Tutorial 101](https://fermata-preview.mintlify.app/api-tutorial-101.md)
- [API Tutorial 201](https://fermata-preview.mintlify.app/api-tutorial-201.md)
- [Basics & Definitions](https://fermata-preview.mintlify.app/basics-and-definitions.md)
- [Capturing Payment](https://fermata-preview.mintlify.app/capturing-payment.md)
- [Account Management](https://fermata-preview.mintlify.app/fermata-control/account-management.md): Within the Treasury Management area of Fermata Control, you can view and manage each customer's account with your platform.
- [Fermata Control](https://fermata-preview.mintlify.app/fermata-control/overview.md): Fermata Control is the Fermata dashboard
- [Pause](https://fermata-preview.mintlify.app/fermata-control/pause.md): As we like to say... Fermata denotes a pause. There are multiple ways you can pause an end user's platform access, or adjust billing behaviors.
- [Webhooks](https://fermata-preview.mintlify.app/fermata-control/webhooks.md): We support the following webhook events
- [Welcome to Fermata](https://fermata-preview.mintlify.app/introduction.md): A quick welcome to the Fermata platform.

## OpenAPI Specs

- [openapi](https://fermata-preview.mintlify.app/api-reference/openapi.yaml)

## Optional

- [Documentation](https://mintlify.com/docs)
- [Use Cases](https://www.gofermata.com/company/blog-1)
- [Get a demo](https://calendly.com/event_types/164691774/edit?return_to=%2Fevent_types%2Fuser%2Fme)