Skip to content
SAPA
Guides
Docs
API Reference
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Guide
Start here
Installation
Quickstart
Next steps
Docs
Overview
Concepts
Mental model
Architecture
Domain glossary
Offers and purchases
Exact money
Idempotency
Workflows
Checkout
Payments and refunds
Subscriptions
Metered billing
Seats
Prepaid credits
Downloads
Licensing
Access
Recipes
Overview
Register offers
Create checkout
Handle errors
Ebook download
SaaS subscription
Tiered SaaS
Metered API
Team seats
Subscription license
Perpetual license
Prepaid credits
Desktop bundle
External fulfillment
Integrations
Runtime composition
JSON and HTTP
Payment providers
Testing
Use cases
Overview
SaaS subscriptions
Desktop software
Usage-based API
Digital products
Deployment
Overview
Self-hosting
Cloudflare reference
Configuration and secrets
Operations and recovery
Errors and boundaries
API Reference
Interfaces
SapaCapabilityLayers
Type Aliases
AcceptSubscriptionPlanChange
Access
AccessDuration
AccessExpiryError
AccessExplanation
AccessQuery
AccessQueryError
ActivateLicenseCredential
AssignSeatCommand
AuthorizeDownload
Billing
BillingOnly
BillingTerms
CatalogSeedError
CheckoutCommand
CheckoutCreateError
CheckoutCreateResult
CheckoutCustomer
CheckoutFailure
CheckoutGetError
CheckoutRecoveryError
CheckoutView
CorrectMeteredUsage
CreditAccountQuery
CreditBalance
CreditQueryError
CreditReservationCommand
CreditReservationError
CreditReservationResult
Credits
CreditTransaction
DeactivateLicenseCredential
DownloadAuthorization
DownloadAuthorizationError
DownloadEmails
Downloads
DurableOfferRegistrationError
EnrollPostpaidSubscription
FinalizeMeteredInvoice
FixedAccessDuration
Fulfillment
InstalledOfferCapabilities
IssueLicenseCredential
LateUsageAdjustment
LicenseCredentialActivationAcceptance
LicenseCredentialActivationError
LicenseCredentialDeactivationAcceptance
LicenseCredentialDeactivationError
LicenseCredentialIssuance
LicenseCredentialIssuanceError
LicenseCredentialRevocationAcceptance
LicenseCredentialRevocationError
LicenseCredentialRotationAcceptance
LicenseCredentialRotationError
LicenseCredentialValidation
LicenseCredentialValidationError
Licensing
LicensingConfiguration
Limits
Managed
MerchantAccessPolicy
Meter
MeteredInvoiceCollectionError
MeteredInvoiceCollectionResult
MeteredInvoiceError
MeteredInvoiceResult
MeteredLine
MeteredLineError
MeteredUsageError
MeteredUsageResult
OfferCapabilities
OfferCompatibilityError
OfferDefinitionError
OfferInstallationError
OfferQuantityError
OfferRegistrationError
OfferTerms
OneTimeBilling
PaymentNotificationCommand
PaymentNotificationError
PaymentNotificationResult
PostpaidAccessPolicy
PostpaidEnrollmentError
PostpaidEnrollmentResult
Price
Product
ProductCatalog
PurchasePartiesError
RecordMeteredUsage
RecurringBilling
RegisteredOffers
ReserveCreditsCommand
ResolvedPurchaseParties
RevokeLicenseCredential
RotateLicenseCredential
SapaOperation
ScheduleSubscriptionPlanChangeCommand
ScheduleSubscriptionPlanChangeError
ScheduleSubscriptionPlanChangeResult
SeatAssignmentAccessQuery
SeatAssignmentAccessResult
SeatAssignmentError
SeatAssignmentResult
SeatPriceQuote
SeatPriceQuoteError
SeatPricing
Seats
SelectedOfferTerms
SubscriptionPlanChangeAcceptanceError
SubscriptionPlanChangeError
SubscriptionPlanChangeQuote
SubscriptionTermsSelection
Tier
TierFulfillment
UnassignSeatCommand
ValidateLicenseCredential
Variables
AcceptSubscriptionPlanChange
Access
AccessBenefit
AccessDuration
AccessExpiryError
AccessExplanation
AccessQuery
AccessQueryError
ActivateLicenseCredential
activateLicenseCredential
assignSeat
AssignSeatCommand
AuthorizeDownload
authorizeDownload
BenefitDefinition
Billing
BillingOnly
BillingTerms
calculateFixedAccessExpiry
CatalogCheckout
CatalogSeedError
checkAccess
checkOfferInstallation
CheckoutBeneficiary
CheckoutCommand
CheckoutCommandJson
CheckoutCreateError
CheckoutCreateResult
CheckoutCustomer
CheckoutFailure
CheckoutFailureDetails
CheckoutGetError
CheckoutRecoveryError
CheckoutView
checkSeatAssignmentAccess
consumeCredits
correctMeteredUsage
CorrectMeteredUsage
createCheckout
CreditAccountQuery
CreditBalance
CreditBenefit
CreditQueryError
CreditReservationCommand
CreditReservationError
CreditReservationResult
Credits
CreditTransaction
DeactivateLicenseCredential
deactivateLicenseCredential
DownloadAssetReference
DownloadAuthorization
DownloadAuthorizationError
DownloadBenefit
DownloadEmailBenefit
DownloadEmails
Downloads
DurableOfferRegistrationError
effectClockLayer
EnrollPostpaidSubscription
enrollPostpaidSubscription
explainAccess
FinalizeMeteredInvoice
finalizeMeteredInvoice
FixedAccessDuration
FixedAccessExpiryInput
Fulfillment
FulfillmentBenefit
FulfillmentBindingReference
getCheckout
getCreditBalance
getCreditHistory
getMeteredInvoiceCollection
InstalledOfferCapabilities
InvoiceCheckout
IssueLicenseCredential
issueLicenseCredential
LateUsageAdjustment
LicenseCredentialActivationAcceptance
LicenseCredentialActivationError
LicenseCredentialDeactivationAcceptance
LicenseCredentialDeactivationError
LicenseCredentialIssuance
LicenseCredentialIssuanceError
LicenseCredentialRevocationAcceptance
LicenseCredentialRevocationError
LicenseCredentialRotationAcceptance
LicenseCredentialRotationError
LicenseCredentialValidation
LicenseCredentialValidationError
Licensing
LicensingBenefit
LicensingConfiguration
Limits
Managed
MerchantAccessPolicy
Meter
MeteredInvoiceCollectionError
MeteredInvoiceCollectionResult
MeteredInvoiceError
MeteredInvoiceResult
MeteredLine
MeteredLineError
MeteredLineInput
MeteredUsageError
MeteredUsageResult
Offer
OfferCapabilities
OfferCheckout
OfferCompatibilityError
OfferDeclaration
OfferDefinitionError
OfferInstallationError
OfferQuantityError
OfferQuantityInput
OfferRegistrationError
OfferSnapshotJson
OfferTerms
OneTimeBilling
parseSelectedOfferSnapshot
PaymentNotificationCommand
PaymentNotificationError
PaymentNotificationResult
PostpaidAccessPolicies
PostpaidAccessPolicy
PostpaidEnrollmentError
PostpaidEnrollmentResult
Price
processPaymentNotification
Product
ProductCatalog
ProductCatalogJson
Purchase
PurchaseDeclaration
PurchasePartiesError
PurchasePartiesInput
quoteSeatPrice
rateMeteredLine
recordMeteredUsage
RecordMeteredUsage
recoverCheckout
RecurringBilling
RegisteredOffers
registerOffers
releaseCredits
reserveCredits
ReserveCreditsCommand
ResolvedPurchaseParties
resolvePurchaseParties
ResourceLimitBenefitDefinition
RevokeLicenseCredential
revokeLicenseCredential
RotateLicenseCredential
rotateLicenseCredential
Sapa
scheduleSubscriptionPlanChange
ScheduleSubscriptionPlanChangeCommand
ScheduleSubscriptionPlanChangeError
ScheduleSubscriptionPlanChangeResult
SeatAssignmentAccessQuery
SeatAssignmentAccessResult
SeatAssignmentError
SeatAssignmentResult
SeatBenefit
SeatPriceQuote
SeatPriceQuoteError
SeatPriceQuoteInput
SeatPricing
Seats
seedCatalog
SelectedOfferTerms
selectOfferSeats
SingleCheckout
snapshotSelectedOffer
SubscriptionPlanChangeAcceptanceError
SubscriptionPlanChangeError
SubscriptionPlanChangeQuote
SubscriptionRenewalCheckout
SubscriptionTermsSelection
Tier
TierFulfillment
unassignSeat
UnassignSeatCommand
ValidateLicenseCredential
validateLicenseCredential
validateSubscriptionPlanChangeAcceptance
ValidateSubscriptionPlanChangeAcceptanceInput
validateSubscriptionTerms
GitHub
Select theme
Dark
Light
Auto
Meter
Versioned additive meter terms.
Declaration
Section titled “Declaration”
type
Meter
=
typeof
Meter
.
Type
;