For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterAPI KeysStatusSign In
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Introduction
    • Getting started
  • Email API
  • Transactional SMS
  • Transactional WhatsApp
  • Marketing Campaigns
  • Contact Management
  • Events
    • GETGet events
    • POSTCreate an event
    • POSTCreate events in batch
  • Object Management
  • Accounts and Settings
  • Sales CRM
  • Conversations
  • Ecommerce
  • Loyalty
      • GETGet loyalty program list
      • POSTCreate loyalty program
      • GETGet loyalty program Info
      • PUTUpdate loyalty program
      • PATCHPartially update loyalty program
      • DELDelete Loyalty Program
      • POSTPublish loyalty program
      • POSTCreate subscription
      • POSTCreate subscription member
      • DELDelete subscription member
      • DELDelete subscription
      • GETGet Subscription Data
LogoLogo
Help CenterAPI KeysStatusSign In
LoyaltyProgram

Get Subscription Data

GET
https://api.brevo.com/v3/loyalty/config/programs/:pid/account-info
GET
/v3/loyalty/config/programs/:pid/account-info
1import { BrevoClient } from "@getbrevo/brevo";
2
3async function main() {
4    const client = new BrevoClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.program.getParameterSubscriptionInfo("pid", {});
8}
9main();
1{
2  "balance": {
3    "balances": [
4      {
5        "balanceDefinitionId": "string",
6        "value": 1.1
7      }
8    ],
9    "contactId": 1,
10    "loyaltyProgramId": "string"
11  },
12  "members": [
13    {
14      "createdAt": "string",
15      "memberContactId": 1,
16      "updatedAt": "string"
17    }
18  ],
19  "reward": [
20    {
21      "code": "string",
22      "contactId": 1,
23      "createdAt": "string",
24      "expirationDate": "string",
25      "id": "string",
26      "loyaltyProgramId": "string",
27      "meta": {},
28      "rewardId": "string",
29      "updatedAt": "2024-01-15T09:30:00Z",
30      "validFrom": "2024-01-15T09:30:00Z"
31    }
32  ],
33  "tier": [
34    {
35      "contactId": 1,
36      "createdAt": "string",
37      "groupId": "string",
38      "loyaltyProgramId": "string",
39      "meta": {},
40      "tierId": "string",
41      "updatedAt": "string"
42    }
43  ]
44}
Get Information of balances, tiers, rewards and subscription members for a subscription
Was this page helpful?
Previous

Get code count

Next
Built with

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. A unique identifier for the loyalty program.

Query parameters

contactIdstringOptional
The contact ID to filter by.
paramsstringOptional
A list of filter parameters for querying the subscription info.
loyaltySubscriptionIdstringOptional
The loyalty subscription ID to filter by.
includeInternalbooleanOptional
Include balances tied to internal definitions.

Response

Successfully retrieved subscription info.
balanceobject
Balance details for the subscription.
memberslist of objects
List of members associated with the subscription.
rewardlist of objects
List of rewards associated with the subscription.
tierlist of objects
List of tier assignments for the subscription.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error