About the Google Subscription API

The Google Subscription API lets you work with the Google Workspace products a Wix account purchases for its domains, such as Business Email. You can check whether an account can purchase a product for a domain before sending it to checkout, and read information about the Google Workspace on a domain the account owns.

With the Google Subscription API, you can:

• Check whether an account can purchase Business Email, Google Workspace, or the Google Voice add-on for a domain, and how many seats it can purchase.
• Find out why an account can't purchase a product for a domain, such as the domain already having a Business Email package.
• Retrieve the users of the Google Workspace on a domain.
• Retrieve how much storage a Google Workspace has used out of its pooled quota.
• Find out what to offer a customer whose Business Email expired or stopped working, such as a renewal, a payment fix, or a transfer to Wix.
• Evaluate the email recovery state of the account's domains.

To set up a Google Workspace's first administrator after purchase, or to list its users by its premium subscription ID, use the Google User API.

Before you begin

It's important to note the following points before starting to code:

• This is an account-level API. Call it with an account-level API key, on behalf of the account that owns the domains.
• Methods that read a domain's Google Workspace work only for domains the calling account owns.
• An eligibility check doesn't reserve anything. Eligibility can change between the check and the purchase, for example if another Business Email package is added to the domain.
• Storage usage comes from a usage report that Google publishes once a day, so it trails live usage by about a day.
• Storage usage and email recovery evaluation aren't available for every caller. When they aren't available, Get Storage Usage and Observe Email Actions return empty results rather than errors.
• Resolve Business Email Action reads the domain's current state at Google and Wix on every call, so a call can take a few seconds. Call it when the customer acts, not for every domain on page load. Its answer is a proposal: it doesn't purchase or change anything.

Use cases

• Check whether an account can purchase Business Email for a domain
• Show a Google Workspace's users and storage usage
• Offer the right next step for an expired Business Email

Terminology

• Google Workspace: Google's suite of business apps, including Gmail, Google Drive, and Google Calendar, set up on a domain.
• Business Email: Wix's Google Workspace product. It gives a domain professional email addresses, such as jane@my-domain.com.
• Seat: A licensed user account in a Google Workspace subscription. The number of seats is the number of users the subscription can have.
• Pooled storage quota: The storage a Google Workspace's users share. It's the edition's storage allowance per seat multiplied by the number of licensed seats.
• Repurchase: Buying back a subscription that Wix suspended.
• Transfer: Moving a subscription back to Wix after it was transferred out to another Google reseller.