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

amountdouble

The current amount available in the balance

balanceDefinitionIdstring

balance definition ID

consumedAtstring

Timestamp of when the balance was last consumed

contactIdinteger

contact ID

createdAtstring

Timestamp of when the balance was created

expiresAtstring

Expiration timestamp of the balance

idstring

Unique identifier for the balance

loyaltyProgramIdstring

loyalty program ID

organizationIdinteger

organization ID

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	"amount": 1.1,
3	"balanceDefinitionId": "string",
4	"consumedAt": "string",
5	"contactId": 1,
6	"createdAt": "string",
7	"expiresAt": "string",
8	"id": "string",
9	"loyaltyProgramId": "string",
10	"organizationId": 1
11	}