Get Custom Domain

GET

/api/:account_id/custom-domains/:external_id

Get a specific custom domain by its ID.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

external_idstringRequired

account_idstringRequired

Successful Response

idstring

Unique custom domain identifier

domainstring

The custom domain (hostname)

statusenum

Verification lifecycle status

Allowed values:

cname_targetstring

The host the merchant must point a CNAME record at

created_atdatetime

When the custom domain was registered

updated_atdatetime

When the custom domain was last updated

last_checked_atdatetime or nullOptional

When the DNS verification was last attempted

verified_atdatetime or nullOptional

When the domain's CNAME was first verified

error_messagestring or nullOptional

Last verification error, if any

dns_auth_cnameobject or nullOptional

Second CNAME record to add for certificate issuance; present once certificate provisioning has started

certificate_provisioningbooleanOptionalDefaults to false

True while the domain is verified and its certificate is being provisioned (derived presentation state)

422

Unprocessable Entity Error