Get Subscription Data | Brevo API Documentation

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.program.getParameterSubscriptionInfo("pid", {});
}
main();

{
  "balance": {
    "balances": [
      {
        "balanceDefinitionId": "string",
        "value": 1.1
      }
    ],
    "contactId": 1,
    "loyaltyProgramId": "string"
  },
  "members": [
    {
      "createdAt": "string",
      "memberContactId": 1,
      "updatedAt": "string"
    }
  ],
  "reward": [
    {
      "code": "string",
      "contactId": 1,
      "createdAt": "string",
      "expirationDate": "string",
      "id": "string",
      "loyaltyProgramId": "string",
      "meta": {},
      "rewardId": "string",
      "updatedAt": "string"
    }
  ],
  "tier": [
    {
      "contactId": 1,
      "createdAt": "string",
      "groupId": "string",
      "loyaltyProgramId": "string",
      "meta": {},
      "tierId": "string",
      "updatedAt": "string"
    }
  ]
}

Get Information of balances, tiers, rewards and subscription members for a subscription

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