Skip to content
Hardcount
Run it locally
Pre-1.0 · one maintainer · Stripe and cards only · no SDKs (client libraries) yet · no production users yet. Docs describe v0.9.1 (29 Oct 2026) · What’s new →

API endpoints

Hardcount Billing API 2026-04-07

Section titled “Hardcount Billing API 2026-04-07”

Open-source usage-based billing engine. Handles pricing, subscriptions, usage metering, invoice generation, Stripe payments, dunning, and credits.

Information

  • License: MIT
  • OpenAPI version: 3.0.3

Operations

Section titled “Operations”
GET
/v1/customers
POST
/v1/customers
POST
/v1/customers/{id}/rotate-cost-dashboard-token
GET
/v1/customers/{id}
PATCH
/v1/customers/{id}
GET
/v1/customers/{id}/billing-profile
PUT
/v1/customers/{id}/billing-profile
GET
/v1/customers/{id}/sent-emails
GET
/v1/customers/{id}/usage
GET
/v1/customers/{customer_id}/overview
GET
/v1/customers/{customer_id}/payment-methods
POST
/v1/customers/{customer_id}/payment-methods/send-setup-email
POST
/v1/customers/{customer_id}/payment-methods/setup-session
DELETE
/v1/customers/{customer_id}/payment-methods/{pmID}
POST
/v1/customers/{customer_id}/payment-methods/{pmID}/default
GET
/v1/exports/customers.csv
GET
/v1/meters
POST
/v1/meters
GET
/v1/meters/{id}
PATCH
/v1/meters/{id}
GET
/v1/plans
POST
/v1/plans
GET
/v1/plans/{id}
PATCH
/v1/plans/{id}
GET
/v1/plans/{id}/prices
POST
/v1/plans/{id}/prices
DELETE
/v1/plans/{id}/prices/{price_id}
PATCH
/v1/plans/{id}/prices/{price_id}
GET
/v1/price-overrides
POST
/v1/price-overrides
DELETE
/v1/price-overrides/{id}
GET
/v1/subscriptions
POST
/v1/subscriptions
POST
/v1/subscriptions/{id}/activate
POST
/v1/subscriptions/{id}/retry-billing
GET
/v1/subscriptions/{id}
POST
/v1/subscriptions/{id}/cancel
POST
/v1/subscriptions/{id}/schedule-cancel
DELETE
/v1/subscriptions/{id}/scheduled-cancel
PUT
/v1/subscriptions/{id}/pause-collection
DELETE
/v1/subscriptions/{id}/pause-collection
POST
/v1/subscriptions/{id}/end-trial
POST
/v1/subscriptions/{id}/extend-trial
PUT
/v1/subscriptions/{id}/billing-thresholds
DELETE
/v1/subscriptions/{id}/billing-thresholds
POST
/v1/subscriptions/{id}/items
DELETE
/v1/subscriptions/{id}/items/{itemID}
PATCH
/v1/subscriptions/{id}/items/{itemID}
DELETE
/v1/subscriptions/{id}/items/{itemID}/pending-change
GET
/v1/subscriptions/{id}/timeline
GET
/v1/exports/subscriptions.csv
GET
/v1/usage-events
POST
/v1/usage-events
POST
/v1/usage-events/batch
POST
/v1/usage-events/backfill
GET
/v1/usage-events/held
POST
/v1/usage-events/held/release
POST
/v1/usage-events/held/discard
GET
/v1/usage-events/aggregate
GET
/v1/exports/usage-events.csv
POST
/v1/integrations/litellm/spend
GET
/v1/invoices
POST
/v1/invoices
POST
/v1/invoices/create_preview
GET
/v1/invoices/{id}
GET
/v1/invoices/{id}/pdf
POST
/v1/invoices/{id}/send
POST
/v1/invoices/{id}/line-items
POST
/v1/invoices/{id}/void
POST
/v1/invoices/{id}/resend-setup-link
POST
/v1/invoices/{id}/mark-uncollectible
POST
/v1/invoices/{id}/record-payment
POST
/v1/invoices/{id}/rotate-public-token
POST
/v1/invoices/{id}/collect
POST
/v1/invoices/{id}/refund
GET
/v1/invoices/{id}/payment-timeline
GET
/v1/invoices/{id}/disputes
POST
/v1/invoices/{id}/finalize
POST
/v1/invoices/{id}/retry-tax
GET
/v1/exports/invoices.csv
GET
/v1/credit-notes
POST
/v1/credit-notes
GET
/v1/credit-notes/stats
POST
/v1/credit-notes/{id}/send
GET
/v1/credit-notes/{id}
POST
/v1/credit-notes/{id}/issue
POST
/v1/credit-notes/{id}/retry-refund
POST
/v1/credit-notes/{id}/void
GET
/v1/credit-notes/{id}/pdf
GET
/v1/credits/grants/{customer_id}
POST
/v1/credits/adjust
GET
/v1/credits/balances
GET
/v1/credits/ledger/{customer_id}
POST
/v1/credits/grant
GET
/v1/credits/balance/{customer_id}
GET
/v1/credits/balance/{customer_id}/live
POST
/v1/billing/run
GET
/v1/analytics/overview
GET
/v1/analytics/revenue-chart
GET
/v1/analytics/mrr-movement
GET
/v1/analytics/usage
GET
/v1/dunning/runs
GET
/v1/dunning/runs/{id}
POST
/v1/dunning/runs/{id}/resolve
GET
/v1/dunning/stats
GET
/v1/dunning/policies
POST
/v1/dunning/policies
GET
/v1/dunning/policies/{id}
DELETE
/v1/dunning/policies/{id}
PATCH
/v1/dunning/policies/{id}
POST
/v1/dunning/policies/{id}/set-default
GET
/v1/webhook-endpoints/endpoints
POST
/v1/webhook-endpoints/endpoints
GET
/v1/webhook-endpoints/endpoints/{id}
DELETE
/v1/webhook-endpoints/endpoints/{id}
PATCH
/v1/webhook-endpoints/endpoints/{id}
POST
/v1/webhook-endpoints/endpoints/{id}/rotate-secret
GET
/v1/webhook-endpoints/endpoints/{id}/deliveries
POST
/v1/webhook-endpoints/endpoints/{id}/deliveries/{deliveryID}/replay
GET
/v1/webhook-endpoints/endpoints/stats
GET
/v1/webhook-endpoints/events
GET
/v1/webhook_events/{id}/deliveries
POST
/v1/webhook_events/{id}/replay
GET
/v1/webhook_events/stream
POST
/v1/webhooks/stripe/{endpoint_id}
POST
/v1/webhooks/postmark
POST
/v1/auth/login
POST
/v1/auth/logout
POST
/v1/auth/mode
POST
/v1/auth/password-reset/request
POST
/v1/auth/password-reset/confirm
GET
/v1/auth/password-reset/check
GET
/v1/whoami
GET
/v1/api-keys
POST
/v1/api-keys
DELETE
/v1/api-keys/{id}
POST
/v1/api-keys/{id}/rotate
GET
/v1/auth/invite/{token}
POST
/v1/auth/accept-invite
GET
/v1/members
POST
/v1/members/invite
DELETE
/v1/members/invitations/{id}
DELETE
/v1/members/{userID}
GET
/v1/provider-costs
PUT
/v1/provider-costs
DELETE
/v1/provider-costs/{id}
GET
/v1/customers/{id}/margin
GET
/v1/test-clocks
POST
/v1/test-clocks
GET
/v1/test-clocks/{id}
DELETE
/v1/test-clocks/{id}
GET
/v1/test-clocks/{id}/subscriptions
POST
/v1/test-clocks/{id}/advance
POST
/v1/test-clocks/{id}/retry-advance
GET
/v1/test-clocks/{id}/customers
GET
/v1/recipes
GET
/v1/recipes/instances
GET
/v1/recipes/{key}
POST
/v1/recipes/{key}/preview
POST
/v1/recipes/{key}/instantiate
GET
/v1/public/cost-dashboard/{token}
GET
/v1/public/invoices/{token}
GET
/v1/public/invoices/{token}/pdf
POST
/v1/public/invoices/{token}/checkout
GET
/v1/public/payment-updates/{token}
POST
/v1/public/payment-updates/{token}/checkout
GET
/health
GET
/health/ready
GET
/metrics
GET
/v1/exports/audit-log.csv
GET
/v1/settings
PUT
/v1/settings
GET
/v1/settings/email
POST
/v1/settings/email/test
GET
/v1/settings/stripe
POST
/v1/settings/stripe
PATCH
/v1/settings/stripe/{mode}/webhook
DELETE
/v1/settings/stripe/{mode}
GET
/v1/tenants
POST
/v1/tenants
GET
/v1/tenants/{id}
POST
/v1/bootstrap
GET
/v1/audit-log
GET
/v1/audit-log/filters

Authentication

Section titled “Authentication”

BearerAuth

Section titled “BearerAuth”

API key authentication. Use Authorization: Bearer hc_secret_... Key types: hc_platform_ (tenant mgmt), hc_secret_ (full access)

Security scheme type: http

SessionCookie

Section titled “SessionCookie”

Dashboard session cookie, set by POST /v1/auth/login. Routes under /v1 (except /v1/tenants) accept it in place of a Bearer key. Operations that list only this scheme (members, mode switch, logout) do not accept an API key.

Security scheme type: apiKey

Cookie parameter name: hardcount_session

MetricsToken

Section titled “MetricsToken”

The value of the METRICS_TOKEN setting, sent as Authorization: Bearer <token>. Used only by GET /metrics. It is not an API key.

Security scheme type: http

PostmarkBasicAuth

Section titled “PostmarkBasicAuth”

HTTP Basic auth with POSTMARK_WEBHOOK_USER and POSTMARK_WEBHOOK_PASS. You put both in the webhook URL you give Postmark. Used only by POST /v1/webhooks/postmark.

Security scheme type: http