# Meteroid Documentation

## Docs

- [Archive an add-on](https://docs.meteroid.com/api-reference/add-ons/archive-an-add-on.md)
- [Create an add-on](https://docs.meteroid.com/api-reference/add-ons/create-an-add-on.md)
- [Get add-on details](https://docs.meteroid.com/api-reference/add-ons/get-add-on-details.md)
- [List add-ons](https://docs.meteroid.com/api-reference/add-ons/list-add-ons.md)
- [Unarchive an add-on](https://docs.meteroid.com/api-reference/add-ons/unarchive-an-add-on.md)
- [Update an add-on](https://docs.meteroid.com/api-reference/add-ons/update-an-add-on.md)
- [Get batch job detail](https://docs.meteroid.com/api-reference/batch-jobs/get-batch-job-detail.md): Retrieve a single batch job with its chunks and failures.
- [List batch job failures](https://docs.meteroid.com/api-reference/batch-jobs/list-batch-job-failures.md): Retrieve paginated failures for a batch job.
- [List batch jobs](https://docs.meteroid.com/api-reference/batch-jobs/list-batch-jobs.md): List batch jobs with optional filtering by type and status.
- [Cancel a checkout session](https://docs.meteroid.com/api-reference/checkout-sessions/cancel-a-checkout-session.md)
- [Create a checkout session](https://docs.meteroid.com/api-reference/checkout-sessions/create-a-checkout-session.md)
- [Get a checkout session by ID](https://docs.meteroid.com/api-reference/checkout-sessions/get-a-checkout-session-by-id.md)
- [List checkout sessions](https://docs.meteroid.com/api-reference/checkout-sessions/list-checkout-sessions.md)
- [Create connected account](https://docs.meteroid.com/api-reference/connect/create-connected-account.md): Create a new connected account (Express flow). Returns the account and an onboarding link for the user to complete setup.
- [Create onboarding link](https://docs.meteroid.com/api-reference/connect/create-onboarding-link.md): Generate a new onboarding link for a connected account. Any existing unused link is invalidated. The link expires after a configured duration.
- [Disconnect account](https://docs.meteroid.com/api-reference/connect/disconnect-account.md): Revoke a connected account. All associated tokens are invalidated.
- [Get connected account](https://docs.meteroid.com/api-reference/connect/get-connected-account.md): Retrieve a connected account by ID.
- [List connected accounts](https://docs.meteroid.com/api-reference/connect/list-connected-accounts.md): List all connected accounts for this platform.
- [Archive a coupon](https://docs.meteroid.com/api-reference/coupons/archive-a-coupon.md)
- [Create a coupon](https://docs.meteroid.com/api-reference/coupons/create-a-coupon.md)
- [Disable a coupon](https://docs.meteroid.com/api-reference/coupons/disable-a-coupon.md)
- [Enable a coupon](https://docs.meteroid.com/api-reference/coupons/enable-a-coupon.md)
- [Get coupon details](https://docs.meteroid.com/api-reference/coupons/get-coupon-details.md)
- [List coupons](https://docs.meteroid.com/api-reference/coupons/list-coupons.md)
- [Unarchive a coupon](https://docs.meteroid.com/api-reference/coupons/unarchive-a-coupon.md)
- [Update a coupon](https://docs.meteroid.com/api-reference/coupons/update-a-coupon.md)
- [Get apiv1credit notes download](https://docs.meteroid.com/api-reference/credit-notes/get-apiv1credit-notes-download.md)
- [Archive a customer](https://docs.meteroid.com/api-reference/customers/archive-a-customer.md): No linked entity will be deleted. You need to terminate all active subscriptions before archiving a customer, or the call will fail.
- [Create customer](https://docs.meteroid.com/api-reference/customers/create-customer.md)
- [Generate a portal token for a customer](https://docs.meteroid.com/api-reference/customers/generate-a-portal-token-for-a-customer.md): Generates a JWT token that grants access to the customer portal. The token can be used to access invoices, payment methods, and other portal features.
- [Get customer](https://docs.meteroid.com/api-reference/customers/get-customer.md): Retrieve a single customer by ID or alias.
- [List customers](https://docs.meteroid.com/api-reference/customers/list-customers.md): List customers with optional pagination and search filtering.
- [Patch customer](https://docs.meteroid.com/api-reference/customers/patch-customer.md): Partially update a customer. Only provided fields will be updated.
- [Restore an archived customer](https://docs.meteroid.com/api-reference/customers/restore-an-archived-customer.md)
- [Update customer](https://docs.meteroid.com/api-reference/customers/update-customer.md)
- [Ingest events](https://docs.meteroid.com/api-reference/events/ingest-events.md): Ingest usage events for metering and billing purposes.
- [Download invoice PDF](https://docs.meteroid.com/api-reference/invoices/download-invoice-pdf.md): Download the PDF document for an invoice.
- [Get invoice](https://docs.meteroid.com/api-reference/invoices/get-invoice.md): Retrieve a single invoice with its payment transactions.
- [List invoices](https://docs.meteroid.com/api-reference/invoices/list-invoices.md): List invoices with optional filtering by customer, subscription, or status.
- [Archive a billable metric](https://docs.meteroid.com/api-reference/metrics/archive-a-billable-metric.md)
- [Create a billable metric](https://docs.meteroid.com/api-reference/metrics/create-a-billable-metric.md)
- [Get metric details](https://docs.meteroid.com/api-reference/metrics/get-metric-details.md)
- [List billable metrics](https://docs.meteroid.com/api-reference/metrics/list-billable-metrics.md)
- [Unarchive a billable metric](https://docs.meteroid.com/api-reference/metrics/unarchive-a-billable-metric.md)
- [Update a billable metric](https://docs.meteroid.com/api-reference/metrics/update-a-billable-metric.md): Partially update metric fields. Code and aggregation_type are immutable.
- [Create OAuth app](https://docs.meteroid.com/api-reference/oauth-apps/create-oauth-app.md): Register a new OAuth application. Returns the app with its client secret (only shown once).
- [Delete OAuth app](https://docs.meteroid.com/api-reference/oauth-apps/delete-oauth-app.md): Delete an OAuth application and revoke all associated tokens.
- [Get OAuth app](https://docs.meteroid.com/api-reference/oauth-apps/get-oauth-app.md): Retrieve an OAuth application by ID.
- [List OAuth apps](https://docs.meteroid.com/api-reference/oauth-apps/list-oauth-apps.md): List all OAuth applications registered for this platform.
- [Rotate client secret](https://docs.meteroid.com/api-reference/oauth-apps/rotate-client-secret.md): Generate a new client secret for an OAuth app. The old secret is immediately invalidated.
- [Exchange tokens](https://docs.meteroid.com/api-reference/oauth/exchange-tokens.md): OAuth 2.0 token endpoint. Supports two grant types: - `authorization_code`: Exchange an authorization code for tokens - `refresh_token`: Refresh an access token
- [Introspect token](https://docs.meteroid.com/api-reference/oauth/introspect-token.md): Token introspection endpoint (RFC 7662). Requires client credentials via HTTP Basic auth.
- [Revoke token](https://docs.meteroid.com/api-reference/oauth/revoke-token.md): Token revocation endpoint (RFC 7009). Always returns 200 per spec. Requires client credentials via HTTP Basic auth.
- [Archive a plan](https://docs.meteroid.com/api-reference/plans/archive-a-plan.md)
- [Create a plan](https://docs.meteroid.com/api-reference/plans/create-a-plan.md): Create a new plan with components and pricing. Set `status` to `ACTIVE` to publish immediately, or `DRAFT` to stage for review.
- [Get plan details](https://docs.meteroid.com/api-reference/plans/get-plan-details.md): Retrieve a specific plan. Use `?version=draft` for the draft version, `?version=2` for a specific version number, or omit for the active version.
- [List plan versions](https://docs.meteroid.com/api-reference/plans/list-plan-versions.md)
- [List plans](https://docs.meteroid.com/api-reference/plans/list-plans.md)
- [Publish a draft plan version](https://docs.meteroid.com/api-reference/plans/publish-a-draft-plan-version.md): Publishes the current draft version, making it the active version.
- [Replace a plan](https://docs.meteroid.com/api-reference/plans/replace-a-plan.md): Full replacement of a plan's version. On a draft plan, updates in-place. On a published plan, creates a new version. Set `status` to `DRAFT` to stage as a new draft without publishing.
- [Unarchive a plan](https://docs.meteroid.com/api-reference/plans/unarchive-a-plan.md)
- [Update plan metadata](https://docs.meteroid.com/api-reference/plans/update-plan-metadata.md): Partially update plan-level fields (name, description, self_service_rank). Does not modify version-level configuration or components.
- [Create product family](https://docs.meteroid.com/api-reference/product-families/create-product-family.md)
- [Get product family](https://docs.meteroid.com/api-reference/product-families/get-product-family.md): Retrieve a single product family by ID or alias.
- [List product families](https://docs.meteroid.com/api-reference/product-families/list-product-families.md)
- [Archive a product](https://docs.meteroid.com/api-reference/products/archive-a-product.md)
- [Create a product](https://docs.meteroid.com/api-reference/products/create-a-product.md)
- [Get product details](https://docs.meteroid.com/api-reference/products/get-product-details.md)
- [List products](https://docs.meteroid.com/api-reference/products/list-products.md)
- [Unarchive a product](https://docs.meteroid.com/api-reference/products/unarchive-a-product.md)
- [Update a product](https://docs.meteroid.com/api-reference/products/update-a-product.md): Partially update product fields. The fee_type is immutable and cannot be changed.
- [Cancel subscription](https://docs.meteroid.com/api-reference/subscriptions/cancel-subscription.md): Cancel a subscription either immediately or at the end of the billing period.
- [Create subscription](https://docs.meteroid.com/api-reference/subscriptions/create-subscription.md): Create a new subscription for a customer with a specific plan.
- [Get subscription details](https://docs.meteroid.com/api-reference/subscriptions/get-subscription-details.md): Retrieve detailed information about a subscription including price components and schedules.
- [List subscriptions](https://docs.meteroid.com/api-reference/subscriptions/list-subscriptions.md): List subscriptions with optional filtering by customer or plan.
- [Update subscription](https://docs.meteroid.com/api-reference/subscriptions/update-subscription.md): Update subscription settings like payment configuration, billing options, etc.
- [Get customer usage](https://docs.meteroid.com/api-reference/usage/get-customer-usage.md): Retrieve aggregated usage data for a customer over a specified period.
- [Get subscription usage](https://docs.meteroid.com/api-reference/usage/get-subscription-usage.md): Retrieve aggregated usage data for a subscription's usage-based components. If start_date/end_date are omitted, defaults to the current billing period.
- [Get usage summary](https://docs.meteroid.com/api-reference/usage/get-usage-summary.md): Retrieve aggregated usage data across all customers for the tenant.
- [Addonarchived webhook](https://docs.meteroid.com/api-reference/webhooks/addonarchived-webhook.md): An add-on was archived
- [Addoncreated webhook](https://docs.meteroid.com/api-reference/webhooks/addoncreated-webhook.md): A new add-on was created
- [Addonupdated webhook](https://docs.meteroid.com/api-reference/webhooks/addonupdated-webhook.md): An add-on was updated
- [Couponarchived webhook](https://docs.meteroid.com/api-reference/webhooks/couponarchived-webhook.md): A coupon was archived
- [Couponcreated webhook](https://docs.meteroid.com/api-reference/webhooks/couponcreated-webhook.md): A new coupon was created
- [Couponupdated webhook](https://docs.meteroid.com/api-reference/webhooks/couponupdated-webhook.md): A coupon was updated
- [Credit notecreated webhook](https://docs.meteroid.com/api-reference/webhooks/credit_notecreated-webhook.md): A new credit note was created
- [Credit notefinalized webhook](https://docs.meteroid.com/api-reference/webhooks/credit_notefinalized-webhook.md): A credit note was finalized
- [Credit notevoided webhook](https://docs.meteroid.com/api-reference/webhooks/credit_notevoided-webhook.md): A credit note was voided
- [Customercreated webhook](https://docs.meteroid.com/api-reference/webhooks/customercreated-webhook.md): A new customer was created
- [Invoicecreated webhook](https://docs.meteroid.com/api-reference/webhooks/invoicecreated-webhook.md): A new invoice was created
- [Invoicefinalized webhook](https://docs.meteroid.com/api-reference/webhooks/invoicefinalized-webhook.md): An invoice was finalized
- [Invoicepaid webhook](https://docs.meteroid.com/api-reference/webhooks/invoicepaid-webhook.md): An invoice was paid
- [Invoicevoided webhook](https://docs.meteroid.com/api-reference/webhooks/invoicevoided-webhook.md): An invoice was voided
- [Metricarchived webhook](https://docs.meteroid.com/api-reference/webhooks/metricarchived-webhook.md): A billable metric was archived
- [Metriccreated webhook](https://docs.meteroid.com/api-reference/webhooks/metriccreated-webhook.md): A new billable metric was created
- [Metricupdated webhook](https://docs.meteroid.com/api-reference/webhooks/metricupdated-webhook.md): A billable metric was updated
- [Planarchived webhook](https://docs.meteroid.com/api-reference/webhooks/planarchived-webhook.md): A plan was archived
- [Plancreated webhook](https://docs.meteroid.com/api-reference/webhooks/plancreated-webhook.md): A new plan was created
- [Planpublished webhook](https://docs.meteroid.com/api-reference/webhooks/planpublished-webhook.md): A plan version was published
- [Productarchived webhook](https://docs.meteroid.com/api-reference/webhooks/productarchived-webhook.md): A product was archived
- [Productcreated webhook](https://docs.meteroid.com/api-reference/webhooks/productcreated-webhook.md): A new product was created
- [Productupdated webhook](https://docs.meteroid.com/api-reference/webhooks/productupdated-webhook.md): A product was updated
- [Quoteaccepted webhook](https://docs.meteroid.com/api-reference/webhooks/quoteaccepted-webhook.md): A quote was accepted
- [Quoteconverted webhook](https://docs.meteroid.com/api-reference/webhooks/quoteconverted-webhook.md): A quote was converted into subscription
- [Subscriptioncreated webhook](https://docs.meteroid.com/api-reference/webhooks/subscriptioncreated-webhook.md): A new subscription was created
- [Creating Products and modeling your pricing](https://docs.meteroid.com/billing/creating-products-and-modeling-your-pricing.md)
- [Managing Add-Ons](https://docs.meteroid.com/billing/managing-add-ons.md)
- [Managing Plans](https://docs.meteroid.com/billing/managing-plans.md): Meteroid helps B2B SaaS companies manage their Product Catalog and pricing models efficiently, without requiring engineering support.
- [Managing price updates](https://docs.meteroid.com/billing/managing-price-updates.md)
- [Managing Trials & Coupons](https://docs.meteroid.com/billing/managing-trials-and-coupons.md)
- [Product updates](https://docs.meteroid.com/changelog/product-update.md)
- [Express Accounts](https://docs.meteroid.com/connect/express.md): Onboard your users to Meteroid billing with a guided, platform-branded setup flow.
- [Standard Accounts (OAuth)](https://docs.meteroid.com/connect/oauth.md): Let existing Meteroid users connect their accounts to your platform via OAuth 2.0.
- [Create and manage credit notes](https://docs.meteroid.com/credit-notes/create-and-manage-credit-notes.md)
- [Customer Portal](https://docs.meteroid.com/customer/customer-portal.md): Meteroid allows End Users to manage their subscription in full autonomy.
- [Managing customers](https://docs.meteroid.com/customer/managing-customers.md): Meteroid allows you to manage your Customers, including creating, updating, and importing them.
- [Overview](https://docs.meteroid.com/home.md)
- [Integrations](https://docs.meteroid.com/integrations/general-information.md)
- [HubSpot Integration](https://docs.meteroid.com/integrations/hubspot.md)
- [Pennylane Integration](https://docs.meteroid.com/integrations/pennylane.md)
- [Get Started with Meteroid](https://docs.meteroid.com/introduction/get-started-with-meteroid.md)
- [Glossary](https://docs.meteroid.com/introduction/glossary.md)
- [Introduction](https://docs.meteroid.com/introduction/understanding-meteroid.md)
- [Managing invoices](https://docs.meteroid.com/invoices/managing-invoices.md)
- [Billable Metrics](https://docs.meteroid.com/metering/billable-metrics.md): Learn how to create and manage your billable metrics in Meteroid.
- [Managing events](https://docs.meteroid.com/metering/managing-events.md)
- [Stripe Migration Guide](https://docs.meteroid.com/migration/stripe-migration-guide.md)
- [Create and manage quotes](https://docs.meteroid.com/quotes/create-and-manage-quotes.md)
- [Overview](https://docs.meteroid.com/quotes/introduction.md)
- [Invoices settings](https://docs.meteroid.com/settings/invoices-settings.md)
- [Managing your billing details](https://docs.meteroid.com/settings/merchant.md)
- [Supported Payment Method](https://docs.meteroid.com/settings/payment-methods.md)
- [Taxes](https://docs.meteroid.com/settings/taxes.md)
- [Tenants](https://docs.meteroid.com/settings/tenants.md)
- [Check-out](https://docs.meteroid.com/subscriptions/check-out.md): Meteroid provides a **hosted check-out page** that lets your End Users subscribe and complete purchases securely.
- [Creating a subscription](https://docs.meteroid.com/subscriptions/creating-a-subscription.md)
- [Managing Subscriptions](https://docs.meteroid.com/subscriptions/managing-a-subscription.md)
- [Updating a subscription](https://docs.meteroid.com/subscriptions/updating-a-subscription.md)
- [What is a subscription?](https://docs.meteroid.com/subscriptions/what-is-a-subscription.md)

## OpenAPI Specs

- [openapi](https://docs.meteroid.com/api-reference/openapi.json)

## Optional

- [Blog](https://meteroid.com/blog)
- [Talk to us](https://meteroid.com/talk-to-us)
- [GitHub](https://go.meteroid.com/github)