reference-inventory.md

Subscrio reference inventory

Public operations documented from the adjacent TypeScript and .NET checkouts. All 14 pages follow AGENTS.md and FORMAT-SPEC.md, with the site-wide language selector, linked property definitions, and language-specific signatures. A dash means that language exposes a different API; see the page for supported alternatives.

Subscrio

TypeScript	.NET	Reference
new Subscrio	new Subscrio	Constructor
installSchema	InstallSchemaAsync	Subscrio
migrate	MigrateAsync	Subscrio
verifySchema	VerifySchemaAsync	Subscrio
runInitialConfigSync	RunInitialConfigSyncAsync	Subscrio
dropSchema	DropSchemaAsync	Subscrio
close	Dispose	Subscrio

Features

TypeScript	.NET	Reference
createFeature	CreateFeatureAsync	Features
updateFeature	UpdateFeatureAsync	Features
getFeature	GetFeatureAsync	Features
listFeatures	ListFeaturesAsync	Features
getFeaturesByProduct	GetFeaturesByProductAsync	Features
archiveFeature	ArchiveFeatureAsync	Features
unarchiveFeature	UnarchiveFeatureAsync	Features
deleteFeature	DeleteFeatureAsync	Features

Add-ons

TypeScript	.NET	Reference
createAddon	CreateAddonAsync	Add-ons
updateAddon	UpdateAddonAsync	Add-ons
getAddon	GetAddonAsync	Add-ons
listAddons	ListAddonsAsync	Add-ons
archiveAddon	ArchiveAddonAsync	Add-ons
unarchiveAddon	UnarchiveAddonAsync	Add-ons
deleteAddon	DeleteAddonAsync	Add-ons

Products

TypeScript	.NET	Reference
createProduct	CreateProductAsync	Products
updateProduct	UpdateProductAsync	Products
getProduct	GetProductAsync	Products
listProducts	ListProductsAsync	Products
associateFeature	AssociateFeatureAsync	Products
dissociateFeature	DissociateFeatureAsync	Products
archiveProduct	ArchiveProductAsync	Products
unarchiveProduct	UnarchiveProductAsync	Products
deleteProduct	DeleteProductAsync	Products

Plans

TypeScript	.NET	Reference
createPlan	CreatePlanAsync	Plans
updatePlan	UpdatePlanAsync	Plans
getPlan	GetPlanAsync	Plans
listPlans	ListPlansAsync	Plans
getPlansByProduct	GetPlansByProductAsync	Plans
setFeatureValue	SetFeatureValueAsync	Plans
removeFeatureValue	RemoveFeatureValueAsync	Plans
getFeatureValue	GetFeatureValueAsync	Plans
getPlanFeatures	GetPlanFeaturesAsync	Plans
archivePlan	ArchivePlanAsync	Plans
unarchivePlan	UnarchivePlanAsync	Plans
deletePlan	DeletePlanAsync	Plans

Billing Cycles

TypeScript	.NET	Reference
createBillingCycle	CreateBillingCycleAsync	Billing Cycles
updateBillingCycle	UpdateBillingCycleAsync	Billing Cycles
getBillingCycle	GetBillingCycleAsync	Billing Cycles
listBillingCycles	ListBillingCyclesAsync	Billing Cycles
getBillingCyclesByPlan	GetBillingCyclesByPlanAsync	Billing Cycles
archiveBillingCycle	ArchiveBillingCycleAsync	Billing Cycles
unarchiveBillingCycle	UnarchiveBillingCycleAsync	Billing Cycles
deleteBillingCycle	DeleteBillingCycleAsync	Billing Cycles
calculateNextPeriodEnd	CalculateNextPeriodEndAsync	Billing Cycles
getBillingCyclesByDurationUnit	GetBillingCyclesByDurationUnitAsync	Billing Cycles
getDefaultBillingCycles	GetDefaultBillingCyclesAsync	Billing Cycles

Customers

TypeScript	.NET	Reference
createCustomer	CreateCustomerAsync	Customers
updateCustomer	UpdateCustomerAsync	Customers
getCustomer	GetCustomerAsync	Customers
listCustomers	ListCustomersAsync	Customers
archiveCustomer	ArchiveCustomerAsync	Customers
unarchiveCustomer	UnarchiveCustomerAsync	Customers
deleteCustomer	DeleteCustomerAsync	Customers

Subscriptions

TypeScript	.NET	Reference
createSubscription	CreateSubscriptionAsync	Subscriptions
updateSubscription	UpdateSubscriptionAsync	Subscriptions
getSubscription	GetSubscriptionAsync	Subscriptions
listSubscriptions	ListSubscriptionsAsync	Subscriptions
findSubscriptions	FindSubscriptionsAsync	Subscriptions
getSubscriptionsByCustomer	GetSubscriptionsByCustomerAsync	Subscriptions
attachAddon	AttachAddonAsync	Subscriptions
detachAddon	DetachAddonAsync	Subscriptions
getAddons	GetAddonsAsync	Subscriptions
addFeatureOverride	AddFeatureOverrideAsync	Subscriptions
removeFeatureOverride	RemoveFeatureOverrideAsync	Subscriptions
clearTemporaryOverrides	ClearTemporaryOverridesAsync	Subscriptions
archiveSubscription	ArchiveSubscriptionAsync	Subscriptions
unarchiveSubscription	UnarchiveSubscriptionAsync	Subscriptions
deleteSubscription	DeleteSubscriptionAsync	Subscriptions
transitionExpiredSubscriptions	TransitionExpiredSubscriptionsAsync	Subscriptions

Feature Checker

TypeScript	.NET	Reference
getValueForCustomer	GetValueForCustomerAsync	Feature Checker
isEnabledForCustomer	IsEnabledForCustomerAsync	Feature Checker
getAllFeaturesForCustomer	GetAllFeaturesForCustomerAsync	Feature Checker
getValueForSubscription	GetValueForSubscriptionAsync	Feature Checker
isEnabledForSubscription	IsEnabledForSubscriptionAsync	Feature Checker
getAllFeaturesForSubscription	GetAllFeaturesForSubscriptionAsync	Feature Checker
hasPlanAccess	HasPlanAccessAsync	Feature Checker
getActivePlans	GetActivePlansAsync	Feature Checker
getFeatureUsageSummary	GetFeatureUsageSummaryAsync	Feature Checker
explainForCustomer	ExplainForCustomerAsync	Feature Checker
explainForSubscription	ExplainForSubscriptionAsync	Feature Checker

Metered Usage

TypeScript	.NET	Reference
getUsage	GetUsageAsync	Metered Usage
reportUsage	ReportUsageAsync	Metered Usage
listUsageEvents	ListUsageEventsAsync	Metered Usage

Credits

TypeScript	.NET	Reference
createCurrency	CreateCurrencyAsync	Credits
updateCurrency	UpdateCurrencyAsync	Credits
getCurrency	GetCurrencyAsync	Credits
listCurrencies	ListCurrenciesAsync	Credits
setPlanGrant	SetPlanGrantAsync	Credits
getPlanGrant	GetPlanGrantAsync	Credits
listPlanGrants	ListPlanGrantsAsync	Credits
removePlanGrant	RemovePlanGrantAsync	Credits
setConsumptionRule	SetConsumptionRuleAsync	Credits
getConsumptionRule	GetConsumptionRuleAsync	Credits
listConsumptionRules	ListConsumptionRulesAsync	Credits
removeConsumptionRule	RemoveConsumptionRuleAsync	Credits
grant	GrantAsync	Credits
issueDuePlanGrants	IssueDuePlanGrantsAsync	Credits
processScheduledGrants	ProcessScheduledGrantsAsync	Credits
getBalance	GetBalanceAsync	Credits
listBalances	ListBalancesAsync	Credits
canConsume	CanConsumeAsync	Credits
consume	ConsumeAsync	Credits
adjust	AdjustAsync	Credits
listGrants	ListGrantsAsync	Credits
getOperation	GetOperationAsync	Credits
listLedgerEntries	ListLedgerEntriesAsync	Credits
archiveCurrency	ArchiveCurrencyAsync	Credits
unarchiveCurrency	UnarchiveCurrencyAsync	Credits
deleteCurrency	DeleteCurrencyAsync	Credits

Hooks

TypeScript	.NET	Reference
on	—	Hooks
off	—	Hooks
hasListeners	HasListeners	Hooks
emit	—	Hooks
—	OnCustomerCreatedBefore	Hooks
—	OnCustomerCreatedAfter	Hooks
—	OnCustomerUpdatedBefore	Hooks
—	OnCustomerUpdatedAfter	Hooks
—	OnCustomerArchivedBefore	Hooks
—	OnCustomerArchivedAfter	Hooks
—	OnCustomerUnarchivedBefore	Hooks
—	OnCustomerUnarchivedAfter	Hooks
—	OnCustomerDeletedBefore	Hooks
—	OnCustomerDeletedAfter	Hooks
—	OnSubscriptionCreatedBefore	Hooks
—	OnSubscriptionCreatedAfter	Hooks
—	OnSubscriptionUpdatedBefore	Hooks
—	OnSubscriptionUpdatedAfter	Hooks
—	OnSubscriptionArchivedBefore	Hooks
—	OnSubscriptionArchivedAfter	Hooks
—	OnSubscriptionUnarchivedBefore	Hooks
—	OnSubscriptionUnarchivedAfter	Hooks
—	OnSubscriptionDeletedBefore	Hooks
—	OnSubscriptionDeletedAfter	Hooks
—	OnSubscriptionFeatureOverrideAddedBefore	Hooks
—	OnSubscriptionFeatureOverrideAddedAfter	Hooks
—	OnSubscriptionFeatureOverrideRemovedBefore	Hooks
—	OnSubscriptionFeatureOverrideRemovedAfter	Hooks
—	OnSubscriptionTemporaryOverridesClearedBefore	Hooks
—	OnSubscriptionTemporaryOverridesClearedAfter	Hooks
—	OnStripeReceivedBefore	Hooks
—	OnStripeReceivedAfter	Hooks
—	OnSubscriptionAddonAttachedBefore	Hooks
—	OnSubscriptionAddonAttachedAfter	Hooks
—	OnSubscriptionAddonDetachedBefore	Hooks
—	OnSubscriptionAddonDetachedAfter	Hooks
—	OnUsageReportedBefore	Hooks
—	OnUsageReportedAfter	Hooks
—	OnCreditConsumedBefore	Hooks
—	OnCreditConsumedAfter	Hooks
—	OnCreditGrantedBefore	Hooks
—	OnCreditGrantedAfter	Hooks
—	OnCreditAdjustedBefore	Hooks
—	OnCreditAdjustedAfter	Hooks
—	EmitCustomerBeforeAsync	Hooks
—	EmitCustomerAfterAsync	Hooks
—	EmitSubscriptionBeforeAsync	Hooks
—	EmitSubscriptionAfterAsync	Hooks
—	EmitStripeReceivedAsync	Hooks

Configuration Sync

TypeScript	.NET	Reference
syncFromFile	SyncFromFileAsync	Configuration Sync
syncFromJson	SyncFromJsonAsync	Configuration Sync
exportConfig	ExportConfigAsync	Configuration Sync

Stripe Integration

TypeScript	.NET	Reference
createCheckoutSession	CreateCheckoutSessionAsync	Stripe Integration
constructStripeEvent	—	Stripe Integration
processStripeEvent	ProcessStripeEventAsync	Stripe Integration
createStripeSubscription	CreateStripeSubscriptionAsync	Stripe Integration

Workflow guides

Welcome and Getting Started introduce the library. Guides cover the model, lifecycle, how feature values are calculated, add-ons and overrides, metered usage, credit wallets, and configuration management. Extensions and Stripe Setup cover integration workflows; Relationships and Schema Upgrade cover database structure and operation. Shared update conventions live in Getting Started.