How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Brevo

Brevo Balance API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Brevo Balance API is one of 53 APIs that Brevo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Balances. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 18 operations across 12 paths, and defines 62 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.brevo.com/v3.

18 operations 12 paths 62 schemas 2 DELETE7 GET7 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.brevo.com/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Brevo Balance API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (api-key).

  • api-key — The API key should be passed in the request headers as api-key for authentication.

Paths & Operations 18

Across 12 paths, the API surfaces 18 operations — 2 DELETE, 7 GET, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

balance 18
GET
/loyalty/balance/programs/{pid}/balance-definitions
Get balance definition list
getBalanceDefinitionList 7 params → 200401403422500
POST
/loyalty/balance/programs/{pid}/balance-definitions
Create balance definition
createBalanceDefinition 2 params body → 200401403404422500
GET
/loyalty/balance/programs/{pid}/balance-definitions/{bdid}
Get balance definition
getBalanceDefinition 4 params → 200401403404422500
PUT
/loyalty/balance/programs/{pid}/balance-definitions/{bdid}
Update balance definition
updateBalanceDefinition 3 params body → 200401403404422424500
DELETE
/loyalty/balance/programs/{pid}/balance-definitions/{bdid}
Delete balance definition
deleteBalanceDefinition 3 params → 204401403404422500
POST
/loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits
Create balance limits
createBalanceLimit 3 params body → 200401403422424500
GET
/loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid}
Get balance limits
getBalanceLimit 5 params → 200401403404422500
DELETE
/loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid}
Delete balance limit
deleteBalanceLimit 4 params → 204401403404422500
PUT
/loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid}
Updates balance limit
updateBalanceLimit 4 params body → 200401403404422500
GET
/loyalty/balance/programs/{pid}/subscriptions/{cid}/balances
Get subscription balances
getSubscriptionBalances 4 params → 200401403404422500
POST
/loyalty/balance/programs/{pid}/subscriptions/{cid}/balances
Create subscription balances
createSubscriptionBalances 3 params body → 200401403404422500
GET
/loyalty/balance/programs/{pid}/contact-balances
Get balance list
getContactBalances 8 params → 200401403404422500
POST
/loyalty/balance/programs/{pid}/transactions
Create new transaction
beginTransaction 2 params body → 200401403404422500
POST
/loyalty/balance/programs/{pid}/transactions/{tid}/complete
Complete transaction
completeTransaction 3 params → 200401403404422500
POST
/loyalty/balance/programs/{pid}/transactions/{tid}/cancel
Cancel transaction
cancelTransaction 3 params → 200401403404422500
POST
/loyalty/balance/programs/{pid}/create-order
Create balance order
createBalanceOrder 2 params body → 200401403422500
GET
/loyalty/balance/programs/{pid}/active-balance
Get Active Balances API
getActiveBalancesApi 9 params → 200401403404422500
GET
/loyalty/balance/programs/{pid}/transaction-history
Get Transaction History API
getTransactionHistoryApi 11 params → 200401403404422500

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are balanceDefinition (20 properties), transaction (16 properties), Balance_createBalanceOrder_Response_200 (12 properties), LoyaltyBalanceProgramsPidTransactionHistoryGetResponsesContentApplicationJsonSchemaTransactionHistoryItems (11 properties). Each schema is shown below with its type and property counts.

LoyaltyBalanceProgramsPidTransactionHistoryGetResponsesContentApplicationJsonSchemaTransactionHistoryItems
object
Represents a record of a past transaction, including status and key timestamps.
11 properties
LoyaltyBalanceProgramsPidSubscriptionsCidBalancesGetResponsesContentApplicationJsonSchemaBalanceItems
object
2 properties
LoyaltyBalanceProgramsPidBalanceDefinitionsGetParametersVersion
string
balanceDefinition
object
20 properties
LoyaltyBalanceProgramsPidBalanceDefinitionsGetParametersSortField
string
BalanceDefinitionBalanceOptionDebitRounding
string
Rounding strategy for debit transactions.
LoyaltyBalanceProgramsPidActiveBalanceGetResponsesContentApplicationJsonSchemaActiveBalancesItems
object
4 properties
LoyaltyBalanceProgramsPidActiveBalanceGetParametersSort
string
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidPutRequestBodyContentApplicationJsonSchemaBalanceOptionCreditRounding
string
Rounding strategy for credit transactions.
balanceLimit
object
10 properties
Balance_getSubscriptionBalances_Response_200
object
3 properties
LoyaltyBalanceProgramsPidBalanceDefinitionsPostRequestBodyContentApplicationJsonSchemaBalanceAvailabilityDurationModifier
string
Defines when the balance expires within the selected duration.
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidLimitsBlidPutRequestBodyContentApplicationJsonSchemaDurationUnit
string
Unit of time for which the limit is applicable.
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidPutRequestBodyContentApplicationJsonSchemaBalanceAvailabilityDurationUnit
string
Unit of time for balance validity.
LoyaltyBalanceProgramsPidActiveBalanceGetParametersSortField
string
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidPutRequestBodyContentApplicationJsonSchemaUnit
string
Unit of balance measurement.
LoyaltyBalanceProgramsPidBalanceDefinitionsPostRequestBodyContentApplicationJsonSchemaBalanceOptionDebitRounding
string
Defines rounding strategy for debit transactions.
BalanceLimitConstraintType
string
Defines the type of constraint (transaction count or amount).
Balance_getTransactionHistoryApi_Response_200
object
Response containing transaction history details for a specific balance and contact.
5 properties
LoyaltyBalanceProgramsPidTransactionsPostRequestBodyContentApplicationJsonSchemaTransactionType
string
Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit).
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidLimitsPostRequestBodyContentApplicationJsonSchemaConstraintType
string
Defines whether the limit applies to transaction count or amount.
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidLimitsBlidPutRequestBodyContentApplicationJsonSchemaConstraintType
string
Defines whether the limit applies to transaction count or amount.
TransactionStatus
string
The current status of the transaction.
LoyaltyBalanceProgramsPidTransactionHistoryGetParametersSort
string
LoyaltyBalanceProgramsPidBalanceDefinitionsPostRequestBodyContentApplicationJsonSchemaUnit
string
Unit of balance measurement.
BalanceLimitTransactionType
string
Specifies whether the limit applies to credit or debit transactions.
LoyaltyBalanceProgramsPidContactBalancesGetResponsesContentApplicationJsonSchemaBalancesItems
object
4 properties
BalanceDefinitionBalanceAvailabilityDurationModifier
string
Modifier for balance availability duration. startOfPeriod causes expiry at the start of the period, endOfPeriod at the end. noModification uses the exact durat…
LoyaltyBalanceProgramsPidBalanceDefinitionsPostRequestBodyContentApplicationJsonSchemaBalanceAvailabilityDurationUnit
string
Unit of time for balance validity.
LoyaltyBalanceProgramsPidContactBalancesGetParametersSort
string
transaction
object
Represents a transaction involving a balance, including status and timestamps.
16 properties
LoyaltyBalanceProgramsPidCreateOrderPostRequestBodyContentApplicationJsonSchemaSource
string
Specifies the origin of the order.
Balance_createBalanceOrder_Response_200
object
Represents an order linked to a balance definition, including amount, due date, and transaction details.
12 properties 6 required
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidLimitsBlidGetParametersVersion
string
LoyaltyBalanceProgramsPidBalanceDefinitionsPostRequestBodyContentApplicationJsonSchemaBalanceOptionCreditRounding
string
Defines rounding strategy for credit transactions.
LoyaltyBalanceProgramsPidBalanceDefinitionsPostRequestBodyContentApplicationJsonSchemaBalanceOptionAmountOvertakingStrategy
string
Defines whether partial credit is allowed when reaching max balance.
LoyaltyBalanceProgramsPidTransactionHistoryGetParametersTransactionType
string
LoyaltyBalanceProgramsPidTransactionHistoryGetResponsesContentApplicationJsonSchemaTransactionHistoryItemsTransactionType
string
The type of the transaction.
BalanceDefinitionBalanceOptionCreditRounding
string
Rounding strategy for credit transactions.
Balance_createSubscriptionBalances_Response_200
object
9 properties
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidLimitsPostRequestBodyContentApplicationJsonSchemaDurationUnit
string
Unit of time for which the limit is applicable.
errorModel
object
2 properties 1 required
TransactionTransactionType
string
The type of the transaction.
BalanceLimitDurationUnit
string
Time unit for the balance limit.
LoyaltyBalanceProgramsPidBalanceDefinitionsGetParametersSort
string
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidPutRequestBodyContentApplicationJsonSchemaBalanceOptionDebitRounding
string
Rounding strategy for debit transactions.
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidGetParametersVersion
string
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidLimitsBlidPutRequestBodyContentApplicationJsonSchemaTransactionType
string
Specifies whether the limit applies to credit or debit transactions.
LoyaltyBalanceProgramsPidBalanceDefinitionsPostRequestBodyContentApplicationJsonSchemaMeta
object
Additional metadata for the balance definition.
1 property
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidPutRequestBodyContentApplicationJsonSchemaBalanceAvailabilityDurationModifier
string
Defines when the balance expires within the selected duration.
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidPutRequestBodyContentApplicationJsonSchemaBalanceOptionAmountOvertakingStrategy
string
Defines whether partial credit is allowed when reaching max balance.
LoyaltyBalanceProgramsPidTransactionHistoryGetParametersSortField
string
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidLimitsPostRequestBodyContentApplicationJsonSchemaTransactionType
string
Specifies whether the limit applies to credit or debit transactions.
Balance_getContactBalances_Response_200
object
4 properties
LoyaltyBalanceProgramsPidTransactionHistoryGetParametersStatus
string
Balance_getActiveBalancesApi_Response_200
object
Active balance response for a specific contact and balance definition.
5 properties
BalanceDefinitionBalanceAvailabilityDurationUnit
string
Unit of time for the balance availability duration.
Balance_getBalanceDefinitionList_Response_200
object
1 property
BalanceDefinitionBalanceOptionAmountOvertakingStrategy
string
Partial enables partial credit of balance if maximum balance limit is reached. Strict enables rejection of a transaction if it will breach the max balance limi…
LoyaltyBalanceProgramsPidContactBalancesGetParametersSortField
string
BalanceDefinitionUnit
string
Unit of balance measurement.
LoyaltyBalanceProgramsPidBalanceDefinitionsBdidPutRequestBodyContentApplicationJsonSchemaMeta
object
Optional metadata for the balance definition.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

brevo-balance-api-openapi.yml Raw ↑

Other APIs Brevo publishes across the network.

brevo Agent Status API
AE Profile APIs.io
brevo Automated Messages API
AE Profile APIs.io
brevo Campaign Statistics API
AE Profile APIs.io
brevo Categories API
AE Profile APIs.io
brevo Contact Attributes API
AE Profile APIs.io
brevo Contact Lists API
AE Profile APIs.io
brevo Contacts API
AE Profile APIs.io
brevo Email Activity API
AE Profile APIs.io
brevo Email Campaigns API
AE Profile APIs.io
brevo Email Templates API
AE Profile APIs.io
brevo Folders API
AE Profile APIs.io
brevo Import API
AE Profile APIs.io
#Balances
← Back to B APIs
API Details
ID
brevo:brevo-balance-api
Base URL
https://api.brevo.com/v3
Docs
https://developers.brevo.com/reference
Provider
Brevo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=brevo-balance-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/brevo-balance-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Brevo Balance API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.