---
title: "Read the Paid customer-owned hostname"
method: GET
path: "/v1/projects/{project_id}/paid-domain"
---

# Read the Paid customer-owned hostname

`GET /v1/projects/{project_id}/paid-domain`

## Request

- Base URL: `https://app.ohmyho.st`
- URL: `https://app.ohmyho.st/v1/projects/{project_id}/paid-domain`
- Auth: HTTP bearer

## Path parameters

- `project_id` string, required

## Headers

- `X-Request-Id` string

## Response `200`

Current credential-free hostname, CNAME and certificate state.

- PaidDomain: awaiting_deployment means the requested hostname is declared but not provisioned. Its hostname is present, suspension_reason, custom_hostname_status, ssl_status and url are null, and validation_records is empty. Authorize Cloudflare, deploy to Prod, then repeat the same apply.
  - `status` 'not_configured' | 'awaiting_deployment' | 'pending' | 'active' | 'reconciliation_required' | 'deleted' | 'suspended', required
  - `suspension_reason` 'paid_plan_required' | 'insufficient_organization_credits' | 'project_budget_exceeded' | 'null', nullable, required: Non-null only while suspended by the same Paid, credit-grace or stop-budget policy used by the gateway. DNS/TLS receipts remain intact; url is null while suspended.
  - `hostname` string, nullable, required
  - `environment` 'prod', required
  - `cname_target` 'customers.omh.st' | 'customers.ohmyho.st', required
  - `custom_hostname_status` string, nullable, required
  - `ssl_status` string, nullable, required
  - `validation_records` object[], required
    - `type` 'CNAME' | 'TXT', required
    - `name` string, required
    - `content` string, required
    - `purpose` 'traffic' | 'ownership' | 'ssl' | 'dcv_delegation', required
  - `url` string, uri, nullable, required

## Other responses

- `400`: The request failed.
- `401`: The request failed.
- `403`: The request failed.
- `404`: The resource does not exist or is not visible to the authenticated principal.
- `429`: The request failed.
- `503`: The request failed.

---

[API](https://skmtc.dev/ohmyho/apis/ohmyho-st-api.md) · [All operations](https://skmtc.dev/ohmyho/apis/ohmyho-st-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ohmyho/apis/ohmyho-st-api/revisions/d069888c0017?raw)