Skip to content

Checkout Purchase Mailboxes

POST
/provider-domains/{domain_id}/checkout-mailboxes

Buy one or more mailboxes on a domain. SPENDS REAL CREDITS — unrestricted, same as the app; there is no per-key spend cap.

Send an Idempotency-Key header to make a retry safe. Returns 402 if the credit hold can’t clear, 422 if the org’s plan can’t fund a purchase at all, 400 for an unconnected/wrong-platform domain, too many mailboxes, or a missing username, 404 if domain_id doesn’t belong to this org.

Authorizations

Parameters

Path Parameters

domain_id
required

Provider domain ID (provider_domains.id) — from GET /provider-domains

integer

Provider domain ID (provider_domains.id) — from GET /provider-domains

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Buy one or more mailboxes on an already-purchased/connected domain. Spends real credits — see the 402 contract on the route docstring.

object
enable_warmup

Enroll each mailbox in warmup immediately after purchase

boolean
default: true
mailboxes
required

Mailboxes to create. Up to 5 per domain for a provider=‘managed’ purchase, and up to 250 per request.

Array<object>
<= 250 items

One mailbox to create. Supply username for a managed purchase (provider='managed') or a full email for registrar/pilot.

object
email
Any of:
string
first_name
Any of:
string
last_name
Any of:
string
password
Any of:
string
username
Any of:
string
platform
Any of:
string
Allowed values: GOOGLE MICROSOFT
provider
string
default: registrar
Allowed values: registrar managed pilot
warmup_engine
Any of:
string
Allowed values: instantly smartlead managed
warmup_settings
Any of:
object
key
additional properties
any

Responses

202

Successful Response

object
data
required
object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string