Get balance definition

GET

https://api.brevo.com/v3/loyalty/balance/programs/:pid/balance-definitions/:bdid

GET

/v3/loyalty/balance/programs/:pid/balance-definitions/:bdid

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.getBalanceDefinition("bdid", "pid", {});
8 }
9 main();

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

Returns balance definition

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

bdidstringRequiredformat: "uuid"

Balance Definition Id

Query parameters

versionenumOptionalDefaults to draft

Version

Allowed values:

Response

Successful retrieval of balance definition

idstringOptionalformat: "uuid"

Unique identifier for the balance definition.

namestringOptional

Name of the balance definition.

descriptionstringOptional

Short description of the balance definition.

imageRefstringOptionalformat: "uri"

Optional image reference URL.

metamap from strings to anyOptional

Additional metadata for the balance definition.

unitenumOptional

Unit of balance measurement.

minAmountdoubleOptional

Minimum allowable balance.

maxAmountdoubleOptional

Maximum allowable balance.

maxCreditAmountLimitdoubleOptional

Maximum credit allowed per operation.

maxDebitAmountLimitdoubleOptional

Maximum debit allowed per operation.

balanceOptionAmountOvertakingStrategyenumOptional

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 limit.

balanceOptionCreditRoundingenumOptional

Rounding strategy for credit transactions.

balanceOptionDebitRoundingenumOptional

Rounding strategy for debit transactions.

balanceAvailabilityDurationValueintegerOptional

Number of time units before the balance expires.

balanceAvailabilityDurationUnitenumOptional

Unit of time for the balance availability duration.

balanceAvailabilityDurationModifierenumOptional

Modifier for balance availability duration. startOfPeriod causes expiry at the start of the period, endOfPeriod at the end. noModification uses the exact duration from the credit date.

balanceExpirationDatestringOptional

Fixed expiration date in dd/mm format. The balance expires when this date next appears in the calendar. Only one of balanceExpirationDate or balance availability duration fields can be used.

createdAtdatetimeOptional

Timestamp of balance definition creation.

updatedAtdatetimeOptional

Timestamp of the last update.

deletedAtdatetimeOptional

Timestamp of balance definition deletion (nullable).

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error