Index

_

__init__() (fastapi_payments.pricing.base.PricingStrategy method) (fastapi_payments.pricing.dynamic.DynamicPricing method) (fastapi_payments.pricing.freemium.FreemiumPricing method) (fastapi_payments.pricing.hybrid.HybridPricing method) (fastapi_payments.pricing.per_user.PerUserPricing method) (fastapi_payments.pricing.tiered.TieredPricing method) (fastapi_payments.pricing.usage_based.UsageBasedPricing method) (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.services.payment_service.PaymentService method) (fastapi_payments.utils.exceptions.PaymentError method) (fastapi_payments.utils.exceptions.PaymentRequiresActionError method) (fastapi_payments.utils.exceptions.ProviderError method)

A

additional_settings (fastapi_payments.config.config_schema.PaymentConfig attribute) (fastapi_payments.config.config_schema.PricingConfig attribute) (fastapi_payments.config.config_schema.ProviderConfig attribute) allow_custom_pricing (fastapi_payments.config.config_schema.PricingConfig attribute)

allowed_currencies (fastapi_payments.config.config_schema.PaymentConfig attribute) api_key (fastapi_payments.config.config_schema.ProviderConfig attribute) api_secret (fastapi_payments.config.config_schema.ProviderConfig attribute) apply_tax() (fastapi_payments.pricing.base.PricingStrategy method) AuthenticationError (class in fastapi_payments.utils.exceptions)

C

calculate_price() (fastapi_payments.pricing.base.PricingStrategy method) (fastapi_payments.pricing.dynamic.DynamicPricing method) (fastapi_payments.pricing.freemium.FreemiumPricing method) (fastapi_payments.pricing.hybrid.HybridPricing method) (fastapi_payments.pricing.per_user.PerUserPricing method) (fastapi_payments.pricing.subscription.SubscriptionPricing method) (fastapi_payments.pricing.tiered.TieredPricing method) (fastapi_payments.pricing.usage_based.UsageBasedPricing method) calculate_proration() (fastapi_payments.pricing.base.PricingStrategy method) (fastapi_payments.pricing.dynamic.DynamicPricing method) (fastapi_payments.pricing.freemium.FreemiumPricing method) (fastapi_payments.pricing.hybrid.HybridPricing method) (fastapi_payments.pricing.per_user.PerUserPricing method) (fastapi_payments.pricing.subscription.SubscriptionPricing method) (fastapi_payments.pricing.tiered.TieredPricing method) (fastapi_payments.pricing.usage_based.UsageBasedPricing method) calculate_subscription_period_end() (in module fastapi_payments.utils.helpers) calculate_tax_amount() (fastapi_payments.pricing.base.PricingStrategy method) cancel_subscription() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) (fastapi_payments.services.payment_service.PaymentService method)

ConfigurationError (class in fastapi_payments.utils.exceptions) create_customer() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) (fastapi_payments.services.payment_service.PaymentService method) create_payment_method() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) (fastapi_payments.services.payment_service.PaymentService method) create_plan() (fastapi_payments.services.payment_service.PaymentService method) create_price() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) create_product() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) (fastapi_payments.services.payment_service.PaymentService method) create_setup_intent() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) (fastapi_payments.services.payment_service.PaymentService method) create_subscription() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) (fastapi_payments.services.payment_service.PaymentService method) create_sync_job() (fastapi_payments.services.payment_service.PaymentService method)

D

database (fastapi_payments.config.config_schema.PaymentConfig attribute) DatabaseConfig (class in fastapi_payments.config.config_schema) debug (fastapi_payments.config.config_schema.PaymentConfig attribute) default_currency (fastapi_payments.config.config_schema.PricingConfig attribute) default_pricing_model (fastapi_payments.config.config_schema.PricingConfig attribute) default_provider (fastapi_payments.config.config_schema.PaymentConfig attribute)

default_rate (fastapi_payments.config.config_schema.TaxConfig attribute) delete_customer() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) delete_payment_method() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) (fastapi_payments.services.payment_service.PaymentService method) DynamicPricing (class in fastapi_payments.pricing.dynamic)

E

echo (fastapi_payments.config.config_schema.DatabaseConfig attribute) ensure_provider_customer() (fastapi_payments.services.payment_service.PaymentService method)

EVENT_TYPE_MAP (fastapi_payments.providers.stripe.StripeProvider attribute) execute_sync_job() (fastapi_payments.services.payment_service.PaymentService method)

F

format_amount() (in module fastapi_payments.utils.helpers)

FreemiumPricing (class in fastapi_payments.pricing.freemium)

G

generate_idempotency_key() (in module fastapi_payments.utils.helpers) generate_random_string() (in module fastapi_payments.utils.helpers) get_billing_items() (fastapi_payments.pricing.base.PricingStrategy method) (fastapi_payments.pricing.dynamic.DynamicPricing method) (fastapi_payments.pricing.freemium.FreemiumPricing method) (fastapi_payments.pricing.hybrid.HybridPricing method) (fastapi_payments.pricing.per_user.PerUserPricing method) (fastapi_payments.pricing.subscription.SubscriptionPricing method) (fastapi_payments.pricing.tiered.TieredPricing method) (fastapi_payments.pricing.usage_based.UsageBasedPricing method)

get_customer() (fastapi_payments.services.payment_service.PaymentService method) get_payment_service() (in module fastapi_payments.services.payment_service) get_provider() (fastapi_payments.services.payment_service.PaymentService method) (in module fastapi_payments.providers) get_subscription() (fastapi_payments.services.payment_service.PaymentService method)

H

handle_webhook() (fastapi_payments.services.payment_service.PaymentService method)

HybridPricing (class in fastapi_payments.pricing.hybrid)

I

included_in_price (fastapi_payments.config.config_schema.TaxConfig attribute)

initialize() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method)

L

list_customers() (fastapi_payments.services.payment_service.PaymentService method) list_payment_methods() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) (fastapi_payments.services.payment_service.PaymentService method) list_payments() (fastapi_payments.services.payment_service.PaymentService method) list_plans() (fastapi_payments.services.payment_service.PaymentService method)

list_products() (fastapi_payments.services.payment_service.PaymentService method) list_subscriptions() (fastapi_payments.services.payment_service.PaymentService method) load_config() (in module fastapi_payments.config.settings) load_config_from_env() (in module fastapi_payments.config.settings) load_config_from_file() (in module fastapi_payments.config.settings) logging_level (fastapi_payments.config.config_schema.PaymentConfig attribute)

M

max_overflow (fastapi_payments.config.config_schema.DatabaseConfig attribute) merge_configs() (in module fastapi_payments.config.settings) messaging (fastapi_payments.config.config_schema.PaymentConfig attribute) model_config (fastapi_payments.config.config_schema.DatabaseConfig attribute) (fastapi_payments.config.config_schema.PaymentConfig attribute) (fastapi_payments.config.config_schema.PricingConfig attribute) (fastapi_payments.config.config_schema.ProviderConfig attribute) (fastapi_payments.config.config_schema.TaxConfig attribute)

P

parse_amount() (in module fastapi_payments.utils.helpers) PaymentConfig (class in fastapi_payments.config.config_schema) PaymentError (class in fastapi_payments.utils.exceptions) PaymentProvider (class in fastapi_payments.providers.base) PaymentRequiresActionError (class in fastapi_payments.utils.exceptions) PaymentService (class in fastapi_payments.services.payment_service) PerUserPricing (class in fastapi_payments.pricing.per_user) pool_size (fastapi_payments.config.config_schema.DatabaseConfig attribute)

pricing (fastapi_payments.config.config_schema.PaymentConfig attribute) PricingConfig (class in fastapi_payments.config.config_schema) PricingStrategy (class in fastapi_payments.pricing.base) process_payment() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) (fastapi_payments.services.payment_service.PaymentService method) ProviderConfig (class in fastapi_payments.config.config_schema) ProviderError (class in fastapi_payments.utils.exceptions) providers (fastapi_payments.config.config_schema.PaymentConfig attribute)

R

record_usage() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) (fastapi_payments.services.payment_service.PaymentService method) refund_payment() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) (fastapi_payments.services.payment_service.PaymentService method) ResourceNotFoundError (class in fastapi_payments.utils.exceptions) retrieve_customer() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method)

retrieve_payment() (fastapi_payments.providers.stripe.StripeProvider method) retrieve_price() (fastapi_payments.providers.stripe.StripeProvider method) retrieve_product() (fastapi_payments.providers.stripe.StripeProvider method) retrieve_subscription() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) retry_attempts (fastapi_payments.config.config_schema.PaymentConfig attribute) retry_delay (fastapi_payments.config.config_schema.PaymentConfig attribute) round_price() (fastapi_payments.pricing.base.PricingStrategy method) round_to_decimal_places (fastapi_payments.config.config_schema.PricingConfig attribute)

S

sandbox_mode (fastapi_payments.config.config_schema.ProviderConfig attribute) sanitize_metadata() (in module fastapi_payments.utils.helpers) set_db_session() (fastapi_payments.services.payment_service.PaymentService method)

set_default_payment_method() (fastapi_payments.services.payment_service.PaymentService method) StripeProvider (class in fastapi_payments.providers.stripe) SubscriptionPricing (class in fastapi_payments.pricing.subscription) sync_resources() (fastapi_payments.services.payment_service.PaymentService method)

T

tax (fastapi_payments.config.config_schema.PricingConfig attribute) tax_service_url (fastapi_payments.config.config_schema.TaxConfig attribute)

TaxConfig (class in fastapi_payments.config.config_schema) TieredPricing (class in fastapi_payments.pricing.tiered)

U

update_customer() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) (fastapi_payments.services.payment_service.PaymentService method) update_payment_method() (fastapi_payments.services.payment_service.PaymentService method)

update_subscription() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method) url (fastapi_payments.config.config_schema.DatabaseConfig attribute) UsageBasedPricing (class in fastapi_payments.pricing.usage_based) use_tax_service (fastapi_payments.config.config_schema.TaxConfig attribute)

V

validate_default_provider() (fastapi_payments.config.config_schema.PaymentConfig class method) validate_logging_level() (fastapi_payments.config.config_schema.PaymentConfig class method) validate_plan_change() (fastapi_payments.pricing.base.PricingStrategy method) (fastapi_payments.pricing.dynamic.DynamicPricing method) (fastapi_payments.pricing.freemium.FreemiumPricing method) (fastapi_payments.pricing.hybrid.HybridPricing method) (fastapi_payments.pricing.per_user.PerUserPricing method) (fastapi_payments.pricing.subscription.SubscriptionPricing method) (fastapi_payments.pricing.tiered.TieredPricing method) (fastapi_payments.pricing.usage_based.UsageBasedPricing method)

ValidationError (class in fastapi_payments.utils.exceptions)

W

webhook_handler() (fastapi_payments.providers.base.PaymentProvider method) (fastapi_payments.providers.stripe.StripeProvider method)

webhook_secret (fastapi_payments.config.config_schema.ProviderConfig attribute) WebhookError (class in fastapi_payments.utils.exceptions)

Z

ZERO_DECIMAL_CURRENCIES (fastapi_payments.providers.stripe.StripeProvider attribute)