---
title: "Get a domain order"
method: GET
path: "/v1/registrar/orders/{orderId}"
tags: ["domains-registrar"]
---

# Get a domain order

`GET /v1/registrar/orders/{orderId}`

## Request

- Base URL: `https://api.vercel.com`
- URL: `https://api.vercel.com/v1/registrar/orders/{orderId}`
- Auth: HTTP bearer

Get information about a domain order by its ID

## Path parameters

- `orderId` string, required: A valid order ID

## Query parameters

- `teamId` string

## Response `200`

Success

- object
  - `orderId` string, required: A valid order ID
  - `domains` union[], required
    - union
      - object
        - `purchaseType` 'purchase', required
        - `autoRenew` boolean, required
        - `years` number, required: The number of years the domain is being purchased for.
        - `domainName` string, required: A valid domain name
        - `status` 'pending' | 'completed' | 'failed' | 'refunded' | 'refund-failed', required
        - `price` number, required
        - `error` union
          - object
            - `code` 'unsupported-language-code', required
            - `details` object, required
              - …
          - object
            - `code` 'incorrect-language-code', required
            - `details` object, required
              - …
          - object
            - `code` 'client-transfer-prohibited', required
          - object
            - `code` 'incorrect-auth-code', required
          - object
            - `code` 'claims-notice-required', required
          - object
            - `code` 'cannot-transfer-in-until', required
            - `details` object, required
              - …
          - object
            - `code` 'account-transfer-required', required
          - object
            - `code` 'price-change', required
          - object
            - `code` 'unavailable-legal', required
          - object
            - `code` 'invalid-contact', required
            - `details` object, required
              - …
          - object
            - `code` string, required
            - `details` unknown
      - object
        - `purchaseType` 'renewal', required
        - `years` number, required: The number of years the domain is being renewed for.
        - `domainName` string, required: A valid domain name
        - `status` 'pending' | 'completed' | 'failed' | 'refunded' | 'refund-failed', required
        - `price` number, required
        - `error` union
          - object
            - `code` 'unsupported-language-code', required
            - `details` object, required
              - …
          - object
            - `code` 'incorrect-language-code', required
            - `details` object, required
              - …
          - object
            - `code` 'client-transfer-prohibited', required
          - object
            - `code` 'incorrect-auth-code', required
          - object
            - `code` 'claims-notice-required', required
          - object
            - `code` 'cannot-transfer-in-until', required
            - `details` object, required
              - …
          - object
            - `code` 'account-transfer-required', required
          - object
            - `code` 'price-change', required
          - object
            - `code` 'unavailable-legal', required
          - object
            - `code` 'invalid-contact', required
            - `details` object, required
              - …
          - object
            - `code` string, required
            - `details` unknown
      - object
        - `purchaseType` 'transfer', required
        - `autoRenew` boolean, required
        - `years` number, required: The number of years the domain is being transferred for.
        - `domainName` string, required: A valid domain name
        - `status` 'pending' | 'completed' | 'failed' | 'refunded' | 'refund-failed', required
        - `price` number, required
        - `error` union
          - object
            - `code` 'unsupported-language-code', required
            - `details` object, required
              - …
          - object
            - `code` 'incorrect-language-code', required
            - `details` object, required
              - …
          - object
            - `code` 'client-transfer-prohibited', required
          - object
            - `code` 'incorrect-auth-code', required
          - object
            - `code` 'claims-notice-required', required
          - object
            - `code` 'cannot-transfer-in-until', required
            - `details` object, required
              - …
          - object
            - `code` 'account-transfer-required', required
          - object
            - `code` 'price-change', required
          - object
            - `code` 'unavailable-legal', required
          - object
            - `code` 'invalid-contact', required
            - `details` object, required
              - …
          - object
            - `code` string, required
            - `details` unknown
  - `status` 'draft' | 'purchasing' | 'completed' | 'failed', required
  - `error` union
    - object
      - `code` 'payment-failed', required
    - object
      - `code` 'tld-outage', required
      - `details` object, required
        - `tlds` object[], required
          - `tldName` string, required
          - `endsAt` string, required
    - object
      - `code` 'price-mismatch', required
      - `details` object, required
        - `expectedPrice` number, required
        - `actualPrice` number
    - object
      - `code` 'unexpected-error', required
    - object
      - `code` 'claims-required', required
      - `details` object, required
        - `message` string, required
        - `domainNames` string[], required
    - object
      - `code` 'domain-mismatch', required
    - object
      - `code` string, required
      - `details` unknown

## Other responses

- `400`: There was something wrong with the request
- `401`: Unauthorized
- `403`: NotAuthorizedForScope
- `404`: NotFound
- `429`: TooManyRequests
- `500`: InternalServerError

## Changes

- **2026-07-14** `314022afff45`: 1 info
  - added the optional property `reason` to the response with the `401` status
- **2026-06-11** `14b4658f819e`: 2 info
  - added `subschema #1, subschema #2, subschema #3` to the `domains/items/` response property `anyOf` list for the response status `200`
  - removed `subschema #1, subschema #2, subschema #3` from the `domains/items/` response property `anyOf` list for the response status `200`
- **2026-02-10** `486a07653d6e`: 2 info
  - added `subschema #1, subschema #2, subschema #3` to the `domains/items/` response property `anyOf` list for the response status `200`
  - removed `subschema #1, subschema #2, subschema #3` from the `domains/items/` response property `anyOf` list for the response status `200`
- **2026-01-22** `c12186034433`: 4 info
  - added `subschema #1, subschema #2` to the `error` response property `anyOf` list for the response status `200`
  - added `subschema #1, subschema #2, subschema #3` to the `domains/items/` response property `anyOf` list for the response status `200`
  - removed `subschema #1, subschema #2` from the `error` response property `anyOf` list for the response status `200`
  - removed `subschema #1, subschema #2, subschema #3` from the `domains/items/` response property `anyOf` list for the response status `200`
- …earlier changes not shown

[Operation history](https://skmtc.dev/vercel/apis/vercel-api/changes/v1/registrar/orders/:orderId/get.md)

---

[API](https://skmtc.dev/vercel/apis/vercel-api.md) - [All operations](https://skmtc.dev/vercel/apis/vercel-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vercel/apis/vercel-api/revisions/60686c0e1f6a?raw)