# Paygentic

## Docs

- [API Keys](https://docs.paygentic.io/api-keys.md)
- [Create](https://docs.paygentic.io/api-reference/billable-metrics/create.md): Create a new billable metric for a merchant organization. A `Billable Metric` represents a metric that can be used to measure the usage of a `Product`. It contains information about the metric, such as its name, description, and units.
- [Get](https://docs.paygentic.io/api-reference/billable-metrics/get.md)
- [List](https://docs.paygentic.io/api-reference/billable-metrics/list.md)
- [Query Meter Usage](https://docs.paygentic.io/api-reference/billable-metrics/query-meter-usage.md): Query aggregated usage data for a billable metric from the metering service.
- [Update](https://docs.paygentic.io/api-reference/billable-metrics/update.md)
- [Create](https://docs.paygentic.io/api-reference/customers/create.md): Create a new customer for a merchant organization. This endpoint is currently only used by the Paygentic platform as part of the subscription flow.
- [Delete](https://docs.paygentic.io/api-reference/customers/delete.md)
- [Get](https://docs.paygentic.io/api-reference/customers/get.md)
- [List by Merchant](https://docs.paygentic.io/api-reference/customers/list-by-merchant.md)
- [Update](https://docs.paygentic.io/api-reference/customers/update.md)
- [Create](https://docs.paygentic.io/api-reference/disputes/create.md): Create a dispute for a usage event. Only one dispute can be created per usage event.
- [List](https://docs.paygentic.io/api-reference/disputes/list.md): List disputes for a merchant, customer, or consumer. At least one of merchantId, customerId, or consumerId must be provided.
- [Create](https://docs.paygentic.io/api-reference/entitlements/create.md): Create an entitlement for a customer. This temporarily reserves funds in the customer's wallet to guarantee payment for future usage.
- [Get Entitlement](https://docs.paygentic.io/api-reference/entitlements/get-entitlement.md): Retrieve a specific entitlement by ID. For metered entitlements, the response includes live balance, usage, and access status for the current billing period.
- [Issue Entitlement](https://docs.paygentic.io/api-reference/entitlements/issue-entitlement.md): Issue a new entitlement to a customer, granting them access to a specific feature. The feature must exist and belong to the same merchant as the customer.
- [List by Customer](https://docs.paygentic.io/api-reference/entitlements/list-by-customer.md)
- [List Entitlements](https://docs.paygentic.io/api-reference/entitlements/list-entitlements.md): Retrieve all entitlements for a customer, optionally filtered by feature or product.
- [Ingest Event](https://docs.paygentic.io/api-reference/events/ingest-event.md): Ingest a raw metering event. The event is published to the meter-events PubSub topic for processing by the meters service.
- [Create](https://docs.paygentic.io/api-reference/features/create.md)
- [Delete](https://docs.paygentic.io/api-reference/features/delete.md)
- [Get](https://docs.paygentic.io/api-reference/features/get.md)
- [List](https://docs.paygentic.io/api-reference/features/list.md): List features by productId, optionally filtered by key
- [Update](https://docs.paygentic.io/api-reference/features/update.md)
- [Create](https://docs.paygentic.io/api-reference/fees/create.md): Create a new fee for a merchant organization. A `Fee` represents a charge that can be applied to subscriptions. Cadence is defined when creating a Price for the fee.
- [Delete](https://docs.paygentic.io/api-reference/fees/delete.md)
- [Get](https://docs.paygentic.io/api-reference/fees/get.md)
- [Get Fee Price](https://docs.paygentic.io/api-reference/fees/get-fee-price.md): Get the price for a fee in the context of a subscription. This returns the price configured for the fee in the subscription's plan, including the tax rate.
- [List](https://docs.paygentic.io/api-reference/fees/list.md)
- [Update](https://docs.paygentic.io/api-reference/fees/update.md)
- [Get](https://docs.paygentic.io/api-reference/invoices-v2/get.md): Retrieve a single invoice with real-time aggregates (for ACTIVE/CLOSING/CLOSED) or cached aggregates (for finalized invoices). Optionally include line items with expand=lineItems.
- [Get Line Items](https://docs.paygentic.io/api-reference/invoices-v2/get-line-items.md): Get paginated line items for an invoice from the analytics service
- [List](https://docs.paygentic.io/api-reference/invoices-v2/list.md): List invoices with optional filters. Platform users can use nextActionAt=ready to get invoices ready for processing.
- [Create Payment](https://docs.paygentic.io/api-reference/payments/create-payment.md): Create a new payment for collecting a one-off charge. Returns a payment URL that can be shared with the customer.
- [Get Payment](https://docs.paygentic.io/api-reference/payments/get-payment.md): Retrieve a single payment by ID.
- [List Payments](https://docs.paygentic.io/api-reference/payments/list-payments.md): List payments for the authenticated merchant with optional filters.
- [Create](https://docs.paygentic.io/api-reference/plans/create.md)
- [Get](https://docs.paygentic.io/api-reference/plans/get.md)
- [List](https://docs.paygentic.io/api-reference/plans/list.md)
- [List Available Plans](https://docs.paygentic.io/api-reference/plans/list-available-plans.md): Retrieves all plans for a merchant that the customer does not have an active or pending subscription for. When a customer has a subscription for any plan within a product, all plans from that product are excluded.
- [Update](https://docs.paygentic.io/api-reference/plans/update.md)
- [Create](https://docs.paygentic.io/api-reference/prices/create.md)
- [Delete](https://docs.paygentic.io/api-reference/prices/delete.md)
- [Get](https://docs.paygentic.io/api-reference/prices/get.md)
- [List](https://docs.paygentic.io/api-reference/prices/list.md)
- [Update](https://docs.paygentic.io/api-reference/prices/update.md)
- [Create](https://docs.paygentic.io/api-reference/products/create.md)
- [Get](https://docs.paygentic.io/api-reference/products/get.md)
- [List](https://docs.paygentic.io/api-reference/products/list.md)
- [Update](https://docs.paygentic.io/api-reference/products/update.md)
- [Get revenue time series](https://docs.paygentic.io/api-reference/revenue/get-revenue-time-series.md): Returns time-bucketed revenue data including usage charges, fee charges, and refunds. Data is aggregated by subscription with an optional 'other' bucket for subscriptions outside the top N.
- [Approve](https://docs.paygentic.io/api-reference/sources/approve.md): Approve a pending source event to create a usage event
- [Bulk Approve](https://docs.paygentic.io/api-reference/sources/bulk-approve.md): Approve multiple pending source events at once
- [Bulk Reject](https://docs.paygentic.io/api-reference/sources/bulk-reject.md): Reject multiple pending source events at once
- [Create](https://docs.paygentic.io/api-reference/sources/create.md): Create a new source for automated usage event generation from external data sources.
- [Create Rule](https://docs.paygentic.io/api-reference/sources/create-rule.md): Create a rule for automatically approving source events. When a pending source event matches ALL conditions in a rule, it will be automatically approved and converted to a usage event. Rules are evaluated in order (lowest order number first), and the first matching rule triggers auto-approval. Maximum 10 rules per source.
- [Delete Rule](https://docs.paygentic.io/api-reference/sources/delete-rule.md)
- [Get](https://docs.paygentic.io/api-reference/sources/get.md)
- [Get Rule](https://docs.paygentic.io/api-reference/sources/get-rule.md)
- [List](https://docs.paygentic.io/api-reference/sources/list.md)
- [List Events](https://docs.paygentic.io/api-reference/sources/list-events.md): List events for a specific source with optional status filtering
- [List Rules](https://docs.paygentic.io/api-reference/sources/list-rules.md): List all auto-acceptance rules for a source. These rules automatically approve pending source events when all conditions are met.
- [Reject](https://docs.paygentic.io/api-reference/sources/reject.md): Reject a pending source event
- [Update](https://docs.paygentic.io/api-reference/sources/update.md)
- [Update Rule](https://docs.paygentic.io/api-reference/sources/update-rule.md)
- [Create](https://docs.paygentic.io/api-reference/subscriptions/create.md): Creates a subscription for an existing customer or creates a new customer as part of the action.
- [Generate Portal Link](https://docs.paygentic.io/api-reference/subscriptions/generate-portal-link.md): Generates a secure, time-limited URL that allows customers to access their subscription data without authentication.
- [Get](https://docs.paygentic.io/api-reference/subscriptions/get.md)
- [List](https://docs.paygentic.io/api-reference/subscriptions/list.md)
- [Terminate](https://docs.paygentic.io/api-reference/subscriptions/terminate.md): Terminates a subscription with a required reason. This endpoint is for merchant-initiated termination only.
- [Advance](https://docs.paygentic.io/api-reference/test-clocks/advance.md): Advances the test clock's current time. You can either specify a new absolute time or advance by a duration.
- [Create](https://docs.paygentic.io/api-reference/test-clocks/create.md): Creates a new test clock with an optional initial time. If no time is provided, uses the current time.
- [Delete](https://docs.paygentic.io/api-reference/test-clocks/delete.md): Soft deletes a test clock. The clock will be marked as deleted but not removed from the database.
- [Get](https://docs.paygentic.io/api-reference/test-clocks/get.md): Retrieves details of a specific test clock
- [List](https://docs.paygentic.io/api-reference/test-clocks/list.md): Retrieves a paginated list of test clocks
- [Batch Create](https://docs.paygentic.io/api-reference/usage-events/batch-create.md): Creates multiple usage events in a single request. The idempotencyKey for each event is used to ensure the event is processed only once by downstream consumers, even if the same event is submitted multiple times. Duplicate submissions will be accepted and return the same response.
- [Create](https://docs.paygentic.io/api-reference/usage-events/create.md): Creates a usage event. The idempotencyKey is used to ensure the event is processed only once by downstream consumers, even if the same event is submitted multiple times. Duplicate submissions will be accepted and return the same response.
- [Get](https://docs.paygentic.io/api-reference/usage-events/get.md)
- [List](https://docs.paygentic.io/api-reference/usage-events/list.md)
- [Refund](https://docs.paygentic.io/api-reference/usage-events/refund.md): Marks a usage event as refunded. This reverts the consumption recorded by the usage event and creates a corresponding refund billing event if the usage event was already billed.
- [Get](https://docs.paygentic.io/api-reference/users/get.md)
- [Update](https://docs.paygentic.io/api-reference/users/update.md)
- [Authentication](https://docs.paygentic.io/authentication.md)
- [Changelog](https://docs.paygentic.io/changelog.md): Product updates and announcements
- [Environments](https://docs.paygentic.io/getting-started/environments.md): Use sandbox and live environments to test and deploy your Paygentic integration safely
- [Introduction](https://docs.paygentic.io/getting-started/introduction.md)
- [Quickstart](https://docs.paygentic.io/getting-started/quickstart.md)
- [Cookie Policy](https://docs.paygentic.io/legal/cookie-policy.md): How Paygentic uses cookies and similar technologies on its website
- [Privacy Policy](https://docs.paygentic.io/legal/privacy-policy.md): How Paygentic collects, uses, and protects your personal information
- [Terms and Conditions](https://docs.paygentic.io/legal/terms-and-conditions.md): Legal terms and conditions for using Paygentic services
- [Customer Lifecycle](https://docs.paygentic.io/platform/billing/customer-lifecycle.md): Complete guide to creating and managing customers through the API, including merchant-managed and full consumer accounts
- [Entitlements](https://docs.paygentic.io/platform/billing/entitlements.md): Pre-authorized payment reservations for guaranteed billing
- [Features and Entitlements](https://docs.paygentic.io/platform/billing/features.md): Define product capabilities and control customer access
- [Metered Entitlements (Private Beta)](https://docs.paygentic.io/platform/billing/metered-entitlements.md): Track and gate usage with time-based credit grants
- [Usage Events](https://docs.paygentic.io/platform/billing/usage-events.md): Report consumption and trigger billing
- [Building on Paygentic with LLMs](https://docs.paygentic.io/platform/building-with-llms.md): Leverage LLMs in your Paygentic development process
- [Source Installation Management](https://docs.paygentic.io/platform/developers/source-installations.md): Monitor integration health, troubleshoot issues, and automate customer success workflows with the Source Installation API.
- [Webhooks](https://docs.paygentic.io/platform/developers/webhooks.md): Receive real-time notifications when events occur in your Paygentic account
- [Cost Tracking (Private Beta)](https://docs.paygentic.io/platform/metering/cost-tracking.md): Track the cost of serving each customer and monitor gross margin
- [Meter Events](https://docs.paygentic.io/platform/metering/meter-events.md): Ingest usage data for metering, entitlements, and analytics without automatically triggering billing
- [Organizations](https://docs.paygentic.io/platform/organizations.md): Resource ownership and access control
- [Accounts](https://docs.paygentic.io/platform/payments/accounts.md): Fund management and instant settlement
- [Billable Metrics](https://docs.paygentic.io/platform/pricing/billable-metrics.md): Define what you measure and how to aggregate it
- [Fees](https://docs.paygentic.io/platform/pricing/fees.md): Add fixed charges to your pricing
- [Pricing Overview](https://docs.paygentic.io/platform/pricing/overview.md): Build flexible billing for your services
- [Plans](https://docs.paygentic.io/platform/pricing/plans.md): Package your pricing tiers
- [Prices](https://docs.paygentic.io/platform/pricing/prices.md): Configure pricing models and payment terms
- [Products](https://docs.paygentic.io/platform/pricing/products.md): Organize your services and offerings
- [Monetizing a Lovable App](https://docs.paygentic.io/platform/tutorials/lovable-paygentic.md): Build and monetize a QR code generator using the Lovable builder with Paygentic billing
- [Revenue Share Monetization](https://docs.paygentic.io/platform/tutorials/revenue-share-stripe.md): Learn how to implement a revenue share model using Paygentic Stripe Revenue source to automatically charge a percentage of your customer Stripe revenue.
- [Monetizing an API](https://docs.paygentic.io/platform/tutorials/standard-usage-tracking.md): Step-by-step guide to integrating pay-as-you-go monetization using Paygentic's billing and payment infrastructure.

## OpenAPI Specs

- [openapi](https://docs.paygentic.io/openapi.json)