About the Google Subscriptions API

The Google Subscriptions 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 Subscriptions API, your app 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.
• Set up the first administrator of a Google Workspace after it's purchased.
• Retrieve the users of a Google Workspace, by domain or by premium subscription ID.
• Retrieve how much storage a Google Workspace has used out of its pooled quota.
• Evaluate the email recovery state of the account's domains.

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, the methods return empty results rather than errors.

Use cases

• Check whether an account can purchase Business Email for a domain
• Show a Google Workspace's users and storage usage
• Set up the first administrator after a Business Email purchase

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.
• Administrator: A user who manages the Google Workspace, such as its users and settings. Every Google Workspace needs at least 1 administrator.
• 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.