Brevo

Brevo Balance API

The balance API from Brevo — 12 operation(s) for balance.

Documentation GitHub OpenAPI

Business capability

Loyalty & Retention Management BC-420.40

Operations 18

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /loyalty/balance/programs/{pid}/balance-definitions List balance definitions in a loyalty program · Get balance definition list #

Ask an LLM

“Which point or credit balances are defined in my loyalty program?”

“Can I page through the balance definitions of a program sorted by a field?”

Tell an agent

List the balance definitions in loyalty program {pid}.

Show {limit} balance definitions for program {pid}.

POST /loyalty/balance/programs/{pid}/balance-definitions Create a balance definition · Create balance definition #

Ask an LLM

“How do I set up a new points balance with its own unit in a loyalty program?”

“Can I cap the maximum amount or set an expiration when defining a balance?”

Tell an agent

Create a balance definition named {name} measured in {unit} in program {pid}.

Define a new {unit} balance {name} in program {pid} with a max amount of {maxAmount}.

GET /loyalty/balance/programs/{pid}/balance-definitions/{bdid} Get a balance definition · Get balance definition #

Ask an LLM

“What are the settings of one specific balance definition, like its unit and limits?”

“Can I read a balance definition as it stood in a particular program version?”

Tell an agent

Show balance definition {bdid} in program {pid}.

Get balance definition {bdid} from program {pid} at version {version}.

PUT /loyalty/balance/programs/{pid}/balance-definitions/{bdid} Update a balance definition · Update balance definition #

Ask an LLM

“Can I change the name, unit or rounding rules of an existing balance definition?”

“Is it possible to raise the credit limit on a balance I already defined?”

Tell an agent

Update balance definition {bdid} in program {pid} to name {name} and unit {unit}.

Change the max credit limit of balance definition {bdid} in program {pid} to {maxCreditAmountLimit}, keeping name {name} and unit {unit}.

DELETE /loyalty/balance/programs/{pid}/balance-definitions/{bdid} Delete a balance definition · Delete balance definition #

Ask an LLM

“Can I remove a balance definition from my loyalty program?”

“What do I need to delete a points balance type I no longer use?”

Tell an agent destructive · confirm first

Delete balance definition {bdid} from program {pid}.

Remove the balance type {bdid} in loyalty program {pid}.

POST /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits Add a limit to a balance definition · Create balance limits #

Ask an LLM

“How do I cap how many points a member can earn per week?”

“Can a balance limit apply to credits, debits or use a sliding schedule?”

Tell an agent

Add a {transactionType} limit of {value} per {durationValue} {durationUnit} with constraint {constraintType} to balance {bdid} in program {pid}.

Create a balance limit on definition {bdid} in program {pid}.

GET /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} Get a balance limit · Get balance limits #

Ask an LLM

“What are the constraints of a specific limit on a balance definition?”

“Can I read a balance limit as of a given program version?”

Tell an agent

Show balance limit {blid} on definition {bdid} in program {pid}.

Get limit {blid} of balance {bdid} in program {pid} at version {version}.

DELETE /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} Delete a balance limit · Delete balance limit #

Ask an LLM

“Can I remove an earning or spending cap from a balance?”

“What identifies the balance limit I want to delete?”

Tell an agent destructive · confirm first

Delete balance limit {blid} from definition {bdid} in program {pid}.

Remove limit {blid} on balance {bdid} of program {pid}.

PUT /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} Update a balance limit · Updates balance limit #

Ask an LLM

“Can I change the value or duration of an existing balance limit?”

“Is it possible to switch a limit I already created to a sliding schedule?”

Tell an agent

Change balance limit {blid} on definition {bdid} in program {pid} to {value} per {durationValue} {durationUnit}.

Edit limit {blid} of balance {bdid} in program {pid}.

GET /loyalty/balance/programs/{pid}/subscriptions/{cid}/balances Get a member's balances by subscription · Get subscription balances #

Ask an LLM

“How many points does a specific loyalty member currently have?”

“Can I include internal balances when checking a member's subscription?”

Tell an agent

Show the balances for subscription {cid} in program {pid}.

Get all balances, including internal ones, for member {cid} in program {pid}.

POST /loyalty/balance/programs/{pid}/subscriptions/{cid}/balances Open a balance for a member · Create subscription balances #

Ask an LLM

“How do I give a loyalty member a new balance of a given type?”

“Can I create a balance for a contact that doesn't have one yet?”

Tell an agent

Create a balance of definition {balanceDefinitionId} for member {cid} in program {pid}.

Open a {balanceDefinitionId} balance for subscription {cid} in program {pid}.

GET /loyalty/balance/programs/{pid}/contact-balances List all members' balances for one balance type · Get balance list #

Ask an LLM

“Which members hold a given balance type, and how much does each one have?”

“Can I list contact balances for one balance definition across every subscription?”

Tell an agent

List contact balances for definition {balanceDefinitionId} in program {pid}.

Show {limit} member balances of type {balanceDefinitionId} in program {pid}.

POST /loyalty/balance/programs/{pid}/transactions Credit or debit a member's balance · Create new transaction #

Ask an LLM

“How do I award or deduct loyalty points for a contact?”

“Can a balance transaction complete automatically or expire after a TTL?”

Tell an agent

Create a transaction of {amount} on balance {balanceDefinitionId} for contact {contactId} in program {pid}.

Start an auto-completing {transactionType} of {amount} on balance {balanceDefinitionId} in program {pid}.

POST /loyalty/balance/programs/{pid}/transactions/{tid}/complete Complete a pending balance transaction · Complete transaction #

Ask an LLM

“How do I finalize a balance transaction I started earlier?”

“What confirms a pending points credit so it hits the member's balance?”

Tell an agent

Complete balance transaction {tid} in program {pid}.

Finalize the pending transaction {tid} for program {pid}.

POST /loyalty/balance/programs/{pid}/transactions/{tid}/cancel Cancel a pending balance transaction · Cancel transaction #

Ask an LLM

“Can I cancel a balance transaction before it's completed?”

“What undoes a points credit that is still pending?”

Tell an agent destructive · confirm first

Cancel balance transaction {tid} in program {pid}.

Void the pending transaction {tid} in loyalty program {pid}.

POST /loyalty/balance/programs/{pid}/create-order Create a balance order for a contact · Create balance order #

Ask an LLM

“How do I schedule a balance credit for a contact that is due on a future date?”

“Can a balance order carry a source and expiration date?”

Tell an agent

Create a balance order of {amount} on {balanceDefinitionId} for contact {contactId}, due {dueAt}, source {source}, in program {pid}.

Place a balance order in program {pid} that expires at {expiresAt}.

GET /loyalty/balance/programs/{pid}/active-balance List a contact's active balances · Get Active Balances API #

Ask an LLM

“Which unexpired balance lots does a contact currently hold for one balance type?”

“Can I see a contact's active balances sorted by a field?”

Tell an agent

Show active balances of type {balanceDefinitionId} for contact {contactId} in program {pid}.

List {limit} currently active balances for contact {contactId} on definition {balanceDefinitionId} in program {pid}.

GET /loyalty/balance/programs/{pid}/transaction-history Get a contact's balance transaction history · Get Transaction History API #

Ask an LLM

“What credits and debits have been made to a contact's balance over time?”

“Can I filter a member's transaction history by status or transaction type?”

Tell an agent

Show the transaction history for contact {contactId} on balance {balanceDefinitionId} in program {pid}.

List {status} transactions for contact {contactId} on balance {balanceDefinitionId} in program {pid}.

Brevo Balance API

Operations 18

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification