Create subscription balances | Brevo API Documentation

Creates a balance for a contact

api-keystring

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

pidstringRequiredformat: "uuid"

Loyalty Program Id

cidstringRequiredformat: "uuid"

Contact Id

Create Balance Payload

balanceDefinitionIdstringRequired

Unique identifier (UUID) of the balance definition associated with the new balance.

Successful creation of balance

idstringformat: "uuid"

Unique identifier for the balance.

amountdouble

The current amount available in the balance.

loyaltyProgramIdstringformat: "uuid"

Loyalty program ID.

organizationIdlong

Organization ID.

contactIdlong

Contact ID.

balanceDefinitionIdstringformat: "uuid"

Balance definition ID.

createdAtdatetime

Timestamp of when the balance was created.

expiresAtdatetime

Expiration timestamp of the balance.

consumedAtdatetime

Timestamp of when the balance was last consumed.

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.createSubscriptionBalances("pid", "cid", {
8	balanceDefinitionId: "string",
9	});
10	}
11	main();

1	{
2	"id": "string",
3	"amount": 1.1,
4	"loyaltyProgramId": "string",
5	"organizationId": 1,
6	"contactId": 1,
7	"balanceDefinitionId": "string",
8	"createdAt": "2024-01-15T09:30:00Z",
9	"expiresAt": "2024-01-15T09:30:00Z",
10	"consumedAt": "2024-01-15T09:30:00Z"
11	}