Get tier group | Brevo API Documentation

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

{
  "createdAt": "2024-01-15T09:30:00Z",
  "downgradeStrategy": "real_time",
  "id": "string",
  "loyaltyProgramId": "string",
  "name": "string",
  "tierOrder": [],
  "updatedAt": "2024-01-15T09:30:00Z",
  "upgradeStrategy": "real_time",
  "upgradeSchedule": {
    "strategy": "string",
    "durationValue": 1,
    "durationUnit": "day",
    "durationModifier": "start_of_period",
    "scheduledDate": "string"
  },
  "downgradeSchedule": {
    "strategy": "string",
    "durationValue": 1,
    "durationUnit": "day",
    "durationModifier": "start_of_period",
    "scheduledDate": "string"
  }
}

Returns tier group information.

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

gidstringRequiredformat: "uuid"

Tier group ID

Query parameters

versionenumOptionalDefaults to draft

Select active to retrieve active version of tier group. Select draft to retrieve latest changes in tier group.

Allowed values:

Response

Tier group information successfully retrieved

createdAtdatetime

Timestamp when the tier group was created

downgradeStrategyenumDefaults to real_time

Select real_time to downgrade tier on real time balance updates. Select membership_anniversary to downgrade tier on subscription anniversary. Select tier_anniversary to downgrade tier on tier anniversary.

Allowed values:

idstringformat: "uuid"

Tier group unique identifier

loyaltyProgramIdstringformat: "uuid"

Associated loyalty program Id

namestring

Tier group name

tierOrderlist of strings

Order of the tiers in the group in ascending order

updatedAtdatetime

Timestamp when the tier group was last updated

upgradeStrategyenumDefaults to real_time

Select real_time to upgrade tier on real time balance updates. Select membership_anniversary to upgrade tier on subscription anniversary. Select tier_anniversary to upgrade tier on tier anniversary.

Allowed values:

upgradeScheduleobject

Schedule configuration for tier upgrades.

downgradeScheduleobject

Schedule configuration for tier downgrades.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error