Skip to main content
GET
/
checkouts
/
{checkout_id}
/
status
Get checkout status
curl --request GET \
  --url https://api.billing.io/v1/checkouts/{checkout_id}/status \
  --header 'Authorization: Bearer <token>'
{
  "checkout_id": "<string>",
  "tx_hash": "<string>",
  "confirmations": 123,
  "required_confirmations": 123,
  "detected_at": "2023-11-07T05:31:56Z",
  "confirmed_at": "2023-11-07T05:31:56Z",
  "polling_interval_ms": 2000
}
Lightweight status endpoint optimized for polling. Returns status, confirmations, and a polling interval hint. 
curl https://api.billing.io/v1/checkouts/co_a1b2c3d4e5f6a7b8c9d0e1f2/status \
  -H "Authorization: Bearer $BILLING_API_KEY"
Response
{
  "checkout_id": "co_a1b2c3d4e5f6a7b8c9d0e1f2",
  "status": "confirming",
  "tx_hash": "a1b2c3d4...",
  "confirmations": 12,
  "required_confirmations": 19,
  "polling_interval_ms": 2000
}

Authorizations

​
Authorization
string
header
required

Use your secret API key as a Bearer token. Keys are prefixed: sk_live_ (production) or sk_test_ (sandbox).

Path Parameters

​
checkout_id
string
required

The checkout identifier (prefixed co_)

Response

Checkout status

​
checkout_id
string
​
status
enum<string>
  • pending — Waiting for payment
  • detected — Transaction seen on-chain, unconfirmed
  • confirming — Confirmations in progress
  • confirmed — Payment fully confirmed (terminal)
  • expired — Checkout TTL exceeded without payment (terminal)
  • failed — Unrecoverable error (terminal)
Available options:
pending,
detected,
confirming,
confirmed,
expired,
failed
​
tx_hash
string | null
​
confirmations
integer
​
required_confirmations
integer
​
detected_at
string<date-time> | null
​
confirmed_at
string<date-time> | null
​
polling_interval_ms
integer

Suggested polling interval in milliseconds

Example:

2000