Account Details API: Sample Flows

This article presents a possible use case and corresponding sample flow that you can support. It provides a useful starting point as you plan your implementation.

Check account eligibility before sending a campaign

Before publishing an email marketing campaign, you can verify that the site's account is active and has sufficient email quota remaining. This prevents attempting to publish a campaign that would fail due to an inactive account or an exhausted quota.

To check account eligibility before sending a campaign:

1. Call Get Account Details to retrieve the current account status and quota.
2. Check the accountDetails.status field. If the value is not ACTIVE, inform the site owner that they must visit the Wix Email Marketing dashboard to resolve the account issue before campaigns can be sent.
3. Check accountDetails.quotaPeriod.quotaUsage.emails against accountDetails.package.monthlyQuotaAllocation.emails to determine how many emails remain in the current billing period. If the remaining quota is less than the expected campaign audience size, inform the site owner that the quota is insufficient.
4. If the account is ACTIVE and quota is sufficient, proceed to Publish the campaign.