Brevo

Brevo Balance API

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

GitHub OpenAPI

Operations 18

GET /loyalty/balance/programs/{pid}/balance-definitions Get balance definition list #
POST /loyalty/balance/programs/{pid}/balance-definitions Create balance definition #
GET /loyalty/balance/programs/{pid}/balance-definitions/{bdid} Get balance definition #
PUT /loyalty/balance/programs/{pid}/balance-definitions/{bdid} Update balance definition #
DELETE /loyalty/balance/programs/{pid}/balance-definitions/{bdid} Delete balance definition #
POST /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits Create balance limits #
GET /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} Get balance limits #
DELETE /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} Delete balance limit #
PUT /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} Updates balance limit #
GET /loyalty/balance/programs/{pid}/subscriptions/{cid}/balances Get subscription balances #
POST /loyalty/balance/programs/{pid}/subscriptions/{cid}/balances Create subscription balances #
GET /loyalty/balance/programs/{pid}/contact-balances Get balance list #
POST /loyalty/balance/programs/{pid}/transactions Create new transaction #
POST /loyalty/balance/programs/{pid}/transactions/{tid}/complete Complete transaction #
POST /loyalty/balance/programs/{pid}/transactions/{tid}/cancel Cancel transaction #
POST /loyalty/balance/programs/{pid}/create-order Create balance order #
GET /loyalty/balance/programs/{pid}/active-balance Get Active Balances API #
GET /loyalty/balance/programs/{pid}/transaction-history Get Transaction History API #

Documentation

📖
Documentation
https://developers.brevo.com/docs/loyalty-overview
📖
APIReference
https://developers.brevo.com/reference
📖
Documentation
https://developers.brevo.com/reference
📖
Documentation
https://developers.brevo.com/docs/getting-started-with-senders-and-domains
📖
Documentation
https://developers.brevo.com/docs/event-endpoints
📖
Documentation
https://developers.brevo.com/docs/custom-objects-management
📖
Documentation
https://developers.brevo.com/reference/get-wallet-pass-install-url

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/brevo/refs/heads/main/openapi/brevo-balance-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/brevo/refs/heads/main/asyncapi/brevo-webhooks-asyncapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/brevo-balance-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

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

OpenAPI Specification

brevo-balance-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Loyalty Balance API
  version: 1.0.0
servers:
- url: https://api.brevo.com/v3
  description: https://api.brevo.com/v3
tags:
- name: balance
paths:
  /loyalty/balance/programs/{pid}/balance-definitions:
    get:
      operationId: getBalanceDefinitionList
      summary: Get balance definition list
      description: Returns balance definition page
      tags:
      - balance
      parameters:
      - name: pid
        in: path
        description: Loyalty Program Id
        required: true
        schema:
          type: string
          format: uuid
      - name: limit
        in: query
        description: Limit the number of records returned
        required: false
        schema:
          type: integer
          default: 200
      - name: offset
        in: query
        description: Offset to paginate records
        required: false
        schema:
          type: integer
          default: 0
      - name: sortField
        in: query
        description: Field to sort by
        required: false
        schema:
          $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsGetParametersSortField'
          default: updated_at
      - name: sort
        in: query
        description: Sort direction
        required: false
        schema:
          $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsGetParametersSort'
          default: desc
      - name: version
        in: query
        description: Version
        required: false
        schema:
          $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsGetParametersVersion'
          default: draft
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful retrieval of balance definition page
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balance_getBalanceDefinitionList_Response_200'
        '401':
          description: Request Authentication Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '403':
          description: Cannot Authenticate Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '422':
          description: Validation errors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '500':
          description: Internal error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
    post:
      operationId: createBalanceDefinition
      summary: Create balance definition
      description: Creates balance definition and returns information
      tags:
      - balance
      parameters:
      - name: pid
        in: path
        description: Loyalty Program Id
        required: true
        schema:
          type: string
          format: uuid
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful creation of balance definition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/balanceDefinition'
        '401':
          description: Request Authentication Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '403':
          description: Cannot Authenticate Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '404':
          description: No content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '422':
          description: Validation errors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '500':
          description: Internal error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        description: Create Balance Definition Payload
        content:
          application/json:
            schema:
              type: object
              properties:
                balanceAvailabilityDurationModifier:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsPostRequestBodyContentApplicationJsonSchemaBalanceAvailabilityDurationModifier'
                  description: Defines when the balance expires within the selected duration.
                balanceAvailabilityDurationUnit:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsPostRequestBodyContentApplicationJsonSchemaBalanceAvailabilityDurationUnit'
                  description: Unit of time for balance validity.
                balanceAvailabilityDurationValue:
                  type: integer
                  description: Number of time units before the balance expires.
                balanceExpirationDate:
                  type: string
                  format: date
                  description: Fixed expiration date (`dd/mm` format) as an alternative to duration-based expiry.
                balanceOptionAmountOvertakingStrategy:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsPostRequestBodyContentApplicationJsonSchemaBalanceOptionAmountOvertakingStrategy'
                  description: Defines whether partial credit is allowed when reaching max balance.
                balanceOptionCreditRounding:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsPostRequestBodyContentApplicationJsonSchemaBalanceOptionCreditRounding'
                  description: Defines rounding strategy for credit transactions.
                balanceOptionDebitRounding:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsPostRequestBodyContentApplicationJsonSchemaBalanceOptionDebitRounding'
                  description: Defines rounding strategy for debit transactions.
                description:
                  type: string
                  description: Short description of the balance definition.
                imageRef:
                  type: string
                  description: URL of an optional image reference.
                maxAmount:
                  type: number
                  format: double
                  description: Maximum allowable balance amount.
                maxCreditAmountLimit:
                  type: number
                  format: double
                  description: Maximum credit allowed per operation.
                maxDebitAmountLimit:
                  type: number
                  format: double
                  description: Maximum debit allowed per operation.
                meta:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsPostRequestBodyContentApplicationJsonSchemaMeta'
                  description: Additional metadata for the balance definition.
                minAmount:
                  type: number
                  format: double
                  description: Minimum allowable balance amount.
                name:
                  type: string
                  description: Name of the balance definition.
                unit:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsPostRequestBodyContentApplicationJsonSchemaUnit'
                  description: Unit of balance measurement.
              required:
              - name
              - unit
  /loyalty/balance/programs/{pid}/balance-definitions/{bdid}:
    get:
      operationId: getBalanceDefinition
      summary: Get balance definition
      description: Returns balance definition
      tags:
      - balance
      parameters:
      - name: pid
        in: path
        description: Loyalty Program Id
        required: true
        schema:
          type: string
          format: uuid
      - name: bdid
        in: path
        description: Balance Definition Id
        required: true
        schema:
          type: string
          format: uuid
      - name: version
        in: query
        description: Version
        required: false
        schema:
          $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidGetParametersVersion'
          default: draft
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful retrieval of balance definition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/balanceDefinition'
        '401':
          description: Request Authentication Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '403':
          description: Cannot Authenticate Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '404':
          description: not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '422':
          description: Validation errors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '500':
          description: Internal error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
    put:
      operationId: updateBalanceDefinition
      summary: Update balance definition
      description: Updates Balance definition
      tags:
      - balance
      parameters:
      - name: pid
        in: path
        description: Loyalty Program Id
        required: true
        schema:
          type: string
          format: uuid
      - name: bdid
        in: path
        description: Balance Definition Id
        required: true
        schema:
          type: string
          format: uuid
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful update of balance definition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/balanceDefinition'
        '401':
          description: Request Authentication Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '403':
          description: Cannot Authenticate Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '404':
          description: balance definition doesn't exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '422':
          description: Validation errors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '424':
          description: Failed Dependency Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '500':
          description: Internal error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        description: Create Balance Definition Payload
        content:
          application/json:
            schema:
              type: object
              properties:
                balanceAvailabilityDurationModifier:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidPutRequestBodyContentApplicationJsonSchemaBalanceAvailabilityDurationModifier'
                  description: Defines when the balance expires within the selected duration.
                balanceAvailabilityDurationUnit:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidPutRequestBodyContentApplicationJsonSchemaBalanceAvailabilityDurationUnit'
                  description: Unit of time for balance validity.
                balanceAvailabilityDurationValue:
                  type: integer
                  description: Number of time units before the balance expires.
                balanceExpirationDate:
                  type: string
                  description: Expiration date (`dd/mm` format) or empty if not applicable.
                balanceOptionAmountOvertakingStrategy:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidPutRequestBodyContentApplicationJsonSchemaBalanceOptionAmountOvertakingStrategy'
                  description: Defines whether partial credit is allowed when reaching max balance.
                balanceOptionCreditRounding:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidPutRequestBodyContentApplicationJsonSchemaBalanceOptionCreditRounding'
                  description: Rounding strategy for credit transactions.
                balanceOptionDebitRounding:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidPutRequestBodyContentApplicationJsonSchemaBalanceOptionDebitRounding'
                  description: Rounding strategy for debit transactions.
                description:
                  type: string
                  description: Short description of the balance definition.
                imageRef:
                  type: string
                  description: URL of an optional image reference.
                maxAmount:
                  type: number
                  format: double
                  description: Maximum allowable balance amount.
                maxCreditAmountLimit:
                  type: number
                  format: double
                  description: Maximum credit allowed per operation.
                maxDebitAmountLimit:
                  type: number
                  format: double
                  description: Maximum debit allowed per operation.
                meta:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidPutRequestBodyContentApplicationJsonSchemaMeta'
                  description: Optional metadata for the balance definition.
                minAmount:
                  type: number
                  format: double
                  description: Minimum allowable balance amount.
                name:
                  type: string
                  description: Name of the balance definition.
                unit:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidPutRequestBodyContentApplicationJsonSchemaUnit'
                  description: Unit of balance measurement.
              required:
              - name
              - unit
    delete:
      operationId: deleteBalanceDefinition
      summary: Delete balance definition
      description: Delete Balance definition
      tags:
      - balance
      parameters:
      - name: pid
        in: path
        description: Loyalty Program Id
        required: true
        schema:
          type: string
          format: uuid
      - name: bdid
        in: path
        description: Balance Definition Id
        required: true
        schema:
          type: string
          format: uuid
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successful deletion of balance definition
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          description: Request Authentication Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '403':
          description: Cannot Authenticate Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '422':
          description: Validation errors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '500':
          description: Internal error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
  /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits:
    post:
      operationId: createBalanceLimit
      summary: Create balance limits
      description: Creates balance limit and sends the created UUID along with the data
      tags:
      - balance
      parameters:
      - name: pid
        in: path
        description: Loyalty Program Id
        required: true
        schema:
          type: string
          format: uuid
      - name: bdid
        in: path
        description: Balance Definition Id
        required: true
        schema:
          type: string
          format: uuid
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful creation of balance limit
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/balanceLimit'
        '401':
          description: Request Authentication Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '403':
          description: Cannot Authenticate Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '422':
          description: Validation errors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '424':
          description: Failed Dependency Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '500':
          description: Internal error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        description: Balance Definition Payload
        content:
          application/json:
            schema:
              type: object
              properties:
                constraintType:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidLimitsPostRequestBodyContentApplicationJsonSchemaConstraintType'
                  description: Defines whether the limit applies to transaction count or amount.
                durationUnit:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidLimitsPostRequestBodyContentApplicationJsonSchemaDurationUnit'
                  description: Unit of time for which the limit is applicable.
                durationValue:
                  type: integer
                  description: Number of time units for the balance limit.
                slidingSchedule:
                  type: boolean
                  description: Determines if the limit resets on a rolling schedule.
                transactionType:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidLimitsPostRequestBodyContentApplicationJsonSchemaTransactionType'
                  description: Specifies whether the limit applies to credit or debit transactions.
                value:
                  type: integer
                  description: Maximum allowed value for the specified constraint type.
              required:
              - constraintType
              - durationUnit
              - durationValue
              - transactionType
              - value
  /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid}:
    get:
      operationId: getBalanceLimit
      summary: Get balance limits
      description: Fetches balance limits and send the created UUID along with the data
      tags:
      - balance
      parameters:
      - name: pid
        in: path
        description: Loyalty Program Id
        required: true
        schema:
          type: string
          format: uuid
      - name: bdid
        in: path
        description: Balance Definition Id
        required: true
        schema:
          type: string
          format: uuid
      - name: blid
        in: path
        description: Balance Limit Id
        required: true
        schema:
          type: string
          format: uuid
      - name: version
        in: query
        description: Version
        required: false
        schema:
          $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidLimitsBlidGetParametersVersion'
          default: draft
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful retrieval of balance limit
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/balanceLimit'
        '401':
          description: Request Authentication Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '403':
          description: Cannot Authenticate Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '404':
          description: balance limit not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '422':
          description: Validation errors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '500':
          description: Internal error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
    delete:
      operationId: deleteBalanceLimit
      summary: Delete balance limit
      description: Delete balance limit
      tags:
      - balance
      parameters:
      - name: pid
        in: path
        description: Loyalty Program Id
        required: true
        schema:
          type: string
          format: uuid
      - name: bdid
        in: path
        description: Balance Definition Id
        required: true
        schema:
          type: string
          format: uuid
      - name: blid
        in: path
        description: Balance Limit Id
        required: true
        schema:
          type: string
          format: uuid
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successful deletion of balance definition
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          description: Request Authentication Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '403':
          description: Cannot Authenticate Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '404':
          description: not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '422':
          description: Validation errors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '500':
          description: Internal error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
    put:
      operationId: updateBalanceLimit
      summary: Updates balance limit
      description: Updates balance limit
      tags:
      - balance
      parameters:
      - name: pid
        in: path
        description: Loyalty Program Id
        required: true
        schema:
          type: string
          format: uuid
      - name: bdid
        in: path
        description: Balance Definition Id
        required: true
        schema:
          type: string
          format: uuid
      - name: blid
        in: path
        description: Balance Limit Id
        required: true
        schema:
          type: string
          format: uuid
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful update of balance limit
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/balanceLimit'
        '401':
          description: Request Authentication Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '403':
          description: Cannot Authenticate Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '404':
          description: not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '422':
          description: Validation errors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '500':
          description: Internal error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        description: Balance Limits Payload
        content:
          application/json:
            schema:
              type: object
              properties:
                constraintType:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidLimitsBlidPutRequestBodyContentApplicationJsonSchemaConstraintType'
                  description: Defines whether the limit applies to transaction count or amount.
                durationUnit:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidLimitsBlidPutRequestBodyContentApplicationJsonSchemaDurationUnit'
                  description: Unit of time for which the limit is applicable.
                durationValue:
                  type: integer
                  description: Number of time units for the balance limit.
                slidingSchedule:
                  type: boolean
                  description: Determines if the limit resets on a rolling schedule.
                transactionType:
                  $ref: '#/components/schemas/LoyaltyBalanceProgramsPidBalanceDefinitionsBdidLimitsBlidPutRequestBodyContentApplicationJsonSchemaTransactionType'
                  description: Specifies whether the limit applies to credit or debit transactions.
                value:
                  type: integer
                  description: Maximum allowed value for the specified constraint type.
              required:
              - constraintType
              - durationUnit
              - durationValue
              - transactionType
              - value
  /loyalty/balance/programs/{pid}/subscriptions/{cid}/balances:
    get:
      operationId: getSubscriptionBalances
      summary: Get subscription balances
      description: Returns subscription balances
      tags:
      - balance
      parameters:
      - name: cid
        in: path
        description: Contact Id
        required: true
        schema:
          type: string
          format: int
      - name: pid
        in: path
        description: Loyalty Program Id
        required: true
        schema:
          type: string
          format: uuid
      - name: includeInternal
        in: query
        description: Include balances tied to internal definitions.
        required: false
        schema:
          type: boolean
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful retrieval of contact balance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balance_getSubscriptionBalances_Response_200'
        '401':
          description: Request Authentication Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '403':
          description: Cannot Authenticate Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '404':
          description: not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '422':
          description: Validation errors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
        '500':
          description: Internal error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
    post:
      operationId: createSubscriptionBalances
      summary: Create subscription balances
      description: Creates a balance for a contact
      tags:
      - balance
      parameters:
      - name: pid
        in: path
        description: Loyalty Program Id
        required: true
        schema:
          type: string
          format: uuid
      - name: cid
        in: path
        description: Contact Id
        required: true
        schema:
          type: string
          format: uuid
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful creation of balance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balance_createSu

# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/brevo/refs/heads/main/openapi/brevo-balance-api-openapi.yml