Get balance definition list | Brevo API Documentation

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.balance.getBalanceDefinitionList("pid", {});
}
main();

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "imageRef": "string",
      "meta": {},
      "unit": "POINTS",
      "minAmount": 1.1,
      "maxAmount": 1.1,
      "maxCreditAmountLimit": 1.1,
      "maxDebitAmountLimit": 1.1,
      "balanceOptionAmountOvertakingStrategy": "strict",
      "balanceOptionCreditRounding": "lower",
      "balanceOptionDebitRounding": "lower",
      "balanceAvailabilityDurationValue": 1,
      "balanceAvailabilityDurationUnit": "day",
      "balanceAvailabilityDurationModifier": "noModification",
      "balanceExpirationDate": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ]
}

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.balance.getBalanceDefinitionList("pid", {});
}
main();

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "imageRef": "string",
      "meta": {},
      "unit": "POINTS",
      "minAmount": 1.1,
      "maxAmount": 1.1,
      "maxCreditAmountLimit": 1.1,
      "maxDebitAmountLimit": 1.1,
      "balanceOptionAmountOvertakingStrategy": "strict",
      "balanceOptionCreditRounding": "lower",
      "balanceOptionDebitRounding": "lower",
      "balanceAvailabilityDurationValue": 1,
      "balanceAvailabilityDurationUnit": "day",
      "balanceAvailabilityDurationModifier": "noModification",
      "balanceExpirationDate": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ]
}

Returns balance definition page

Authentication

api-keystring

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

Path parameters

pidstringRequiredformat: "uuid"

Loyalty Program Id

Query parameters

limitintegerOptional1-500Defaults to 200

Limit the number of records returned

offsetintegerOptional>=0Defaults to 0

Offset to paginate records

sortFieldenumOptionalDefaults to updated_at

Field to sort by

Allowed values:

sortenumOptionalDefaults to desc

Sort direction

Allowed values:

versionenumOptionalDefaults to draft

Version

Allowed values:

Response

Successful retrieval of balance definition page

itemslist of objects

list of balance definitions

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.balance.getBalanceDefinitionList("pid", {});
8	}
9	main();

1	{
2	"items": [
3	{
4	"id": "string",
5	"name": "string",
6	"description": "string",
7	"imageRef": "string",
8	"meta": {},
9	"unit": "POINTS",
10	"minAmount": 1.1,
11	"maxAmount": 1.1,
12	"maxCreditAmountLimit": 1.1,
13	"maxDebitAmountLimit": 1.1,
14	"balanceOptionAmountOvertakingStrategy": "strict",
15	"balanceOptionCreditRounding": "lower",
16	"balanceOptionDebitRounding": "lower",
17	"balanceAvailabilityDurationValue": 1,
18	"balanceAvailabilityDurationUnit": "day",
19	"balanceAvailabilityDurationModifier": "noModification",
20	"balanceExpirationDate": "string",
21	"createdAt": "2024-01-15T09:30:00Z",
22	"updatedAt": "2024-01-15T09:30:00Z",
23	"deletedAt": "2024-01-15T09:30:00Z"
24	}
25	]
26	}