<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Lists the business email on your workspace, one entry per domain, and tells you whether you can buy more. Business email is a Google Workspace subscription on one of your workspace's custom domains, billed to the workspace.

Each entry's status tells you what to do next:

• PENDING_SETUP: finish setting it up with Get business email setup link.
• TOS_SUSPENDED: the domain's Google admin has to accept Google's terms of service. Get them a sign-in link with Get business email admin console link.
• EXPIRED: the subscription has ended. Renew it from Get business email management link.

Only the workspace owner can call this endpoint. A workspace with no billing account for business email gets an empty items list and can_purchase: false, whoever calls. A read-only token is refused, and workspace API keys aren't accepted. Limited to 30 requests a minute per caller. Some workspaces have a different limit.

Entries come in the order the billing provider lists them, and the default limit of 500 returns every one on one page. To page through them, pass a smaller limit and send each next_cursor back as cursor. A cursor carries the rest of the query, so send it alone.

{
  "items": [
    {
      "auto_renew_off": false,
      "created_date": "2026-03-14T09:21:07Z",
      "domain": "acme.com",
      "end_of_period_date": "2027-03-14T00:00:00Z",
      "status": "ACTIVE"
    }
  ],
  "can_purchase": true,
  "next_cursor": "gAAAAABn7vJ0q2kX"
}