Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

Retrieves email marketing account details.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { accountDetails } from '@wix/email-marketing';

const wixClient = createClient({
  modules: { accountDetails },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function getAccountDetails() {
  const response = await wixClient.accountDetails.getAccountDetails();
}

getAccountDetails() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { accountDetails } from '@wix/email-marketing';

const wixClient = createClient({
  modules: { accountDetails },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function getAccountDetails() {
  const response = await wixClient.accountDetails.getAccountDetails();
}

getAccountDetails() with Dashboard app access

getAccountDetails

GetAccountDetailsResponse

---
title: Introduction
---

# About Account Details


The Account Details API provides functionality for managing your email marketing account information. 

Use the API to [get your current account details](email-marketing/account-details/get-account-details). 



To use the AccountDetails API, install the `@wix/email-marketing` package using npm or Yarn:
  ```console
npm install @wix/email-marketing
```

or

```console
yarn add @wix/email-marketing
```

Then import `{ accountDetails }` from `@wix/email-marketing`:

```js
import { accountDetails } from '@wix/email-marketing'
```
  

email-marketing_account-details

AccountDetails

package

Package

quotaPeriod

QuotaPeriod

Account status. One of:
+ `'ACTIVE'`
+ `'WARNED'`
+ `'SUSPENDED'`
+ `'BANNED'`

status

Enum

accountDetails

string

group

monthlyQuotaAllocation

Quota

Number of allocated marketing campaigns per month (-1 means unlimited).

campaigns

number

Number of allocated individual emails per month.

emails

dateFrom

Current quota period end date - after which quota will roll over.

dateTo

Information about allocated quota already used in this period.

About Account Details

Setup

Permission Scopes