Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

Retrieves email marketing account details.

import { accountDetails } from "wix-email-marketing.v2";

export async function myGetAccountDetailsFunction() {
  try {
    const results = await accountDetails.getAccountDetails();

    console.log('Success! Retrieved results:', results);
    return results;
  } catch (error) {
    console.error(error);
  }
}

/* Promise resolves to:
 * {
 *    "accountDetails": {
 *      "status": "ACTIVE",
 *      "package": {
 *        "_id": "EmailMarketing_Professional",
 *        "group": "EmailMarketing",
 *        "monthlyQuotaAllocation": {
 *          "campaigns": -1,
 *          "emails": 5000
 *        }
 *      },
 *      "quotaPeriod": {
 *        "dateFrom": "2023-08-10T15:57:10.000Z",
 *        "dateTo": "2023-09-10T15:57:10.000Z",
 *        "quotaUsage": {
 *          "campaigns": 4,
 *          "emails": 2
 *        }
 *      }
 *    }
 * }
 */

Get email marketing account details (dashboard page code)

import { Permissions, webMethod } from 'wix-web-module';
import { accountDetails } from 'wix-email-marketing.v2';

export const myGetAccountDetailsFunction = webMethod(Permissions.Anyone, async () => {
  try {
    const results = await accountDetails.getAccountDetails();

    console.log('Success! Retrieved results:', results);
    return results;
  } catch (error) {
    console.error(error);
  }
});

/* Promise resolves to:
 * {
 *   "accountDetails": {
 *     "status": "ACTIVE",
 *     "package": {
 *       "_id": "EmailMarketing_Professional",
 *       "group": "EmailMarketing",
 *       "monthlyQuotaAllocation": {
 *         "campaigns": -1,
 *         "emails": 5000
 *       }
 *     },
 *     "quotaPeriod": {
 *       "dateFrom": "2023-08-10T15:57:10.000Z",
 *       "dateTo": "2023-09-10T15:57:10.000Z",
 *       "quotaUsage": {
 *         "campaigns": 4,
 *         "emails": 2
 *       }
 *     }
 *   }
 * }
 */


Get email marketing account details (export from backend code)

getAccountDetails

GetAccountDetailsResponse

---
title: Introduction
---

# Introduction

<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
    <b>Developer Preview</b>
    <br/>
    <span>APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production.<br/><a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.</span>
</div>


&nbsp;
> **Note:** This module is [universal](/api-overview/api-versions#universal-modules). Functions in this module can run on both the backend and frontend, unless specified otherwise. 


The Account Details API provides functionality for managing your email marketing account information. Use the API to [get your current account details](/account-details/get-account-details). 


To use the Account Details API, import `accountDetails` from the `wix-email-marketing.v2` module:

```js
import { accountDetails } from 'wix-email-marketing.v2';
```


velo-deps_wix-email-marketing.v2_account-details

AccountDetails

package

Package

quotaPeriod

QuotaPeriod

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

status

Enum

Action

ComplianceDetails

note

string

supportTicketId

suspensionReasons

Features

multipleSenderDetails

boolean

removeWixBranding

scheduling

accountDetails

GetComplianceDetailsResponse

complianceDetails

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.

quotaUsage

RespondOptions

supportTicketData

SupportTicketData

RespondResponse

ID of the support ticket created (optional).

agentReplyBody

body

subject

getAccountDetails( )

Permission Scopes