Vindi API: what it can do and how to use it with AI agents
Vindi is a Brazilian billing platform. Its API manages recurring and one-off charges: customers, plans, subscriptions, invoices and payment methods. Subscription businesses, SaaS companies, schools and monthly-fee services in Brazil use it. Access is by an account API key, with a sandbox environment.
What the Vindi API offers
Customers
Create and update customers and their billing data.
Plans and products
Configure what is sold and how often it is billed.
Subscriptions
Create, change and cancel recurring subscriptions.
Invoices and charges
Look up invoices, charge attempts and payment status.
Webhooks
Events such as invoice created, payment approved or declined, and subscription canceled.
How to access the Vindi API
- With your company’s credentialsIt uses a private API key generated in the Vindi dashboard and sent with basic authentication, with different keys for sandbox and production.
- The private key gives broad access to the account: keep it only in the vault and rotate it if it leaks.
- Do not ask for card data through the agent: use the Vindi payment page.
- Customer and billing data is covered by LGPD, Brazil's data-protection law.
What an iTeam agent does with the Vindi API
Card declined, customer informed
When a charge fails, the agent tells the customer through their preferred channel, explains why and sends the link to update the card.
Retention at cancellation
Cancellation requests go through the agent, which checks the history and offers the approved alternatives before canceling.
Assisted plan change
The agent prepares an upgrade or downgrade with the price difference and runs it after the customer and finance confirm.
Recurring revenue report
The manager receives new subscriptions, cancellations, failed charges and amounts at risk every week.
From the credential to the agent at work, with approval
Generate the key in Vindi
In the Vindi dashboard, create the API key, starting with the sandbox.
Store it in the vault and set limits
The key stays in the iTeam vault. Lookups are open, while subscription changes and refunds require approval.
Webhooks and validation
Set up the billing webhooks, validate the flows in the sandbox, then switch to the production key.
Ready-made AI teams that use Vindi
Questions about the Vindi API
Is the Vindi API free?
In general the API is part of the contracted service. The costs come from the plan and the billing rates agreed with Vindi.
Do I need to code to use the Vindi API with iTeam?
Not necessarily. iTeam's HTTP tool learns the endpoints from the documentation, and the deployment team sets up the rules.
Does Vindi have a sandbox?
Yes. There is a test environment to validate charges before you use the real account.
