Authorization
bearerAuth An API key created under Settings → API & Webhooks.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/mailbox-orders/string"{ "data": { "id": "string", "status": "quoted", "delayed": true, "statusLabel": "string", "createdVia": "app", "warmup": { "enabled": true, "strategy": { "preset": "conservative", "startingVolume": 1, "dailyIncrease": 1, "targetVolume": 1, "replyInbox": [ 0, 0 ], "replyPromotions": [ 0, 0 ], "replySpam": 0 } }, "domains": [ { "name": "string", "existing": true, "platform": "google", "years": 0, "redirectUrl": "string", "status": "pending", "refusedReason": "string", "mailboxes": [ { "email": "string", "firstName": "string", "lastName": "string", "step": "ordered", "accountId": "string", "connectedAt": "2019-08-24T14:15:22Z" } ] } ], "totals": { "totalCents": 0, "currency": "string" }, "completedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}What you pay for bought mailboxes GET
Bought mailboxes and domains are billed apart from the plan, each purchase on its own date and monthly from then on. This returns the monthly total and next charge date, the card charged, each purchase (mailboxes, price, status, a `payUrl` when a payment failed, the last receipt) and each domain's renewal (date, price or an estimate, status, `payUrl` when declined). Same data as Billing → Mailboxes & domains in the app. `403` with `code: not-allowed` unless the key's creator may manage billing. Not gated on the managed mailboxes feature.
List mailbox orders GET
The workspace's orders, newest first, each with its domains and mailboxes and the step each mailbox is at.