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 or null

The current amount available in the balance

balanceDefinitionIdstring or null

balance definition ID

consumedAtstring or null

Timestamp of when the balance was last consumed

contactIdinteger or null

contact ID

createdAtstring or null

Timestamp of when the balance was created

expiresAtstring or null

Expiration timestamp of the balance

idstring or null

Unique identifier for the balance

loyaltyProgramIdstring or null

loyalty program ID

organizationIdinteger or null

organization ID

1	import requests
2
3	url = "https://api.brevo.com/v3/loyalty/balance/programs/pid/subscriptions/cid/balances"
4
5	payload = { "balanceDefinitionId": "string" }
6	headers = {
7	"api-key": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

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	}