---
title: "Whether the caller has signed up for billing"
method: GET
path: "/api/v1/me/billing"
tags: ["Me"]
---

# Whether the caller has signed up for billing

`GET /api/v1/me/billing`

## Request

- Base URL: `https://entire.io` (the document declares no server; this is the origin it was published from)
- URL: `https://entire.io/api/v1/me/billing`
- Auth: none declared

## Query parameters

- `refresh` 'payment_method' | 'card'

## Response `200`

Billing state

- object
  - `state` 'not_started' | 'pending_card' | 'provisioning' | 'active', required
  - `currency` string
  - `trial` object
    - `state` 'not_started' | 'active' | 'used_up' | 'expired' | 'withheld' | 'awaiting_card', required: awaiting_card: a saved card unlocks the trial. Clients ignore unknown values.
    - `credit_total_cents` integer: Size of the trial credit. When awaiting_card, the amount a card unlocks.
    - `credit_remaining_cents` integer
    - `credit_expired_cents` integer: Trial credit that expired unspent. Present only when expired.
    - `expires_at` string: When the trial credit ends. Omitted when not_started or withheld.
    - `currency` 'usd', required
  - `balance` object
    - `currency` 'usd', required
    - `granted_cents` integer, required
    - `purchased_cents` integer, required
    - `total_cents` integer, required
    - `trial_cents` integer, required
    - `next_expiry` object: The purchased, top-up or granted credit that ends first. Omitted when none.
      - `amount_cents` integer, required: Credit that expires at expires_at unless spent.
      - `credit_remaining_cents` integer, required: All purchased, top-up and granted credit left.
      - `expires_at` string, required
  - `overage` object
    - `currency` 'usd', required
    - `amount_cents` integer, required
  - `runs_paused` object
    - `paused` boolean, required
    - `reason` 'credit_exhausted' | 'over_limit' | 'blocked'
  - `automatic_top_up` object
    - `currency` 'usd', required
    - `enabled` boolean, required
    - `last_charge_failed` boolean
    - `target_cents` integer, required
    - `threshold_cents` integer, required
  - `card` object
    - `brand` string, required
    - `exp_month` integer, required
    - `exp_year` integer, required
    - `last4` string, required
  - `payment_method` object
    - `type` string, required
    - `bank_name` string
    - `brand` string
    - `email` string
    - `exp_month` integer
    - `exp_year` integer
    - `last4` string
  - `unavailable` string[]: Sections that could not be read now and are omitted. Read again later.

## Other responses

- `400`: Invalid request
- `401`: Not authenticated
- `403`: Access denied
- `404`: Resource not found
- `409`: Resource conflict
- `412`: Precondition failed
- `422`: Validation failed
- `429`: Too many requests
- `502`: Entire Core request failed
- `503`: Entire Core is unavailable. Type "billing-not-configured" means billing is not configured.

## Changes

- **2026-10-30** `a78c48de157d`: 1 warning
  - added the new `awaiting_card` enum value to the `trial/state` response property for the response status `200`
- **2026-10-25** `f4a534501f84`: 1 warning, 1 info
  - removed the optional property `failed_first_purchase` from the response with the `200` status
  - removed the `failed_first_purchase` enum value from the `unavailable/items/` response property for the response status `200`
- **2026-10-25** `e8893f80c9f2`: 2 info
  - added the new enum value `payment_method` to the `query` request parameter `refresh`
  - added the optional property `payment_method` to the response with the `200` status
- **2026-10-23** `b63e814eb760`: 1 warning, 3 info
  - added the new `expired` enum value to the `trial/state` response property for the response status `200`
  - added the optional property `balance/next_expiry` to the response with the `200` status
  - added the optional property `trial/credit_expired_cents` to the response with the `200` status
  - added the optional property `trial/expires_at` to the response with the `200` status
- **2026-10-22** `a2154aa7933d`: 1 warning
  - added the new `withheld` enum value to the `trial/state` response property for the response status `200`

[Operation history](https://skmtc.dev/entire/apis/entire-api/changes/api/v1/me/billing/get.md)

---

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