Skip to content

Check Domain Availability

POST
/provider-domains/check-availability

Check whether a domain is available to buy, and its price. Spends no credits.

Proxies the same handler the in-app purchase wizard’s first step calls.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Check whether a domain can be bought, and its price. Spends no credits.

object
domain
required

Domain to check, e.g. acme-outreach.com

string
provider

Provisioning path to check availability/price against.

string
default: registrar
Allowed values: registrar managed

Responses

200

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