Skip to main content

Crate atp_client

Crate atp_client 

Source
Expand description

ATP integration SDK for Rust applications.

The crate deliberately has no dependency on ATP’s AWS/backend implementation. Enable the default axum feature for ready-made billing endpoints and guards; use default-features = false for the framework-neutral client and claims API.

Re-exports§

pub use axum_integration::AuthenticatedBillingUser;
pub use axum_integration::BillingContext;
pub use axum_integration::BillingPrincipal;
pub use axum_integration::BillingRouter;
pub use axum_integration::BillingUserResolver;
pub use axum_integration::ExtensionBillingUserResolver;
pub use axum_integration::require_credits;
pub use axum_integration::require_tier;

Modules§

axum_integration
Ready-made Axum routes, authenticated-principal adapters, request context, and guards.

Structs§

ApiErrorBody
ATP’s stable JSON error envelope.
AtpClaims
Stable, namespaced billing facts to embed under the atp JWT claim.
AtpClient
Cloneable, async client for ATP’s tenant-facing HTTP API.
AtpClientBuilder
Builder for AtpClient transport and retry behavior.
Balance
Current balances for a user, including an optional team contribution.
BillingCache
Bounded, process-local store for recent per-user billing status.
BillingCacheConfig
Bounds status-cache freshness, memory use, and outage behavior.
BillingSnapshot
Billing status plus cache/fallback provenance needed for safe decisions.
BillingStatus
Entitlement and balance facts returned by the consolidated status endpoint.
CachedBillingClient
ATP client wrapper that caches status lookups but never caches writes.
CheckoutInput
Browser-safe Checkout input for crate::BillingRouter.
CheckoutRequest
Server-to-server Checkout request including authenticated user identity.
CheckoutResponse
Newly created Stripe Checkout session.
ClaimsEnricher
Enriches an application’s existing claims object before its normal JWT signer runs.
DebitRequest
Request to atomically consume credits for a business operation.
DebitResult
Result of a debit or refund, broken down by original credit source.
LedgerEntry
Immutable ledger fact describing one balance change.
PortalInput
Browser-safe Customer Portal input for crate::BillingRouter.
PortalResponse
Newly created Stripe Customer Portal session.
RefundRequest
Request to reverse one previously completed debit.
TierPolicy
Ordered tier hierarchy used by Axum’s minimum-tier guard.

Enums§

FailureMode
Determines how a status lookup behaves when ATP cannot be reached.
Purchase
Product a user intends to buy through Stripe Checkout.
SdkError
Errors produced by client configuration, transport, or the ATP API.
SnapshotSource
Provenance of the status held by a BillingSnapshot.

Traits§

BillingProvider
Framework-neutral source of a per-user billing snapshot.
ClaimsTarget
Implement this for the claims object your existing authentication flow already signs. The SDK never verifies, rewrites, or signs JWTs itself.

Type Aliases§

SdkResult
Result alias used by all SDK operations.