Pre-launch API docs

Allowance API docs

Give agents spending power through enforceable permissions. Create a mandate, let the human approve once, then request single-use payment credentials within strict limits.

OpenAPI spec Status JSON Partner with us
Base URL: api.useallowance.com/v1 Auth: X-Allowance-Key Stage: pre-launch
API

Core endpoints

All money amounts are integers in minor units (cents for USD). Current behavior is pre-launch stubs returning 501 Not Implemented.

Pre-launch: This API surface is documented now for integration planning. Full schema details live in openapi.json.
POST/v1/mandates

Propose a spending mandate. New mandates begin in pending_approval.

GET/v1/mandates/{id}

Retrieve mandate status and budget state. Poll until status becomes active.

POST/v1/mandates/{id}/credential-requests

Request a single-use virtual card. Validation is automatic against mandate rules.

GET/v1/mandates/{id}/credential-requests/{cr_id}

Retrieve credential request result and validation reasons (approved, denied, expired).

POST/v1/mandates/{id}/revoke

Revoke a mandate immediately. Future credential requests are denied.

GET/v1/status and /v1/pricing

Status and pricing metadata. Mirrors website resources at /status.json and /pricing.json.

Discovery

Machine-readable resources

No auth required for these static resources. Useful for capability discovery, system checks, and examples.

/openapi.json

OpenAPI 3.1 specification for requests, responses, schemas, and auth.

/status.json

Machine-readable system status and pre-launch notes.

/pricing.json

Pre-launch pricing object with placeholders and plan metadata.

/llms.txt

Compact instructions and API overview for LLM/agent ingestion.

Schemas

Core objects

Key data models used across mandate creation, validation, and virtual card issuance.

AllowanceBudget

Permission limits and scope (cadence, amount caps, merchants, MCCs, expiry).

AllowanceMandate

Approved permission object with lifecycle status and risk controls.

CredentialRequest

Purchase-time request against an active mandate with validation output.

ValidationResult

Constraint-level pass/fail checks and human-readable reasons.

VirtualCard

Single-use PAN/CVV payload with amount cap, merchant lock, and short expiry.

Error

Standard error envelope with code, message, and optional documentation URL.

Examples

Worked flows

End-to-end JSON examples for common consumer scenarios.

Flight booking

Single-use mandate under $500, merchant locked, expires after use.

Open example →

Recurring household reorder

Monthly recurring budget for a single merchant and MCC.

Open example →

Subscription renewals

Monthly recurring with open merchant list and MCC-based controls.

Open example →

Building an agent that needs payments?

Tell us what you're building and we'll share pre-launch integration details.

Partner with us →