PWpwapps
Domains

Purchase a domain

Changed on

Purchase a domain. Price will be deducted from user's balance (includes commission).

post/api/v1/domains

Request

Request body

domainstring required

Domain name to purchase

Example request

{
  "domain": "example.com"
}

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 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