---
title: "Public payment and prepaid credit discovery."
method: GET
path: "/api/billing"
---

# Public payment and prepaid credit discovery.

`GET /api/billing`

## Request

- Base URL: `https://okfindex.com`
- URL: `https://okfindex.com/api/billing`
- Auth: none declared

Returns: { product, quota{free,paid,how_to_pay,live,free_now?,charged_now?,trial?}, pricing, billing, api_index, payment{provider,mode,network,chain_id,pay_to,homolog,dev,dev_gate,alternavel,gratis?,cobrados?,facilitator,asset,asset_address,faucet,wallets}, credit{url,header} }

## Response `200`

{ product, quota{free,paid,how_to_pay,live,free_now?,charged_now?,trial?}, pricing, billing, api_index, payment{provider,mode,network,chain_id,pay_to,homolog,dev,dev_gate,alternavel,gratis?,cobrados?,facilitator,asset,asset_address,faucet,wallets}, credit{url,header} }

- object
  - `product` string, required: Product name.
  - `quota` PaymentQuota, required
    - `free` PaymentFree[], required: Free allowances and their windows.
      - `o_que` string, required: Operation or allowance.
      - `limite` string, required: Allowance and eligibility.
      - `janela` string, nullable, required: Reset window, when applicable.
    - `paid` PaymentPrice[], required: List prices in USD. The operation's 402 is the payable quote.
      - `o_que` string, required: Operation and billing unit.
      - `price_usd` number, required: Current list price in USD.
    - `how_to_pay` string, required: Payment instructions and availability restrictions.
    - `live` string, nullable, required: Authoritative product quota endpoint.
    - `free_now` string[]: SKUs temporarily free despite their list price.
    - `charged_now` string[]: SKUs charged at their list price even when free_now has `*`.
    - `trial` PaymentTrial
      - `days` integer, required: Trial duration in days.
      - `how` string, required: Eligibility and activation steps.
  - `pricing` string, required: Absolute URL of the current price list.
  - `billing` string, required: Absolute URL of payment discovery or the existing billing summary.
  - `api_index` string, required: Absolute URL of the API catalog.
  - `payment` PaymentX402, required: x402 payment configuration in force. Comes from `planPublic` and is the same across the products.
    - `provider` string, required: Always `x402` — the only billing protocol accepted.
    - `mode` string, required: Seller mode: `live` charges for real, `dev` lets calls through unpaid.
    - `network` string, required: USDC network: `base` in production, `base-sepolia` in staging.
    - `chain_id` integer, required: EVM chain ID of the network above, so the wallet signs on the right chain.
    - `pay_to` string, nullable, required: Address that receives the payment.
    - `homolog` boolean, required: Staging seam on: the loop can be closed without spending USDC.
    - `dev` boolean, required: Development mode: the 402 is simulated.
    - `dev_gate` boolean, required: A homologation credential is configured; this grants no access.
    - `alternavel` boolean, required: Dev only: a request with `X-MM-Pagamento: real` pays for real instead of in test mode.
    - `gratis` string[]: Temporarily free SKUs.
    - `cobrados` string[]: SKUs charged even when `gratis` has `*`.
    - `facilitator` string, required: URL of the facilitator that verifies and settles the payment.
    - `asset` string, required: Accepted currency — always `USDC`.
    - `asset_address` string, required: USDC contract on the network above.
    - `faucet` string, nullable, required: Test-USDC faucet; only on base-sepolia.
    - `wallets` object, required: Links to wallets that speak x402 (metamask, coinbase, base_app).
  - `credit` PaymentCredit, required
    - `url` string, required: POST to purchase credit; GET with X-Credito to inspect its balance.
    - `header` string, required: Header for a previously issued credit token: X-Credito.

## Other responses

- `405`: Use GET or HEAD.

---

[API](https://skmtc.dev/okfindex/apis/okf-index.md) · [All operations](https://skmtc.dev/okfindex/apis/okf-index/llms.txt) · [OpenAPI document](https://skmtc.dev/okfindex/apis/okf-index/revisions/4b13ca3c739f?raw)
