Get subscription balances | Brevo API Documentation

Returns subscription balances

api-keystring

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

cidstringRequiredformat: "int"

Contact Id

pidstringRequiredformat: "uuid"

Loyalty Program Id

includeInternalbooleanOptional

Include balances tied to internal definitions.

Successful retrieval of contact balance

loyaltyProgramIdstringformat: "uuid"

Unique identifier of the loyalty program.

contactIdlong

Unique identifier of the contact.

balancelist of objects

Aggregate balance per balance definition.

401

Unauthorized Error

403

Forbidden Error

404

Not Found 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.getSubscriptionBalances("cid", "pid", {});
8	}
9	main();

1	{
2	"loyaltyProgramId": "string",
3	"contactId": 1,
4	"balance": [
5	{
6	"balanceDefinitionId": "string",
7	"value": 1.1
8	}
9	]
10	}

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

1	{
2	"loyaltyProgramId": "string",
3	"contactId": 1,
4	"balance": [
5	{
6	"balanceDefinitionId": "string",
7	"value": 1.1
8	}
9	]
10	}