---
title: "What the plan allows, and whether a checkout is outstanding"
method: GET
path: "/v1/billing/checkout"
tags: ["Billing"]
---

# What the plan allows, and whether a checkout is outstanding

`GET /v1/billing/checkout`

## Request

- Base URL: `https://dnsmint.com/api`
- URL: `https://dnsmint.com/api/v1/billing/checkout`
- Auth: `apiKey` (a scheme the document does not define)

The read half of the checkout. Reports and never acts, so a caller can wait on it instead of retrying a mint to find out whether a payment link was completed.

## Response `200`

The account's plan, its usage, and any outstanding checkout.

- BillingStatus
  - `plan` object, required
    - `active` boolean: Whether a subscription is active.
    - `name` string: The plan's display name.
  - `hostnames` object, required
    - `active` integer
    - `cap` integer
  - `domains` object, required
    - `held` integer
    - `cap` integer
  - `pending_checkout` object, nullable: Present only while a checkout has been started and no plan is active.
    - `started_at` string, date-time

## Other responses

- `401`: The Authorization header is missing, malformed, or the key is unknown or revoked.
- `403`: The key does not carry `hostnames:read`.

---

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