# 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)
- [List Meter Events](https://docs.paygentic.io/api-reference/billable-metrics/list-meter-events.md): List raw underlying events for a billable metric from the metering service. Returns events ordered by time descending.
- [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/costs/create.md): Create a new metered cost for a product.
- [Delete](https://docs.paygentic.io/api-reference/costs/delete.md)
- [Get](https://docs.paygentic.io/api-reference/costs/get.md)
- [List](https://docs.paygentic.io/api-reference/costs/list.md)
- [Query Summary](https://docs.paygentic.io/api-reference/costs/query-summary.md): Query usage data and compute cost for a specific cost configuration. To retrieve summaries for all costs belonging to a merchant, first call listCosts to obtain cost IDs, then call this endpoint in parallel for each ID.
- [Report](https://docs.paygentic.io/api-reference/costs/report.md): Aggregate cost data across costs and customers with grouping, filtering, and time-series breakdown.
- [Update](https://docs.paygentic.io/api-reference/costs/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)
- [List payment methods](https://docs.paygentic.io/api-reference/customers/list-payment-methods.md): List off-session payment methods saved for this customer.
- [Set up a payment method](https://docs.paygentic.io/api-reference/customers/set-up-a-payment-method.md): Create a payment session that captures a new off-session payment method for this customer without charging. The response contains a hosted-page URL — redirect the customer to it, or load it inside an iframe (when iframed, the page reports outcomes via `postMessage` to the parent window).
- [Update](https://docs.paygentic.io/api-reference/customers/update.md)
- [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 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)
- [Create Grant](https://docs.paygentic.io/api-reference/grants/create-grant.md): Create a grant directly for a metered entitlement, crediting the customer's balance immediately. The entitlement must belong to an active v1 subscription.
- [Get Grant](https://docs.paygentic.io/api-reference/grants/get-grant.md): Retrieve a specific grant by ID.
- [List Grants](https://docs.paygentic.io/api-reference/grants/list-grants.md): List grants for a metered entitlement. Active grants are returned by default; pass `includeVoided=true` to include voided grants.
- [Purchase Grant](https://docs.paygentic.io/api-reference/grants/purchase-grant.md): Create an ad-hoc invoice with a payment session for a grant purchase. The customer pays via the returned payment URL; the grant is created automatically on payment completion. If payment expires, the invoice is cancelled and no grant is created.
- [Void Grant](https://docs.paygentic.io/api-reference/grants/void-grant.md): Void a grant, removing it from the customer's balance. This operation is idempotent — voiding an already-voided grant returns the voided grant without error.
- [Create Manual Line Item](https://docs.paygentic.io/api-reference/invoices-v2/create-manual-line-item.md): Create a manual line item for a billing v1 subscription. Manual line items are ad-hoc charges or credits that flow through the same collection pipeline as auto-generated items. Exactly one of subscriptionId or invoiceId must be provided.
- [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.
- [List Line Items](https://docs.paygentic.io/api-reference/invoices-v2/list-line-items.md): List pending and invoiced line items for a subscription from the billing database. Returns exact fee amounts and estimated metered charges.
- [List](https://docs.paygentic.io/api-reference/payment-sessions/list.md): List payment sessions for the authenticated merchant with optional filters. Supports filtering by subscriptionId, customerId, status, and entityType. When subscriptionId is provided the result includes both the subscription's own activation session (entityType='subscription') and any session attache…
- [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 profitability summary](https://docs.paygentic.io/api-reference/profitability/get-profitability-summary.md): Returns a per-customer profitability summary for a merchant over a date range. Each row aggregates revenue (from issued + paid invoices), cost (from metered cost discovery), profit, and margin. Customers are ranked by profit descending and capped at topN; the remainder is rolled into a single self-c…
- [Get revenue summary](https://docs.paygentic.io/api-reference/revenue/get-revenue-summary.md): Returns revenue summary with invoice and payment breakdowns (outstanding/paid/writtenOff), plus a time-series trend. Revenue is sourced from all issued invoices (v0 + v1) and completed payments.
- [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. Maxim…
- [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
- [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): Infrastructure for consumption-based monetization
- [Quickstart](https://docs.paygentic.io/getting-started/quickstart.md): Four steps from zero to billing
- [Monocle](https://docs.paygentic.io/integrations/monocle.md): Meter and monetize AI workloads instrumented with Monocle
- [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
- [Billing Versions](https://docs.paygentic.io/platform/billing/billing-versions.md): Understand the differences between Legacy and Standard billing models
- [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
- [Grants](https://docs.paygentic.io/platform/billing/grants.md): Add credits to metered entitlements via direct creation or paid purchase
- [Metered Entitlements](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
- [Payments](https://docs.paygentic.io/platform/payments/overview.md): Collect one-off payments from your customers
- [Payment Portal](https://docs.paygentic.io/platform/payments/portal.md): Hosted payment page for collecting customer payments
- [Billable Metrics](https://docs.paygentic.io/platform/pricing/billable-metrics.md): Define what you measure and how to aggregate it
- [Features and Entitlements](https://docs.paygentic.io/platform/pricing/features.md): Define product capabilities and control customer access
- [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

## OpenAPI Specs

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