# SchematicHQ ## Instructions for AI Agents - For clean Markdown of any page, append `.md` to the page URL - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schematichq.com/_mcp/server ## Docs - [Welcome to Schematic Docs](https://docs.schematichq.com/overview.md) - [What is Schematic?](https://docs.schematichq.com/what-is-schematic.md) - [Concepts](https://docs.schematichq.com/concepts.md): Plain-language definitions of Schematic's core concepts. - [Who Uses Schematic](https://docs.schematichq.com/using-schematic/who-uses-schematic.md) - [Use Cases](https://docs.schematichq.com/use-cases/overview.md): The common things teams build with Schematic, and where to start with each. - [Convert and expand users self-serve](https://docs.schematichq.com/use-cases/self-serve-checkout.md): Let customers sign up, upgrade, and add capacity without talking to sales. - [Give customers a self-service portal](https://docs.schematichq.com/use-cases/customer-portal.md): One branded place for customers to manage subscriptions, payment, invoices, and usage. - [Run free trials](https://docs.schematichq.com/use-cases/free-trials.md): Grant time-limited access and convert trial users cleanly when the trial ends. - [Price by usage](https://docs.schematichq.com/use-cases/usage-based-pricing.md): Meter consumption, enforce limits, and turn rising usage into expansion. - [Bill for usage](https://docs.schematichq.com/use-cases/usage-billing.md): Turn metered usage into accurate Stripe invoices automatically. - [Run credit-based billing](https://docs.schematichq.com/use-cases/credit-billing.md): Sell a prepaid credit balance that burns down as customers use features. - [Close custom deals](https://docs.schematichq.com/use-cases/custom-deals.md): Package bespoke pricing and entitlements for negotiated contracts without touching code. - [Run sales-assisted trials and POCs](https://docs.schematichq.com/use-cases/sales-assisted-trials.md): Grant a time-boxed, scoped evaluation tied to an open opportunity. - [Expand accounts with upsells and add-ons](https://docs.schematichq.com/use-cases/expand-accounts.md): Grow existing accounts with seats, add-ons, and tier upgrades. - [Manage exceptions with overrides](https://docs.schematichq.com/use-cases/overrides.md): Adjust a single company's access for trials, goodwill, or in-flight deals. - [Spot churn and expansion with usage signals](https://docs.schematichq.com/use-cases/usage-signals.md): Watch usage against entitlements to flag at-risk and upsell-ready accounts. - [Stay ahead of renewals and expirations](https://docs.schematichq.com/use-cases/renewals.md): Catch trials, overrides, and contracts before they lapse and access changes. - [Reprice and repackage safely](https://docs.schematichq.com/use-cases/plan-versioning.md): Roll out new pricing and packaging and migrate customers on your terms. - [Keep Stripe in sync](https://docs.schematichq.com/use-cases/stripe-sync.md): Keep entitlements and billing aligned through a bidirectional Stripe sync. - [Automate with webhooks and AI](https://docs.schematichq.com/use-cases/automation.md): Drive Slack, CRM, and AI-assisted workflows off Schematic events. - [Playbooks](https://docs.schematichq.com/playbooks/overview.md): Learn how to implement common pricing models with Schematic. - [Creating a metered feature with Schematic](https://docs.schematichq.com/playbooks/metering.md): Metered features have a pre-defined limit either set globally or on a per-company basis. This is a common packaging model and is often paired with boolean features. - [Backfills and usage corrections](https://docs.schematichq.com/playbooks/backfill-and-corrections.md): Submit events with client-provided timestamps to import historical usage or correct events that arrive after the fact. - [Rolling out beta functionality with Flags](https://docs.schematichq.com/playbooks/rollout.md) - [Handling customer exceptions and feature trials](https://docs.schematichq.com/playbooks/exceptions.md) - [Automatically provision customers using Stripe](https://docs.schematichq.com/playbooks/provisioning.md) - [Build a slack webhook](https://docs.schematichq.com/playbooks/slack-webhook.md) - [Overview](https://docs.schematichq.com/quickstart/overview.md): Start using Schematic in under 5 minutes - [Account Setup](https://docs.schematichq.com/quickstart/account-setup.md): Create a Schematic account - [Adding your first feature](https://docs.schematichq.com/quickstart/entitling-a-feature.md): Quickly gate access to features - [Tracking Usage](https://docs.schematichq.com/quickstart/tracking-usage.md): Quickly track usage to power Usage Based billing - [Creating Components](https://docs.schematichq.com/quickstart/create-a-component.md): Quickly gate access to features - [Identifying Users](https://docs.schematichq.com/quickstart/identifying-users.md): Creating and identifying customer company and users in Schematic - [Setup the SDK](https://docs.schematichq.com/quickstart/setup-sdk.md): Integrate the Schematic SDK into your application - [Feature Management Overview](https://docs.schematichq.com/feature-management/overview.md) - [Flags](https://docs.schematichq.com/feature-management/flags.md) - [Features](https://docs.schematichq.com/feature-management/features.md) - [Tracking Feature Usage](https://docs.schematichq.com/feature-management/feature-analytics.md) - [Company Overrides](https://docs.schematichq.com/feature-management/overrides.md) - [Feature Types](https://docs.schematichq.com/feature-management/feature-types.md): The 3 different types of features in Schematic -- Boolean, Trait-based, and Event-based. - [Catalog Overview](https://docs.schematichq.com/catalog/overview.md): The Catalog is where plans and add ons are defined, including their entitlements and subscription lifecycle. - [Plans](https://docs.schematichq.com/catalog/plans.md) - [Managing Company Plans](https://docs.schematichq.com/catalog/managing-company-plans.md) - [Configuring the Catalog](https://docs.schematichq.com/catalog/configuration.md) - [Add Ons](https://docs.schematichq.com/catalog/add-ons.md) - [Trials](https://docs.schematichq.com/catalog/trials.md) - [Setting up your First Plans](https://docs.schematichq.com/catalog/guides/first-plans.md) - [Rolling Out New Plan Versions](https://docs.schematichq.com/catalog/guides/plan-versions.md) - [AI Tooling](https://docs.schematichq.com/for-developers.md) - [Billing Overview](https://docs.schematichq.com/billing/overview.md) - [Usage Based Billing Models](https://docs.schematichq.com/billing/usage-based-billing.md) - [Seat Based Billing Models](https://docs.schematichq.com/billing/seat-based-billing.md) - [Credit Burndown Billing Model](https://docs.schematichq.com/billing/credit-burndown.md) - [Components Overview](https://docs.schematichq.com/components/overview.md) - [Customer Portal and Checkout Flow](https://docs.schematichq.com/components/customer-portal.md) - [Create a Component](https://docs.schematichq.com/components/create-component.md) - [Add to Your App](https://docs.schematichq.com/components/set-up.md) - [Element Library](https://docs.schematichq.com/components/element-library.md) - [Element Library](https://docs.schematichq.com/components/advanced-usage.md) - [Building Your Own Customer Portal](https://docs.schematichq.com/components/headless-customer-portal.md) - [Standalone Components](https://docs.schematichq.com/components/standalone-components.md) - [Pricing Table](https://docs.schematichq.com/components/pricing-table.md) - [Concepts](https://docs.schematichq.com/developer_resources/concepts.md): Core concepts and data model for engineers integrating with Schematic. - [Key Management](https://docs.schematichq.com/developer_resources/key_management.md) - [Environments](https://docs.schematichq.com/developer_resources/environments.md) - [Entity Relationship Diagram](https://docs.schematichq.com/developer_resources/erd.md) - [Next.js - Weather Search App](https://docs.schematichq.com/developer_resources/sample_apps/sample_nextjs.md): - [Python - Image Search App](https://docs.schematichq.com/developer_resources/sample_apps/sample_python.md): - [Schematic SDKs](https://docs.schematichq.com/developer_resources/sdks/overview.md): Quickly add Schematic to your application - [Cross-platform Features](https://docs.schematichq.com/developer_resources/sdks/cross-platform-features.md) - [React](https://docs.schematichq.com/developer_resources/sdks/react.md) - [React Native](https://docs.schematichq.com/developer_resources/sdks/react-native.md) - [Vue](https://docs.schematichq.com/developer_resources/sdks/vue.md) - [Angular](https://docs.schematichq.com/developer_resources/sdks/angular.md) - [Recommended Setup for Next.js](https://docs.schematichq.com/developer_resources/sdks/nextjs.md): Our recommended setup for using the Schematic React SDK with Next.js. - [Javascript (Client-side)](https://docs.schematichq.com/developer_resources/sdks/javascript.md) - [Go](https://docs.schematichq.com/developer_resources/sdks/go.md) - [Node.js](https://docs.schematichq.com/developer_resources/sdks/nodejs.md) - [Python](https://docs.schematichq.com/developer_resources/sdks/python.md) - [C#](https://docs.schematichq.com/developer_resources/sdks/csharp.md) - [Java](https://docs.schematichq.com/developer_resources/sdks/java.md) - [Ruby](https://docs.schematichq.com/developer_resources/sdks/ruby.md) - [Availability](https://docs.schematichq.com/architecture/availability.md) - [Observability & Support](https://docs.schematichq.com/architecture/observability.md) - [Security](https://docs.schematichq.com/architecture/security.md) - [Roles & Permissions](https://docs.schematichq.com/architecture/roles-and-permissions.md) - [Stripe Integration](https://docs.schematichq.com/integrations/stripe.md) - [Stripe App](https://docs.schematichq.com/integrations/stripe-app.md) - [Stripe Integration Guide](https://docs.schematichq.com/integrations/stripe-integration-guide.md) - [Stripe Integration Guide](https://docs.schematichq.com/integrations/stripe-advanced-use-cases.md) - [Commonly Seen Issues (and how to fix them)](https://docs.schematichq.com/integrations/stripe-troubleshooting.md) - [Segment Integration](https://docs.schematichq.com/integrations/segment.md) - [Clerk Integration](https://docs.schematichq.com/integrations/clerk.md) - [WorkOS Integration](https://docs.schematichq.com/integrations/workos.md) - [Salesforce Integration](https://docs.schematichq.com/integrations/salesforce.md) - [Hubspot Integration](https://docs.schematichq.com/integrations/hubspot.md) - [Webhooks](https://docs.schematichq.com/integrations/webhooks.md) - [Plan Changed Webhook](https://docs.schematichq.com/integrations/webhooks/plan-changed.md) - [Entitlement & Credit Trigger Webhooks](https://docs.schematichq.com/integrations/webhooks/entitlement-triggers.md) - [Resources](https://docs.schematichq.com/api-reference/resources.md) - [Authentication](https://docs.schematichq.com/api-reference/authentication.md) - [Pagination](https://docs.schematichq.com/api-reference/pagination.md) - [Rate limiting](https://docs.schematichq.com/api-reference/rate_limiting.md) - [The Plan object](https://docs.schematichq.com/api-reference/plans/the-plan-object.md) - [The Company object](https://docs.schematichq.com/api-reference/companies/the-company-object.md) - [The User object](https://docs.schematichq.com/api-reference/companies/the-user-object.md) - [The Event object](https://docs.schematichq.com/api-reference/events/the-event-object.md) - [The Feature object](https://docs.schematichq.com/api-reference/features/the-feature-object.md) - [The Flag object](https://docs.schematichq.com/api-reference/features/the-flag-object.md) ## API Docs - API Reference > API Keys [List api keys](https://docs.schematichq.com/api-reference/accounts/list-api-keys.md) - API Reference > API Keys [Get api key](https://docs.schematichq.com/api-reference/accounts/get-api-key.md) - API Reference > API Keys [Create api key](https://docs.schematichq.com/api-reference/accounts/create-api-key.md) - API Reference > API Keys [Update api key](https://docs.schematichq.com/api-reference/accounts/update-api-key.md) - API Reference > API Keys [Delete api key](https://docs.schematichq.com/api-reference/accounts/delete-api-key.md) - API Reference > Environments [Create environment](https://docs.schematichq.com/api-reference/accounts/create-environment.md) - API Reference > Environments [Update environment](https://docs.schematichq.com/api-reference/accounts/update-environment.md) - API Reference > Environments [Delete environment](https://docs.schematichq.com/api-reference/accounts/delete-environment.md) - API Reference > Plans [List plans](https://docs.schematichq.com/api-reference/plans/list-plans.md) - API Reference > Plans [Get plan](https://docs.schematichq.com/api-reference/plans/get-plan.md) - API Reference > Plans [Create plan](https://docs.schematichq.com/api-reference/plans/create-plan.md) - API Reference > Plans [Update plan](https://docs.schematichq.com/api-reference/plans/update-plan.md) - API Reference > Plans [Delete plan](https://docs.schematichq.com/api-reference/plans/delete-plan.md) - API Reference > Companies [List companies](https://docs.schematichq.com/api-reference/companies/list-companies.md) - API Reference > Companies [Upsert company](https://docs.schematichq.com/api-reference/companies/upsert-company.md) - API Reference > Companies [Lookup company](https://docs.schematichq.com/api-reference/companies/lookup-company.md) - API Reference > Companies [Delete company](https://docs.schematichq.com/api-reference/companies/delete-company.md) - API Reference > Companies [Delete company by keys](https://docs.schematichq.com/api-reference/companies/delete-company-by-keys.md) - API Reference > Companies [List company memberships](https://docs.schematichq.com/api-reference/companies/list-company-memberships.md) - API Reference > Companies [Get or create company membership](https://docs.schematichq.com/api-reference/companies/get-or-create-company-membership.md) - API Reference > Companies [Delete company membership](https://docs.schematichq.com/api-reference/companies/delete-company-membership.md) - API Reference > Companies [Upsert company trait](https://docs.schematichq.com/api-reference/companies/upsert-company-trait.md) - API Reference > Users [List users](https://docs.schematichq.com/api-reference/companies/list-users.md) - API Reference > Users [Lookup user](https://docs.schematichq.com/api-reference/companies/lookup-user.md) - API Reference > Users [Upsert user](https://docs.schematichq.com/api-reference/companies/upsert-user.md) - API Reference > Users [Delete user](https://docs.schematichq.com/api-reference/companies/delete-user.md) - API Reference > Users [Delete user by keys](https://docs.schematichq.com/api-reference/companies/delete-user-by-keys.md) - API Reference > Users [Upsert user trait](https://docs.schematichq.com/api-reference/companies/upsert-user-trait.md) - API Reference > Events [List events](https://docs.schematichq.com/api-reference/events/list-events.md) - API Reference > Events [Create event](https://docs.schematichq.com/api-reference/events/create-event.md) - API Reference > Events [Create event batch](https://docs.schematichq.com/api-reference/events/create-event-batch.md) - API Reference > Events [Get event](https://docs.schematichq.com/api-reference/events/get-event.md) - API Reference > Features [List features](https://docs.schematichq.com/api-reference/features/list-features.md) - API Reference > Features [Get feature](https://docs.schematichq.com/api-reference/features/get-feature.md) - API Reference > Features [Create feature](https://docs.schematichq.com/api-reference/features/create-feature.md) - API Reference > Features [Update feature](https://docs.schematichq.com/api-reference/features/update-feature.md) - API Reference > Features [Delete feature](https://docs.schematichq.com/api-reference/features/delete-feature.md) - API Reference > Flags [List flags](https://docs.schematichq.com/api-reference/features/list-flags.md) - API Reference > Flags [Get flag](https://docs.schematichq.com/api-reference/features/get-flag.md) - API Reference > Flags [Create flag](https://docs.schematichq.com/api-reference/features/create-flag.md) - API Reference > Flags [Update flag](https://docs.schematichq.com/api-reference/features/update-flag.md) - API Reference > Flags [Delete flag](https://docs.schematichq.com/api-reference/features/delete-flag.md) - API Reference > Flags [Update flag rules](https://docs.schematichq.com/api-reference/features/update-flag-rules.md) - API Reference > Flags [Check flag](https://docs.schematichq.com/api-reference/features/check-flag.md) - API Reference > Flags [Check flags](https://docs.schematichq.com/api-reference/features/check-flags.md) - API Reference > Entitlements [List company overrides](https://docs.schematichq.com/api-reference/entitlements/list-company-overrides.md) - API Reference > Entitlements [Get company override](https://docs.schematichq.com/api-reference/entitlements/get-company-override.md) - API Reference > Entitlements [Create company override](https://docs.schematichq.com/api-reference/entitlements/create-company-override.md) - API Reference > Entitlements [Update company override](https://docs.schematichq.com/api-reference/entitlements/update-company-override.md) - API Reference > Entitlements [Delete company override](https://docs.schematichq.com/api-reference/entitlements/delete-company-override.md) - API Reference > Entitlements [List plan entitlements](https://docs.schematichq.com/api-reference/entitlements/list-plan-entitlements.md) - API Reference > Entitlements [Get plan entitlement](https://docs.schematichq.com/api-reference/entitlements/get-plan-entitlement.md) - API Reference > Entitlements [Create plan entitlement](https://docs.schematichq.com/api-reference/entitlements/create-plan-entitlement.md) - API Reference > Entitlements [Update plan entitlement](https://docs.schematichq.com/api-reference/entitlements/update-plan-entitlement.md) - API Reference > Entitlements [Delete plan entitlement](https://docs.schematichq.com/api-reference/entitlements/delete-plan-entitlement.md) - API Reference > Feature Usage [List feature usage](https://docs.schematichq.com/api-reference/entitlements/list-feature-usage.md) - API Reference > Billing Credits [List credits](https://docs.schematichq.com/api-reference/billing-credits/list-billing-credits.md) - API Reference > Billing Credits [Create credit](https://docs.schematichq.com/api-reference/billing-credits/create-billing-credit.md) - API Reference > Billing Credits [Get credit](https://docs.schematichq.com/api-reference/billing-credits/get-single-billing-credit.md) - API Reference > Billing Credits [Update credit](https://docs.schematichq.com/api-reference/billing-credits/update-billing-credit.md) - API Reference > Billing Credits [Delete credit](https://docs.schematichq.com/api-reference/billing-credits/soft-delete-billing-credit.md) - API Reference > Billing Credits [List credit bundles](https://docs.schematichq.com/api-reference/billing-credits/list-credit-bundles.md) - API Reference > Billing Credits [Create credit bundle](https://docs.schematichq.com/api-reference/billing-credits/create-credit-bundle.md) - API Reference > Billing Credits [Get credit bundle](https://docs.schematichq.com/api-reference/billing-credits/get-credit-bundle.md) - API Reference > Billing Credits [Update credit bundle](https://docs.schematichq.com/api-reference/billing-credits/update-credit-bundle-details.md) - API Reference > Billing Credits [Delete credit bundle](https://docs.schematichq.com/api-reference/billing-credits/delete-credit-bundle.md) - API Reference > Billing Credits [Grant credits to company](https://docs.schematichq.com/api-reference/billing-credits/grant-billing-credits-to-company.md) - API Reference > Billing Credits [List company credit grants](https://docs.schematichq.com/api-reference/billing-credits/list-company-grants.md) - API Reference > Billing Credits [List credit grants](https://docs.schematichq.com/api-reference/billing-credits/list-grants-for-credit.md) - API Reference > Billing Credits [Zero out credit grant](https://docs.schematichq.com/api-reference/billing-credits/zero-out-grant.md) - API Reference > Billing Credits [List plan credit grants](https://docs.schematichq.com/api-reference/billing-credits/list-billing-plan-credit-grants.md) - API Reference > Billing Credits [Create plan credit grant](https://docs.schematichq.com/api-reference/billing-credits/create-billing-plan-credit-grant.md) - API Reference > Billing Credits [Delete plan credit grant](https://docs.schematichq.com/api-reference/billing-credits/delete-billing-plan-credit-grant.md) - API Reference > Billing Credits [Get credit ledger](https://docs.schematichq.com/api-reference/billing-credits/get-credit-ledger.md) - API Reference > Account Members [List account members](https://docs.schematichq.com/api-reference/accounts/list-account-members.md) - API Reference > Account Members [Get account member](https://docs.schematichq.com/api-reference/accounts/get-account-member.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.schematichq.com/openapi.json) - [OpenAPI YAML](https://docs.schematichq.com/openapi.yaml)