> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ResolveBusinessEmailAction # Package: businessEmail # Namespace: GoogleProductEligibility # Method link: https://dev.wix.com/docs/api-reference/account-level/premium/business-email/google-subscription-v1/resolve-business-email-action.md ## Permission Scopes: Read Business Email: SCOPE.ACC-DC-PREMIUM.READ-MAILBOXES ## Introduction Retrieves the Business Email action proposed for a domain owned by the caller's account, and the reason for it. The method doesn't change any data. Each call reads the domain's current state at Google and Wix, so a call can take a few seconds. Call it when the customer acts on a domain, not for every domain on page load. To evaluate several domains at once without a result per domain, call [Observe Email Actions](https://dev.wix.com/docs/api-reference/account-level/premium/business-email/google-subscription-v1/observe-email-actions.md). --- ## REST API ### Schema ``` Method: resolveBusinessEmailAction Description: Retrieves the Business Email action proposed for a domain owned by the caller's account, and the reason for it. The method doesn't change any data. Each call reads the domain's current state at Google and Wix, so a call can take a few seconds. Call it when the customer acts on a domain, not for every domain on page load. To evaluate several domains at once without a result per domain, call [Observe Email Actions](https://dev.wix.com/docs/api-reference/account-level/premium/business-email/google-subscription-v1/observe-email-actions.md). URL: https://www.wixapis.com/google-subscriptions/v1/google-subscriptions/resolve-business-email-action Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: domainName Method parameters: query param name: domainName | type: domainName | description: Domain to evaluate. For example, `my-domain.com`. Must be a domain the caller's account owns. | required: true | validation: format HOSTNAME Return type: ResolveBusinessEmailActionResponse - name: action | type: BusinessEmailAction | description: Proposed Business Email action. - enum: - BUSINESS_EMAIL_ACTION_UNSPECIFIED: Unknown action. - BUSINESS_EMAIL_ACTION_PROCESSING: A payment for the domain's Business Email hasn't completed yet: a purchase that isn't delivered, or a renewal payment that hasn't settled. Don't offer another purchase. `reason` tells you which. - BUSINESS_EMAIL_ACTION_RETRY: Some of the data needed for the decision couldn't be read. Offer the customer a way to try again later, and don't treat the domain as having no Business Email. - BUSINESS_EMAIL_ACTION_UNAVAILABLE: Business Email can't be recovered or purchased for the domain online. Direct the customer to Wix Customer Care. - BUSINESS_EMAIL_ACTION_ACCEPT_GOOGLE_TOS: The customer must accept Google Workspace's terms of service to activate the subscription. No purchase is needed. - BUSINESS_EMAIL_ACTION_RENEW: The subscription is still managed by Wix and can be restored by renewing the Business Email plan. - BUSINESS_EMAIL_ACTION_AUTHORIZE_WIX: The subscription is managed outside Wix. The customer must authorize Wix in Google Admin before the subscription can be transferred to Wix. - BUSINESS_EMAIL_ACTION_TRANSFER_IN: The customer authorized Wix in Google Admin, and the subscription can be transferred to Wix with a Business Email purchase. - BUSINESS_EMAIL_ACTION_MANAGE: No purchase or recovery is needed. Offer the regular Business Email management options. When `reason` is `BUSINESS_EMAIL_ACTION_REASON_SETUP_INCOMPLETE`, send the customer to finish setting up Business Email. - BUSINESS_EMAIL_ACTION_INITIAL_PURCHASE: The domain has no Business Email that can be restored. Offer a new Business Email purchase. - BUSINESS_EMAIL_ACTION_FIX_PAYMENT: The renewal payment failed; the customer must update the payment method or pay the open invoice to restore the same subscription. - BUSINESS_EMAIL_ACTION_TURN_ON_AUTO_RENEW: The plan's auto-renew is off; the customer must turn it back on so the plan renews and the subscription is restored. - name: reason | type: BusinessEmailActionReason | description: Why the action was proposed. - enum: - BUSINESS_EMAIL_ACTION_REASON_UNSPECIFIED: Unknown reason. - BUSINESS_EMAIL_ACTION_REASON_PURCHASE_IN_PROGRESS: A Business Email order for the domain is paid but not delivered yet, and its delivery is still being retried. This covers any purchase: a first purchase, a repurchase or a transfer. - BUSINESS_EMAIL_ACTION_REASON_PURCHASE_NEEDS_ATTENTION: A Business Email order for the domain is paid but still not delivered after its delivery retries ended, so it needs attention before anything else is sold. - BUSINESS_EMAIL_ACTION_REASON_REQUIRED_EVIDENCE_UNAVAILABLE: Data needed for the decision couldn't be read. - BUSINESS_EMAIL_ACTION_REASON_IDENTITY_REQUIRES_REVIEW: The domain's Google identity needs a manual review. - BUSINESS_EMAIL_ACTION_REASON_GOOGLE_TOS_REQUIRED: The customer must accept Google's terms of service. - BUSINESS_EMAIL_ACTION_REASON_RETAINED_SUBSCRIPTION_RENEWABLE: The subscription is still with Wix and can be renewed. - BUSINESS_EMAIL_ACTION_REASON_TRANSFER_AUTHORIZATION_REQUIRED: The customer must authorize Wix before the subscription can be transferred. - BUSINESS_EMAIL_ACTION_REASON_SUPPORTED_TRANSFER_AVAILABLE: The subscription can be transferred to Wix. - BUSINESS_EMAIL_ACTION_REASON_SUBSCRIPTION_HEALTHY: The subscription is working normally. - BUSINESS_EMAIL_ACTION_REASON_GOOGLE_CUSTOMER_ABSENCE_CONFIRMED: Google has no customer for the domain. - BUSINESS_EMAIL_ACTION_REASON_EXISTING_ORGANIZATION_WITHOUT_SUBSCRIPTION: Deprecated: no longer returned. Replaced by `BUSINESS_EMAIL_ACTION_REASON_WIX_CUSTOMER_WITHOUT_SUBSCRIPTION` and `BUSINESS_EMAIL_ACTION_REASON_MANAGED_OUTSIDE_WIX`. - BUSINESS_EMAIL_ACTION_REASON_NO_SUPPORTED_ACTION: No supported action exists for the domain's current state. - BUSINESS_EMAIL_ACTION_REASON_RELEASE_UNRESOLVED: Wix is ending its management of the domain's subscription at Google, and that change isn't finished yet. - BUSINESS_EMAIL_ACTION_REASON_INCONCLUSIVE: The available data doesn't support a decision. - BUSINESS_EMAIL_ACTION_REASON_SETUP_INCOMPLETE: The customer hasn't finished setting up Business Email: Google's terms of service aren't accepted and no seat is licensed yet. - BUSINESS_EMAIL_ACTION_REASON_WIX_CUSTOMER_WITHOUT_SUBSCRIPTION: Wix holds the domain's Google customer, but it has no Business Email subscription. - BUSINESS_EMAIL_ACTION_REASON_MANAGED_OUTSIDE_WIX: The domain's Google organization is managed outside Wix, and has no Business Email subscription that can be transferred to Wix. - BUSINESS_EMAIL_ACTION_REASON_RELEASED_TO_GOOGLE: Wix ended its reseller relationship when the customer's Business Email plan was cancelled (a yearly or two-year plan, or a monthly plan suspended for Google's terms of service), so Google no longer accepts a new Wix subscription for this organization. - BUSINESS_EMAIL_ACTION_REASON_RENEWAL_PAYMENT_FAILED: The Business Email plan is still valid in Wix, but its renewal charge was declined, so the subscription is suspended at Google. - BUSINESS_EMAIL_ACTION_REASON_TEAM_ACCOUNTS_EXIST: Google accounts that use the domain's addresses exist without a verified organization, so Google won't create one for the domain until the customer takes over or removes those accounts. - BUSINESS_EMAIL_ACTION_REASON_RENEWAL_PAYMENT_PENDING: The subscription is suspended at Google while its renewal is still on the way: the renewal was paid with a method that settles later (for example UPI or a bank redirect), or the plan renews automatically and hasn't been charged yet. Google restores the subscription once the renewal is paid. - BUSINESS_EMAIL_ACTION_REASON_SECONDARY_DOMAIN_OF_MANAGED_WORKSPACE: The domain is a secondary domain of another Google Workspace whose primary domain has a valid Business Email plan on the same account, so its mailboxes are managed from that plan. - BUSINESS_EMAIL_ACTION_REASON_SUSPENDED_WITH_AUTO_RENEW_OFF: The Business Email plan is still valid in Wix, but its auto-renew is off, so it isn't renewing and Google suspended the subscription as the plan's period ends. Turning auto-renew back on renews the plan and restores the subscription. - BUSINESS_EMAIL_ACTION_REASON_WORKSPACE_NOT_PURCHASABLE: Wix manages the domain's Google customer, but Google doesn't currently offer it a Google Workspace plan, so a new Business Email subscription would be refused. Possible Errors: HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: DOMAIN_NOT_OWNED_FOR_EMAIL_ACTION | Description: The caller's account doesn't own the domain. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: EMAIL_ACTION_RESOLUTION_UNAVAILABLE | Description: Evaluation isn't available for the caller. HTTP Code: 503 | Status Code: UNAVAILABLE | Application Code: DOMAIN_OWNERSHIP_UNAVAILABLE | Description: The domain's owner couldn't be read. Try again later. ``` ### Examples ### Get the Business Email action for a domain Retrieves the Business Email action proposed for a domain owned by the caller's account, and the reason for it. ```curl curl -X GET \ 'https://www.wixapis.com/google-subscriptions/v1/google-subscriptions/resolve-business-email-action?domainName=my-domain.com' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.premium.googleSubscriptions.resolveBusinessEmailAction(domainName) Description: Retrieves the Business Email action proposed for a domain owned by the caller's account, and the reason for it. The method doesn't change any data. Each call reads the domain's current state at Google and Wix, so a call can take a few seconds. Call it when the customer acts on a domain, not for every domain on page load. To evaluate several domains at once without a result per domain, call [Observe Email Actions](https://dev.wix.com/docs/api-reference/account-level/premium/business-email/google-subscription-v1/observe-email-actions.md). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: domainName Method parameters: param name: domainName | type: string | description: Domain to evaluate. For example, `my-domain.com`. Must be a domain the caller's account owns. | required: true | validation: format HOSTNAME Return type: PROMISE - name: action | type: BusinessEmailAction | description: Proposed Business Email action. - enum: - BUSINESS_EMAIL_ACTION_UNSPECIFIED: Unknown action. - BUSINESS_EMAIL_ACTION_PROCESSING: A payment for the domain's Business Email hasn't completed yet: a purchase that isn't delivered, or a renewal payment that hasn't settled. Don't offer another purchase. `reason` tells you which. - BUSINESS_EMAIL_ACTION_RETRY: Some of the data needed for the decision couldn't be read. Offer the customer a way to try again later, and don't treat the domain as having no Business Email. - BUSINESS_EMAIL_ACTION_UNAVAILABLE: Business Email can't be recovered or purchased for the domain online. Direct the customer to Wix Customer Care. - BUSINESS_EMAIL_ACTION_ACCEPT_GOOGLE_TOS: The customer must accept Google Workspace's terms of service to activate the subscription. No purchase is needed. - BUSINESS_EMAIL_ACTION_RENEW: The subscription is still managed by Wix and can be restored by renewing the Business Email plan. - BUSINESS_EMAIL_ACTION_AUTHORIZE_WIX: The subscription is managed outside Wix. The customer must authorize Wix in Google Admin before the subscription can be transferred to Wix. - BUSINESS_EMAIL_ACTION_TRANSFER_IN: The customer authorized Wix in Google Admin, and the subscription can be transferred to Wix with a Business Email purchase. - BUSINESS_EMAIL_ACTION_MANAGE: No purchase or recovery is needed. Offer the regular Business Email management options. When `reason` is `BUSINESS_EMAIL_ACTION_REASON_SETUP_INCOMPLETE`, send the customer to finish setting up Business Email. - BUSINESS_EMAIL_ACTION_INITIAL_PURCHASE: The domain has no Business Email that can be restored. Offer a new Business Email purchase. - BUSINESS_EMAIL_ACTION_FIX_PAYMENT: The renewal payment failed; the customer must update the payment method or pay the open invoice to restore the same subscription. - BUSINESS_EMAIL_ACTION_TURN_ON_AUTO_RENEW: The plan's auto-renew is off; the customer must turn it back on so the plan renews and the subscription is restored. - name: reason | type: BusinessEmailActionReason | description: Why the action was proposed. - enum: - BUSINESS_EMAIL_ACTION_REASON_UNSPECIFIED: Unknown reason. - BUSINESS_EMAIL_ACTION_REASON_PURCHASE_IN_PROGRESS: A Business Email order for the domain is paid but not delivered yet, and its delivery is still being retried. This covers any purchase: a first purchase, a repurchase or a transfer. - BUSINESS_EMAIL_ACTION_REASON_PURCHASE_NEEDS_ATTENTION: A Business Email order for the domain is paid but still not delivered after its delivery retries ended, so it needs attention before anything else is sold. - BUSINESS_EMAIL_ACTION_REASON_REQUIRED_EVIDENCE_UNAVAILABLE: Data needed for the decision couldn't be read. - BUSINESS_EMAIL_ACTION_REASON_IDENTITY_REQUIRES_REVIEW: The domain's Google identity needs a manual review. - BUSINESS_EMAIL_ACTION_REASON_GOOGLE_TOS_REQUIRED: The customer must accept Google's terms of service. - BUSINESS_EMAIL_ACTION_REASON_RETAINED_SUBSCRIPTION_RENEWABLE: The subscription is still with Wix and can be renewed. - BUSINESS_EMAIL_ACTION_REASON_TRANSFER_AUTHORIZATION_REQUIRED: The customer must authorize Wix before the subscription can be transferred. - BUSINESS_EMAIL_ACTION_REASON_SUPPORTED_TRANSFER_AVAILABLE: The subscription can be transferred to Wix. - BUSINESS_EMAIL_ACTION_REASON_SUBSCRIPTION_HEALTHY: The subscription is working normally. - BUSINESS_EMAIL_ACTION_REASON_GOOGLE_CUSTOMER_ABSENCE_CONFIRMED: Google has no customer for the domain. - BUSINESS_EMAIL_ACTION_REASON_EXISTING_ORGANIZATION_WITHOUT_SUBSCRIPTION: Deprecated: no longer returned. Replaced by `BUSINESS_EMAIL_ACTION_REASON_WIX_CUSTOMER_WITHOUT_SUBSCRIPTION` and `BUSINESS_EMAIL_ACTION_REASON_MANAGED_OUTSIDE_WIX`. - BUSINESS_EMAIL_ACTION_REASON_NO_SUPPORTED_ACTION: No supported action exists for the domain's current state. - BUSINESS_EMAIL_ACTION_REASON_RELEASE_UNRESOLVED: Wix is ending its management of the domain's subscription at Google, and that change isn't finished yet. - BUSINESS_EMAIL_ACTION_REASON_INCONCLUSIVE: The available data doesn't support a decision. - BUSINESS_EMAIL_ACTION_REASON_SETUP_INCOMPLETE: The customer hasn't finished setting up Business Email: Google's terms of service aren't accepted and no seat is licensed yet. - BUSINESS_EMAIL_ACTION_REASON_WIX_CUSTOMER_WITHOUT_SUBSCRIPTION: Wix holds the domain's Google customer, but it has no Business Email subscription. - BUSINESS_EMAIL_ACTION_REASON_MANAGED_OUTSIDE_WIX: The domain's Google organization is managed outside Wix, and has no Business Email subscription that can be transferred to Wix. - BUSINESS_EMAIL_ACTION_REASON_RELEASED_TO_GOOGLE: Wix ended its reseller relationship when the customer's Business Email plan was cancelled (a yearly or two-year plan, or a monthly plan suspended for Google's terms of service), so Google no longer accepts a new Wix subscription for this organization. - BUSINESS_EMAIL_ACTION_REASON_RENEWAL_PAYMENT_FAILED: The Business Email plan is still valid in Wix, but its renewal charge was declined, so the subscription is suspended at Google. - BUSINESS_EMAIL_ACTION_REASON_TEAM_ACCOUNTS_EXIST: Google accounts that use the domain's addresses exist without a verified organization, so Google won't create one for the domain until the customer takes over or removes those accounts. - BUSINESS_EMAIL_ACTION_REASON_RENEWAL_PAYMENT_PENDING: The subscription is suspended at Google while its renewal is still on the way: the renewal was paid with a method that settles later (for example UPI or a bank redirect), or the plan renews automatically and hasn't been charged yet. Google restores the subscription once the renewal is paid. - BUSINESS_EMAIL_ACTION_REASON_SECONDARY_DOMAIN_OF_MANAGED_WORKSPACE: The domain is a secondary domain of another Google Workspace whose primary domain has a valid Business Email plan on the same account, so its mailboxes are managed from that plan. - BUSINESS_EMAIL_ACTION_REASON_SUSPENDED_WITH_AUTO_RENEW_OFF: The Business Email plan is still valid in Wix, but its auto-renew is off, so it isn't renewing and Google suspended the subscription as the plan's period ends. Turning auto-renew back on renews the plan and restores the subscription. - BUSINESS_EMAIL_ACTION_REASON_WORKSPACE_NOT_PURCHASABLE: Wix manages the domain's Google customer, but Google doesn't currently offer it a Google Workspace plan, so a new Business Email subscription would be refused. Possible Errors: HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: DOMAIN_NOT_OWNED_FOR_EMAIL_ACTION | Description: The caller's account doesn't own the domain. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: EMAIL_ACTION_RESOLUTION_UNAVAILABLE | Description: Evaluation isn't available for the caller. HTTP Code: 503 | Status Code: UNAVAILABLE | Application Code: DOMAIN_OWNERSHIP_UNAVAILABLE | Description: The domain's owner couldn't be read. Try again later. ``` ### Examples ### Get the Business Email action for a domain Retrieves the Business Email action proposed for a domain owned by the caller's account, and the reason for it. ```javascript import { googleSubscriptions } from "@wix/premium"; async function resolveBusinessEmailAction() { const response = await googleSubscriptions.resolveBusinessEmailAction("my-domain.com"); } /* Promise resolves to: * { * "action": "BUSINESS_EMAIL_ACTION_RENEW", * "reason": "BUSINESS_EMAIL_ACTION_REASON_RETAINED_SUBSCRIPTION_RENEWABLE" * } */ ``` ### resolveBusinessEmailAction (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { googleSubscriptions } from '@wix/premium'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { googleSubscriptions }, // Include the auth strategy and host as relevant }); async function resolveBusinessEmailAction(domainName) { const response = await myWixClient.googleSubscriptions.resolveBusinessEmailAction(domainName); }; ``` ---