Valqio Docs

Integrate Valqio with your product

Model product work, publish an environment, call Valqio from server-side code, and inspect the decision evidence.

Valqio gives product code a runtime for plans, product access, usage, credits, limits, reservations, and customer-specific terms. Choose product work your application currently decides or counts itself and connect it to the relevant rule.

  1. Model the product work. Name the action and connect it to the plan, feature, meter, credit balance, quota, or capacity rule behind it.
  2. Publish the environment. Version the state the hosted runtime should serve.
  3. Call Valqio from server-side code. Send the customer, quantity, request identity, and idempotency key where the action happens.
  4. Inspect the evidence. Follow the decision, state change, retry, reservation, or settlement in Console.

Start the quickstart or review the Node.js SDK guide.

Private preview: @valqio/sdk-node and @valqio/cli are not currently published on the public npm registry. Request package access from Valqio before following an install command.

Choose the operation that matches the work

Product needOperationWhat changes
Check feature access or a configured valueEvaluateReturns access or configuration without counting usage.
Check and count immediate usageEnforceDecides and applies the usage mutation before work starts.
Hold value during uncertain workReserve, then commit or releaseHolds value before work and settles it after the outcome is known.
Count completed workCounter or other meter mutationUpdates counter, identity-set, or gauge state.
Protect temporary capacityAcquire and release a leaseHolds a concurrency slot until the work finishes or expires.
Record a non-enforcing product eventCaptureStores evidence without making an allow or deny decision.

Use runtime decisions to understand the request boundary, then choose the detailed guide for the operation you need.

Get started

  • Quickstart: check access, enforce usage, and inspect the resulting evidence.
  • Hosted setup: configure Console, runtime URL, server key, project, and environment.
  • Node.js SDK: create the low-level runtime client in a route, worker, or service.
  • Generated client: call typed action helpers generated from the controls you published.

Model the product

Handle production behavior

Operate and explain

  • Workbench: exercise runtime controls and inspect their decision shapes.
  • Inspect evidence: trace the customer, request, decision, and consequence.
  • Runtime Activity: inspect usage mutations, reservations, settlements, and retries.
  • Billing sync: move explainable usage and evidence to the billing system downstream.

Reference

Billing boundary

Billing systems create invoices, collect payment, and keep commercial records. Valqio models product access and usage, decides what the application should allow, manages the usage transaction lifecycle, and records the evidence that explains downstream billing input.

On this page