Get the details of requested master account

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

{
  "billingInfo": {
    "address": {
      "countryCode": "IN",
      "locality": "Pandav Nagar, New Delhi",
      "postalCode": "560048",
      "stateCode": "UP",
      "streetAddress": "C-92"
    },
    "companyName": "Corp Sample 1-1",
    "email": "sample@example.com",
    "name": {
      "familyName": "Pandit",
      "givenName": "Uday"
    }
  },
  "companyName": "Corp Sample 1-1",
  "currencyCode": "INR",
  "email": "sample@example.com",
  "id": 1003286,
  "planInfo": {
    "currencyCode": "INR",
    "features": [
      {
        "name": "MULTI_USER",
        "quantity": 10,
        "remaining": 0,
        "unitValue": "1",
        "used": 15
      },
      {
        "name": "ADVANCED_REPORTING",
        "quantity": 12,
        "remaining": 11,
        "unitValue": "1",
        "used": 1
      },
      {
        "name": "INBOX",
        "quantity": 10,
        "remaining": 0,
        "unitValue": "1",
        "used": 10
      },
      {
        "name": "LANDING_PAGE",
        "quantity": 10,
        "remaining": 0,
        "unitValue": "5",
        "used": 11
      },
      {
        "name": "RECURRING_CREDITS",
        "quantity": 500,
        "remaining": 499,
        "unitValue": "1",
        "used": 1
      }
    ],
    "nextBillingAt": 1637739295,
    "planPeriod": "month",
    "price": 2100,
    "subAccounts": 15
  },
  "timezone": "Europe/Paris"
}

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

{
  "billingInfo": {
    "address": {
      "countryCode": "IN",
      "locality": "Pandav Nagar, New Delhi",
      "postalCode": "560048",
      "stateCode": "UP",
      "streetAddress": "C-92"
    },
    "companyName": "Corp Sample 1-1",
    "email": "sample@example.com",
    "name": {
      "familyName": "Pandit",
      "givenName": "Uday"
    }
  },
  "companyName": "Corp Sample 1-1",
  "currencyCode": "INR",
  "email": "sample@example.com",
  "id": 1003286,
  "planInfo": {
    "currencyCode": "INR",
    "features": [
      {
        "name": "MULTI_USER",
        "quantity": 10,
        "remaining": 0,
        "unitValue": "1",
        "used": 15
      },
      {
        "name": "ADVANCED_REPORTING",
        "quantity": 12,
        "remaining": 11,
        "unitValue": "1",
        "used": 1
      },
      {
        "name": "INBOX",
        "quantity": 10,
        "remaining": 0,
        "unitValue": "1",
        "used": 10
      },
      {
        "name": "LANDING_PAGE",
        "quantity": 10,
        "remaining": 0,
        "unitValue": "5",
        "used": 11
      },
      {
        "name": "RECURRING_CREDITS",
        "quantity": 500,
        "remaining": 499,
        "unitValue": "1",
        "used": 1
      }
    ],
    "nextBillingAt": 1637739295,
    "planPeriod": "month",
    "price": 2100,
    "subAccounts": 15
  },
  "timezone": "Europe/Paris"
}

This endpoint will provide the details of the master account.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Response

Master account details

billingInfoobject

Billing details of the master account organization

companyNamestring

Company name of master account organization

currencyCodestring

Currency code of the master account organization

emailstring

Email id of master account

idlong

Unique identifier of the master account organization

planInfoobject

Plan details

timezonestring

Timezone of the master account organization

Errors

400

Bad Request 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.masterAccount.getTheDetailsOfRequestedMasterAccount();
8	}
9	main();

1	{
2	"billingInfo": {
3	"address": {
4	"countryCode": "IN",
5	"locality": "Pandav Nagar, New Delhi",
6	"postalCode": "560048",
7	"stateCode": "UP",
8	"streetAddress": "C-92"
9	},
10	"companyName": "Corp Sample 1-1",
11	"email": "sample@example.com",
12	"name": {
13	"familyName": "Pandit",
14	"givenName": "Uday"
15	}
16	},
17	"companyName": "Corp Sample 1-1",
18	"currencyCode": "INR",
19	"email": "sample@example.com",
20	"id": 1003286,
21	"planInfo": {
22	"currencyCode": "INR",
23	"features": [
24	{
25	"name": "MULTI_USER",
26	"quantity": 10,
27	"remaining": 0,
28	"unitValue": "1",
29	"used": 15
30	},
31	{
32	"name": "ADVANCED_REPORTING",
33	"quantity": 12,
34	"remaining": 11,
35	"unitValue": "1",
36	"used": 1
37	},
38	{
39	"name": "INBOX",
40	"quantity": 10,
41	"remaining": 0,
42	"unitValue": "1",
43	"used": 10
44	},
45	{
46	"name": "LANDING_PAGE",
47	"quantity": 10,
48	"remaining": 0,
49	"unitValue": "5",
50	"used": 11
51	},
52	{
53	"name": "RECURRING_CREDITS",
54	"quantity": 500,
55	"remaining": 499,
56	"unitValue": "1",
57	"used": 1
58	}
59	],
60	"nextBillingAt": 1637739295,
61	"planPeriod": "month",
62	"price": 2100,
63	"subAccounts": 15
64	},
65	"timezone": "Europe/Paris"
66	}