# Flowglad Docs

## Docs

- [Get Api Key](https://flowglad.mintlify.app/api-reference/api-keys/get-api-key.md)
- [Create Checkout Session](https://flowglad.mintlify.app/api-reference/checkout-sessions/create-checkout-session.md)
- [Get Checkout Session](https://flowglad.mintlify.app/api-reference/checkout-sessions/get-checkout-session.md)
- [List Checkout Sessions](https://flowglad.mintlify.app/api-reference/checkout-sessions/list-checkout-sessions.md)
- [Archive Customer](https://flowglad.mintlify.app/api-reference/customer/archive-customer.md): Archives a customer, canceling all active subscriptions and freeing the externalId for reuse.
- [Create Customer](https://flowglad.mintlify.app/api-reference/customer/create-customer.md)
- [Get Billing Details](https://flowglad.mintlify.app/api-reference/customer/get-billing-details.md)
- [Get Customer](https://flowglad.mintlify.app/api-reference/customer/get-customer.md)
- [Get Usage Balances](https://flowglad.mintlify.app/api-reference/customer/get-usage-balances.md)
- [List Customers](https://flowglad.mintlify.app/api-reference/customer/list-customers.md)
- [Update Customer](https://flowglad.mintlify.app/api-reference/customer/update-customer.md)
- [Create Discount](https://flowglad.mintlify.app/api-reference/discounts/create-discount.md)
- [Get Discount](https://flowglad.mintlify.app/api-reference/discounts/get-discount.md)
- [List Discounts](https://flowglad.mintlify.app/api-reference/discounts/list-discounts.md)
- [Update Discount](https://flowglad.mintlify.app/api-reference/discounts/update-discount.md)
- [Create Feature](https://flowglad.mintlify.app/api-reference/features/create-feature.md)
- [Get Feature](https://flowglad.mintlify.app/api-reference/features/get-feature.md)
- [List Features](https://flowglad.mintlify.app/api-reference/features/list-features.md)
- [Update Feature](https://flowglad.mintlify.app/api-reference/features/update-feature.md)
- [Introduction](https://flowglad.mintlify.app/api-reference/introduction.md): Introduction to the Flowglad API
- [Get Invoice Line Item](https://flowglad.mintlify.app/api-reference/invoice-line-items/get-invoice-line-item.md)
- [List Invoice Line Items](https://flowglad.mintlify.app/api-reference/invoice-line-items/list-invoice-line-items.md)
- [Get Invoice](https://flowglad.mintlify.app/api-reference/invoices/get-invoice.md)
- [List Invoices](https://flowglad.mintlify.app/api-reference/invoices/list-invoices.md)
- [Get Payment Method](https://flowglad.mintlify.app/api-reference/payment-methods/get-payment-method.md)
- [List Payment Methods](https://flowglad.mintlify.app/api-reference/payment-methods/list-payment-methods.md)
- [Get Payment](https://flowglad.mintlify.app/api-reference/payments/get-payment.md)
- [List Payments](https://flowglad.mintlify.app/api-reference/payments/list-payments.md)
- [Refund a Payment](https://flowglad.mintlify.app/api-reference/payments/refund-a-payment.md)
- [Create Price](https://flowglad.mintlify.app/api-reference/prices/create-price.md)
- [Get Price](https://flowglad.mintlify.app/api-reference/prices/get-price.md)
- [List Prices](https://flowglad.mintlify.app/api-reference/prices/list-prices.md)
- [Update Price](https://flowglad.mintlify.app/api-reference/prices/update-price.md)
- [Clone a PricingModel](https://flowglad.mintlify.app/api-reference/pricing-models/clone-a-pricingmodel.md)
- [Create Pricing Model](https://flowglad.mintlify.app/api-reference/pricing-models/create-pricing-model.md)
- [Export a PricingModel](https://flowglad.mintlify.app/api-reference/pricing-models/export-a-pricingmodel.md)
- [Get Default Pricing Model for Organization](https://flowglad.mintlify.app/api-reference/pricing-models/get-default-pricing-model-for-organization.md)
- [Get Pricing Model](https://flowglad.mintlify.app/api-reference/pricing-models/get-pricing-model.md)
- [List Pricing Models](https://flowglad.mintlify.app/api-reference/pricing-models/list-pricing-models.md)
- [Setup a PricingModel](https://flowglad.mintlify.app/api-reference/pricing-models/setup-a-pricingmodel.md)
- [Update Pricing Model](https://flowglad.mintlify.app/api-reference/pricing-models/update-pricing-model.md)
- [Create Product Feature](https://flowglad.mintlify.app/api-reference/product-features/create-product-feature.md)
- [Expire Product Feature](https://flowglad.mintlify.app/api-reference/product-features/expire-product-feature.md): Expire a product feature, making it no longer available for subscription items
- [Get Product Feature](https://flowglad.mintlify.app/api-reference/product-features/get-product-feature.md)
- [List Product Features](https://flowglad.mintlify.app/api-reference/product-features/list-product-features.md)
- [Create Product](https://flowglad.mintlify.app/api-reference/products/create-product.md)
- [Get Product](https://flowglad.mintlify.app/api-reference/products/get-product.md)
- [List Products](https://flowglad.mintlify.app/api-reference/products/list-products.md)
- [Update Product](https://flowglad.mintlify.app/api-reference/products/update-product.md)
- [Get Purchase](https://flowglad.mintlify.app/api-reference/purchases/get-purchase.md)
- [Claim Resource](https://flowglad.mintlify.app/api-reference/resource-claims/claim-resource.md): Claim a resource for a subscription. Exactly one of quantity, externalId, or externalIds must be provided.
- [Get Resource Usage](https://flowglad.mintlify.app/api-reference/resource-claims/get-resource-usage.md): Get resource usage information for a subscription. Exactly one of resourceSlug or resourceId must be provided.
- [List Resource Claims](https://flowglad.mintlify.app/api-reference/resource-claims/list-resource-claims.md): List active resource claims for a subscription. Optionally filter by resourceSlug.
- [List Resource Usages](https://flowglad.mintlify.app/api-reference/resource-claims/list-resource-usages.md): List resource usage information for all resources on the subscription.
- [Release Resource](https://flowglad.mintlify.app/api-reference/resource-claims/release-resource.md): Release claimed resources for a subscription. Exactly one of quantity, externalId, externalIds, or claimIds must be provided.
- [Create Resource](https://flowglad.mintlify.app/api-reference/resources/create-resource.md)
- [Get Resource](https://flowglad.mintlify.app/api-reference/resources/get-resource.md)
- [List Resources](https://flowglad.mintlify.app/api-reference/resources/list-resources.md)
- [Update Resource](https://flowglad.mintlify.app/api-reference/resources/update-resource.md)
- [Create Subscription Item Feature](https://flowglad.mintlify.app/api-reference/subscription-item-features/create-subscription-item-feature.md)
- [Expire Subscription Item Feature](https://flowglad.mintlify.app/api-reference/subscription-item-features/expire-subscription-item-feature.md): Expire a feature attached to a subscription item, no longer granting the customer access to it
- [Get Subscription Item Feature](https://flowglad.mintlify.app/api-reference/subscription-item-features/get-subscription-item-feature.md)
- [Update Subscription Item Feature](https://flowglad.mintlify.app/api-reference/subscription-item-features/update-subscription-item-feature.md)
- [Add Feature to Subscription](https://flowglad.mintlify.app/api-reference/subscriptions/add-feature-to-subscription.md): Add a feature to a subscription. For toggle features, this is idempotent. For usage credit features, amounts accumulate. Optionally grant credits immediately for the current billing period.
- [Adjust Subscription](https://flowglad.mintlify.app/api-reference/subscriptions/adjust-subscription.md): Adjust an active subscription by changing its plan or quantity. Supports immediate adjustments with proration, end-of-billing-period adjustments for downgrades, and auto timing that automatically chooses based on whether it's an upgrade or downgrade. Also supports priceSlug for referencing prices by…
- [Cancel Scheduled Adjustment](https://flowglad.mintlify.app/api-reference/subscriptions/cancel-scheduled-adjustment.md): Cancels a scheduled subscription adjustment. The subscription must have a pending scheduled adjustment (scheduledAdjustmentAt is not null). This will expire any subscription items that were scheduled to become active at the end of the billing period and clear the scheduledAdjustmentAt field.
- [Cancel Subscription](https://flowglad.mintlify.app/api-reference/subscriptions/cancel-subscription.md)
- [Create Subscription](https://flowglad.mintlify.app/api-reference/subscriptions/create-subscription.md)
- [Get Subscription](https://flowglad.mintlify.app/api-reference/subscriptions/get-subscription.md)
- [List Subscriptions](https://flowglad.mintlify.app/api-reference/subscriptions/list-subscriptions.md)
- [Preview Subscription Adjustment](https://flowglad.mintlify.app/api-reference/subscriptions/preview-subscription-adjustment.md): Returns a preview of what a subscription adjustment would look like, including proration amount, payment method, and whether the adjustment can be made. This endpoint does not make any changes to the subscription. Use this to show users what will happen before they commit to an adjustment.
- [Uncancel Subscription](https://flowglad.mintlify.app/api-reference/subscriptions/uncancel-subscription.md): Reverses a scheduled subscription cancellation. The subscription must be in `cancellation_scheduled` status. This will restore the subscription to its previous status (typically `active` or `trialing`) and reschedule any billing runs that were aborted. For paid subscriptions, a valid payment method…
- [Bulk Insert Usage Events](https://flowglad.mintlify.app/api-reference/usage-events/bulk-insert-usage-events.md): Create multiple usage events in a single request. Supports priceId, priceSlug, usageMeterId, or usageMeterSlug for each event. Exactly one identifier type must be provided per event.
- [Create Usage Event](https://flowglad.mintlify.app/api-reference/usage-events/create-usage-event.md)
- [Get Usage Event](https://flowglad.mintlify.app/api-reference/usage-events/get-usage-event.md)
- [List Usage Events](https://flowglad.mintlify.app/api-reference/usage-events/list-usage-events.md)
- [Create Usage Meter](https://flowglad.mintlify.app/api-reference/usage-meters/create-usage-meter.md)
- [Get Usage Meter](https://flowglad.mintlify.app/api-reference/usage-meters/get-usage-meter.md)
- [List Usage Meters](https://flowglad.mintlify.app/api-reference/usage-meters/list-usage-meters.md)
- [Update Usage Meter](https://flowglad.mintlify.app/api-reference/usage-meters/update-usage-meter.md)
- [Create Webhook](https://flowglad.mintlify.app/api-reference/webhooks/create-webhook.md)
- [Get Webhook](https://flowglad.mintlify.app/api-reference/webhooks/get-webhook.md)
- [Update Webhook](https://flowglad.mintlify.app/api-reference/webhooks/update-webhook.md)
- [Changelog](https://flowglad.mintlify.app/changelog.md): Latest updates and changes to the Flowglad platform
- [Supported Countries](https://flowglad.mintlify.app/countries.md): You can process payments using Flowglad if you are in the following countries
- [Data Model](https://flowglad.mintlify.app/data-model.md): The Core Concepts in the Flowglad data model.
- [Frequently Asked Questions](https://flowglad.mintlify.app/faq.md): Common questions and troubleshooting tips for integrating Flowglad.
- [Checkout Sessions](https://flowglad.mintlify.app/features/checkout-sessions.md): How your customers will create subscriptions or purchases for your products.
- [Customers](https://flowglad.mintlify.app/features/customers.md): Manage customer accounts, including creation, metadata, and archiving.
- [Discounts](https://flowglad.mintlify.app/features/discounts.md): Offers you can give customers to incentivize them to purchase from you.
- [Introduction](https://flowglad.mintlify.app/features/introduction.md): Explore Flowglad's powerful billing and payments features
- [Invoices](https://flowglad.mintlify.app/features/invoices.md): Records for tracking payments owed to you by your customers.
- [Notifications](https://flowglad.mintlify.app/features/notifications.md)
- [Prices](https://flowglad.mintlify.app/features/prices.md): Individual pricing schemes that you can attach to a product
- [Pricing Models](https://flowglad.mintlify.app/features/pricing-models.md): Define your product offering with a pricing model
- [Products](https://flowglad.mintlify.app/features/products.md): Create a product, easily.
- [Resources](https://flowglad.mintlify.app/features/resources.md): Manage claimable capacity entitlements like seats, API keys, and projects.
- [Subscriptions](https://flowglad.mintlify.app/features/subscriptions.md): Manage ongoing payment relationships with your customers using Flowglad Subscriptions.
- [Usage Based Billing](https://flowglad.mintlify.app/features/usage.md): Set up usage based pricing models effortlessly.
- [Webhooks](https://flowglad.mintlify.app/features/webhooks.md): Optional notifications you can subscribe to when billing events happen in Flowglad.
- [Introduction](https://flowglad.mintlify.app/guides/introduction.md): Welcome to Flowglad's guides! Here you can find guides on how to implement Flowglad across various different frameworks and pricing models.
- [Generation-Based Subscription](https://flowglad.mintlify.app/guides/nextjs/generation-based-subscription.md): Learn how to implement generation-based subscription in Next.js with Flowglad.
- [Pay As You Go](https://flowglad.mintlify.app/guides/nextjs/pay-as-you-go.md): Learn how to implement pay-as-you-go billing in Next.js with Flowglad.
- [Tiered Usage-Gated Subscription](https://flowglad.mintlify.app/guides/nextjs/tiered-usage-gated-subscription.md): Learn how to implement tiered usage-gated subscription billing in Next.js with Flowglad.
- [Usage Limit Subscription](https://flowglad.mintlify.app/guides/nextjs/usage-limit-subscription.md): Learn how to implement usage limit subscription in Next.js with Flowglad.
- [Pricing Models](https://flowglad.mintlify.app/guides/pricing-models.md): Explore different pricing model patterns and implementations with Flowglad
- [Generation-Based Subscription](https://flowglad.mintlify.app/guides/react-vite/generation-based-subscription.md): Learn how to implement generation-based subscription in React + Vite with Flowglad.
- [Generation-Based Subscription](https://flowglad.mintlify.app/guides/tanstack-start/generation-based-subscription.md): Learn how to implement generation-based subscription in TanStack Start with Flowglad.
- [Integrate by HTTP](https://flowglad.mintlify.app/integrate-by-http.md): Integrating Flowglad without using the SDKs
- [MCP Server](https://flowglad.mintlify.app/mcp-server.md): Setup the Flowglad MCP Server
- [Principles](https://flowglad.mintlify.app/principles.md): How Flowglad thinks about billing and payments
- [Quickstart](https://flowglad.mintlify.app/quickstart.md): Process your first payment in 3 minutes
- [Auth](https://flowglad.mintlify.app/sdks/auth.md): Learn how to set up Flowglad server client using your auth provider of choice
- [Better Auth Plugin](https://flowglad.mintlify.app/sdks/better-auth.md): Better Auth Plugin for Flowglad
- [Checkout Sessions](https://flowglad.mintlify.app/sdks/checkout-sessions.md): Learn how to launch checkout flows
- [Customer Purchases](https://flowglad.mintlify.app/sdks/customer-purchases.md): Retrieve purchase history and active subscriptions for a customer
- [Examples & Code Samples](https://flowglad.mintlify.app/sdks/examples.md): Complete examples and common patterns for using Flowglad SDKs
- [Feature Access & Usage](https://flowglad.mintlify.app/sdks/feature-access-usage.md): Check entitlements and usage balances with Flowglad
- [Introduction](https://flowglad.mintlify.app/sdks/introduction.md): Learn about Flowglad's SDK ecosystem and choose the right package for your application
- [@flowglad/nextjs](https://flowglad.mintlify.app/sdks/nextjs.md): Official Next.js SDK for Flowglad with App Router and Pages Router support
- [Pricing Models & Products](https://flowglad.mintlify.app/sdks/pricing-models-products.md): Learn how to surface your pricing models and product catalogs in your app
- [@flowglad/react](https://flowglad.mintlify.app/sdks/react.md): React components and hooks for Flowglad billing and subscription management
- [Resources](https://flowglad.mintlify.app/sdks/resources.md): Claim and manage resource allocations with the Flowglad SDK
- [@flowglad/server](https://flowglad.mintlify.app/sdks/server.md): Core server-side SDK for Flowglad integration in Node.js applications
- [Setup](https://flowglad.mintlify.app/sdks/setup.md): Setup instructions for Flowglad Next.js, React, and Server SDKs. Read [choosing the right SDK](/sdks/introduction#choosing-the-right-sdk) first, then follow the framework-specific steps below.
- [Subscription Management](https://flowglad.mintlify.app/sdks/subscription-management.md): Manage subscription lifecycle events with Flowglad's SDKs
- [Welcome](https://flowglad.mintlify.app/welcome.md): Welcome to Flowglad!

## OpenAPI Specs

- [openapi](https://app.flowglad.com/api/openapi)

## Optional

- [Community](https://app.flowglad.com/invite-discord)
- [Examples](https://github.com/flowglad/examples)