---
title: "Get business email status"
method: GET
path: "/api/billing/business-email/status"
---

# Get business email status

`GET /api/billing/business-email/status`

## Request

- Base URL: `https://app.base44.com`
- URL: `https://app.base44.com/api/billing/business-email/status`
- Auth: HTTP bearer

<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](/api-reference/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](/api-reference/get-business-email-admin-console-link).
- `EXPIRED`: the subscription has ended. Renew it from [Get business email management link](/api-reference/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.

## Query parameters

- `limit` integer: Entries per page, 1 to 500. Defaults to 500, which fits every entry.
- `cursor` string: `next_cursor` from the previous page. Send it alone.

## Response `200`

The workspace's business email.

- BusinessEmailStatus
  - `items` BusinessEmailMailbox[], required: One entry per domain with business email on this page. With the default `limit`, every one. Empty when the workspace has none.
    - `domain` string, required: Domain the business email is on.
    - `status` 'ACTIVE' | 'PENDING_SETUP' | 'TOS_SUSPENDED' | 'EXPIRED', required: `ACTIVE` when it's working. `PENDING_SETUP` when it's bought but not set up yet. `TOS_SUSPENDED` when the domain's Google admin hasn't accepted Google's terms of service. `EXPIRED` when the subscription is no longer valid.
    - `end_of_period_date` string, nullable, required: When the current billing period ends, as a date-time string, or `null` when the billing provider doesn't report it.
    - `auto_renew_off` boolean, required: `true` when automatic renewal is off, so the subscription ends at `end_of_period_date`. `false` when it renews, or when its renewal setting can't be read.
    - `created_date` string, nullable, required: When the business email was bought, as a date-time string, or `null` when that can't be read.
  - `can_purchase` boolean, required: `true` when the workspace can buy business email. `false` when it has no billing account for business email, or its plan is paid through the App Store.
  - `next_cursor` string, nullable, required: Send as `cursor` to get the next page. `null` on the last page.

## Other responses

- `400`: The workspace's billing account couldn't be reached, so retry later. Also returned when `cursor` is invalid or expired, or was sent with `limit`.
- `401`: Missing or invalid credentials.
- `403`: You aren't the workspace owner, or your token is read-only.
- `422`: Validation Error
- `429`: Rate limit reached. Retry later.

## Changes

> 66 revisions in range; 1 not diffed.

- **2026-10-26** `395a6758864a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/adexad/apis/base44-app-management-api/changes/api/billing/business-email/status/get.md)

---

[API](https://skmtc.dev/adexad/apis/base44-app-management-api.md) - [All operations](https://skmtc.dev/adexad/apis/base44-app-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/adexad/apis/base44-app-management-api/revisions/d877a932dc19?raw)