Skip to main content

pricing

Type Aliases

HandlerCapabilities

HandlerCapabilities = object
Defined in: packages/types/src/pricing.ts:26 Declares what a handler can settle so the middleware can route ResourcePricing entries without calling the handler. Used by both x402 FacilitatorHandler (optional) and MPP MPPMethodHandler (required). schemes is x402-specific — MPP handlers do not use it.

Properties

assets
assets: string[]
Defined in: packages/types/src/pricing.ts:30
networks
networks: string[]
Defined in: packages/types/src/pricing.ts:29
schemes?
optional schemes: string[]
Defined in: packages/types/src/pricing.ts:28 x402-specific. MPP handlers leave this empty or omit it.

ResourcePricing

ResourcePricing = object
Defined in: packages/types/src/pricing.ts:9 Protocol-agnostic pricing configuration for a protected resource. This is the resource server’s statement of “I want X amount of Y asset paid to Z recipient on W network.” It says nothing about x402 schemes, MPP methods, or protocol extras — those are handler output, not middleware input.

Properties

amount
amount: string
Defined in: packages/types/src/pricing.ts:10
asset
asset: string
Defined in: packages/types/src/pricing.ts:11
description?
optional description: string
Defined in: packages/types/src/pricing.ts:14
network
network: string
Defined in: packages/types/src/pricing.ts:13
recipient
recipient: string
Defined in: packages/types/src/pricing.ts:12

Functions

capabilitiesMatch()

capabilitiesMatch(capabilities, criteria): boolean
Defined in: packages/types/src/pricing.ts:53 Returns true when the given network and asset match the capabilities. Empty networks or assets arrays act as wildcards.

Parameters

capabilities
HandlerCapabilities
criteria
asset
string
network
string

Returns

boolean

matchPricingToCapabilities()

matchPricingToCapabilities(capabilities, pricing): ResourcePricing[]
Defined in: packages/types/src/pricing.ts:42 Returns pricing entries whose network and asset match the given capabilities. Empty networks or assets arrays act as wildcards.

Parameters

capabilities
HandlerCapabilities
pricing
ResourcePricing[]

Returns

ResourcePricing[]