Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 14.6 KB

getdomaintransferresponsebody.md

File metadata and controls

23 lines (18 loc) · 14.6 KB

GetDomainTransferResponseBody

Example Usage

import { GetDomainTransferResponseBody } from "@vercel/sdk/models/getdomaintransferop.js";

let value: GetDomainTransferResponseBody = {
  transferable: false,
  transferPolicy: "not-supported",
  reason: "<value>",
  status: "completed",
};

Fields

Field Type Required Description
transferable boolean ✔️ Whether or not the domain is transferable
transferPolicy models.TransferPolicy ✔️ The domain's transfer policy (depends on TLD requirements). charge-and-renew: transfer will charge for renewal and will renew the existing domain's registration. no-charge-no-change: transfer will have no change to registration period and does not require charge. no-change: transfer charge is required, but no change in registration period. new-term: transfer charge is required and a new registry term is set based on the transfer date. not-supported: transfers are not supported for this domain or TLD. null: This TLD is not supported by Vercel's Registrar.
reason string ✔️ Description associated with transferable state.
status models.GetDomainTransferStatus ✔️ The current state of an ongoing transfer. pending_owner: Awaiting approval by domain's admin contact (every transfer begins with this status). If approval is not given within five days, the transfer is cancelled. pending_admin: Waiting for approval by Vercel Registrar admin. pending_registry: Awaiting registry approval (the transfer completes after 7 days unless it is declined by the current registrar). completed: The transfer completed successfully. cancelled: The transfer was cancelled. undef: No transfer exists for this domain. unknown: This TLD is not supported by Vercel's Registrar.