PWpwapps
Domains

Purchase an available (pre-purchased) domain

Changed on

Purchase an available domain from the pre-purchased domain pool. Uses the bonus balance when quota and funds allow, otherwise the real balance. The response chargedBalance field identifies the balance actually charged. bonusFallbackReason and paymentMessage explain fallback to the real balance. Insufficient real funds return DOMAIN_PURCHASE_INSUFFICIENT_FUNDS with the fallback reason.

post/api/v1/domains/available/purchase

Request

Request body

domainIdinteger required

ID of the available domain to purchase

Example request

{
  "domainId": 1
}

Response

Successful Response

idstring uuid required
domainstring required
statusstring required
pricePaidstring required
chargedBalance'bonus' | 'real' required

Balance actually charged for this purchase: bonus or real.

bonusFallbackReason'bonus_domain_limit_reached' | 'insufficient_bonus_funds' | 'bonus_payment_failed' nullable

Why an available domain was paid from the real balance.

bonusDomainLimitinteger nullable

Deprecated: always null. Domain purchase credits now come from promo codes.

paymentMessagestring nullable

Explanation of fallback to the real balance.

expirationDatestring date-time nullable

Example response

{
  "chargedBalance": "real",
  "domain": "example.com",
  "expirationDate": "2027-02-05T00:00:00Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "pricePaid": 12.49,
  "status": "registered"
}

Changes

  • 2e36b261303fRevision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • 615ebc9bfa17Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status