Price domains and mailboxes before buying: the lines charged now (domain registration, the first month) and every month after, in cents. Returns a quoteId, valid for 30 minutes, that POST /mailbox-orders needs. Charges nothing. Domains no longer available are listed in unavailable. Needs the managed mailboxes feature (403).
A domain entry with existing: true adds mailboxes to a domain the workspace already bought (GET /managed-domains): no domain charge, only the mailboxes, which are usually ready within minutes. Addresses already taken on such a domain are listed in unavailableMailboxes. Refusals: 404 domain-not-owned, 409 domain-full (details.slotsLeft), 409 domain-admin-cancelled (its admin mailbox was cancelled, so it takes no new mailbox). contact is only required when the order registers a new domain.
Authorization
bearerAuth An API key created under Settings → API & Webhooks.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
contact is required when at least one domain is new (registered by this order); an order that only adds mailboxes to bought domains needs none.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/mailbox-orders/quote" \ -H "Content-Type: application/json" \ -d '{ "domains": [ { "name": "string", "mailboxes": [ { "username": "string", "firstName": "string", "lastName": "string" } ] } ] }'{ "data": { "quoteId": "string", "lines": [ { "kind": "string", "label": "string", "quantity": 0, "unitCents": 0, "totalCents": 0, "interval": "string" } ], "dueNowCents": 0, "monthlyCents": 0, "currency": "string", "expiresAt": "2019-08-24T14:15:22Z", "unavailable": [ "string" ], "unavailableMailboxes": [ "string" ] }}List the domains you bought GET
The workspace's bought domains and how many more mailboxes each can take (5 per domain on Google Workspace and Microsoft 365). Add mailboxes to one with a domain entry `{ name, existing: true, mailboxes }` in POST /mailbox-orders/quote. `canAdd: false` says why in `reason`. Not gated on the managed mailboxes feature.
Search domains to buy GET
Domains matching a keyword (or one exact domain), with availability, whether Google Workspace and Microsoft 365 can host each, and the first-year price. Needs the managed mailboxes feature on the workspace (`403`, `code: feature-disabled`).