# Paygentic ## Docs - [API Keys](https://docs.paygentic.io/api-keys.md) - [Create a new alert](https://docs.paygentic.io/api-reference/alerts/create-a-new-alert.md) - [Create a new billable metric](https://docs.paygentic.io/api-reference/billable-metrics/create-a-new-billable-metric.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. - [Delete billable metric](https://docs.paygentic.io/api-reference/billable-metrics/delete-billable-metric.md) - [Get billable metric by ID](https://docs.paygentic.io/api-reference/billable-metrics/get-billable-metric-by-id.md) - [Get billable metric price for a subscription](https://docs.paygentic.io/api-reference/billable-metrics/get-billable-metric-price-for-a-subscription.md) - [Get billable metric price for a subscription](https://docs.paygentic.io/api-reference/billable-metrics/get-billable-metric-price-for-a-subscription-1.md) - [List billable metrics](https://docs.paygentic.io/api-reference/billable-metrics/list-billable-metrics.md) - [Update billable metric](https://docs.paygentic.io/api-reference/billable-metrics/update-billable-metric.md) - [Create consumer](https://docs.paygentic.io/api-reference/consumers/create-consumer.md): Create a new consumer. A consumer represents an entity that consumes a `Merchant`'s `Product`. Consumers can have one or more `subscriptions`, monitor wallet balances, analyze usage, and manage their subscriptions from a single entrypoint. - [Get consumer](https://docs.paygentic.io/api-reference/consumers/get-consumer.md) - [Update consumer](https://docs.paygentic.io/api-reference/consumers/update-consumer.md) - [Create authorization session for customer](https://docs.paygentic.io/api-reference/customers/create-authorization-session-for-customer.md): Create an authorization session for a customer. An authorization session is used to create customer and subscription resources for a consumer. The URL generated can be sent to the consumer for them to complete the subscription process. - [Create new customer](https://docs.paygentic.io/api-reference/customers/create-new-customer.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. - [Fetch the authorization session](https://docs.paygentic.io/api-reference/customers/fetch-the-authorization-session.md) - [Get customer details](https://docs.paygentic.io/api-reference/customers/get-customer-details.md) - [List customers of a merchant organization](https://docs.paygentic.io/api-reference/customers/list-customers-of-a-merchant-organization.md) - [Update authorization session](https://docs.paygentic.io/api-reference/customers/update-authorization-session.md) - [Accept or decline a dispute](https://docs.paygentic.io/api-reference/disputes/accept-or-decline-a-dispute.md): Accept or decline a dispute - [Create a dispute for a usage event](https://docs.paygentic.io/api-reference/disputes/create-a-dispute-for-a-usage-event.md): Create a dispute for a usage event. Only one dispute can be created per usage event. - [List disputes](https://docs.paygentic.io/api-reference/disputes/list-disputes.md): List disputes for a merchant, customer, or consumer. At least one of merchantId, customerId, or consumerId must be provided. - [Create an entitlement](https://docs.paygentic.io/api-reference/entitlements/create-an-entitlement.md): Create an entitlement for a customer. This temporarily reserves funds in the customer's wallet to guarantee payment for future usage. - [Get active entitlements for a customer](https://docs.paygentic.io/api-reference/entitlements/get-active-entitlements-for-a-customer.md) - [Create a new external bank account](https://docs.paygentic.io/api-reference/external-bank-accounts/create-a-new-external-bank-account.md): Create a new external bank account for an organization. - [Delete an external bank account](https://docs.paygentic.io/api-reference/external-bank-accounts/delete-an-external-bank-account.md): Delete a specific external bank account. - [Get an external bank account](https://docs.paygentic.io/api-reference/external-bank-accounts/get-an-external-bank-account.md): Retrieve details of a specific external bank account. - [List external bank accounts](https://docs.paygentic.io/api-reference/external-bank-accounts/list-external-bank-accounts.md): List all external bank accounts for an organization. - [Update an external bank account](https://docs.paygentic.io/api-reference/external-bank-accounts/update-an-external-bank-account.md): Update details of a specific external bank account. - [Get alert by ID](https://docs.paygentic.io/api-reference/get-alert-by-id.md) - [Create an invoice](https://docs.paygentic.io/api-reference/invoices/create-an-invoice.md): Creates an invoice for a postpaid subscription. Only available for postpaid plans. - [Get an invoice](https://docs.paygentic.io/api-reference/invoices/get-an-invoice.md) - [Get invoice summary for a subscription](https://docs.paygentic.io/api-reference/invoices/get-invoice-summary-for-a-subscription.md): Get invoice summary statistics for a subscription (for dashboard cards) - [List invoices](https://docs.paygentic.io/api-reference/invoices/list-invoices.md): List invoices for a subscription, merchant, or customer. At least one of subscriptionId, merchantId, or customerId must be provided. - [Update an invoice](https://docs.paygentic.io/api-reference/invoices/update-an-invoice.md): Update an invoice status (e.g., mark as paid) - [List all alerts for a resource](https://docs.paygentic.io/api-reference/list-all-alerts-for-a-resource.md) - [Create a new merchant organization](https://docs.paygentic.io/api-reference/merchants/create-a-new-merchant-organization.md): Create a new merchant organization. A merchant organization represents a business entity that sells one or more products. Merchant organizations own resources such as `products`, `prices`, `customers`, `subscriptions`, etc. - [Delete merchant organization](https://docs.paygentic.io/api-reference/merchants/delete-merchant-organization.md): Delete a merchant organization. This will delete all resources associated with the merchant organization. At the moment this endpoint can only be accessed by Paygentic admins. - [Get a list of supported countries and geographies for merchant services.](https://docs.paygentic.io/api-reference/merchants/get-a-list-of-supported-countries-and-geographies-for-merchant-services.md): Get a list of supported countries and geographies for merchant services. - [Get merchant organization by ID](https://docs.paygentic.io/api-reference/merchants/get-merchant-organization-by-id.md) - [Update merchant organization](https://docs.paygentic.io/api-reference/merchants/update-merchant-organization.md) - [Create off-session payment method for a consumer](https://docs.paygentic.io/api-reference/off-session-payment-methods/create-off-session-payment-method-for-a-consumer.md) - [List off-session payment methods for a consumer](https://docs.paygentic.io/api-reference/off-session-payment-methods/list-off-session-payment-methods-for-a-consumer.md) - [Updates off-session payment methods for a consumer](https://docs.paygentic.io/api-reference/off-session-payment-methods/updates-off-session-payment-methods-for-a-consumer.md) - [Create a new payout](https://docs.paygentic.io/api-reference/payouts/create-a-new-payout.md): Create a new payout for an organization. - [Get a list of payout methods](https://docs.paygentic.io/api-reference/payouts/get-a-list-of-payout-methods.md): Retrieve a list of available payout methods. - [Get a list of payouts](https://docs.paygentic.io/api-reference/payouts/get-a-list-of-payouts.md): Retrieve a list of payouts. - [Get a payout by ID](https://docs.paygentic.io/api-reference/payouts/get-a-payout-by-id.md): Retrieve details of a specific payout. - [Update a payout](https://docs.paygentic.io/api-reference/payouts/update-a-payout.md): Update details of a specific payout. - [Create a new plan](https://docs.paygentic.io/api-reference/plans/create-a-new-plan.md) - [Delete plan](https://docs.paygentic.io/api-reference/plans/delete-plan.md) - [Get plan by ID](https://docs.paygentic.io/api-reference/plans/get-plan-by-id.md) - [List plans](https://docs.paygentic.io/api-reference/plans/list-plans.md) - [Update plan](https://docs.paygentic.io/api-reference/plans/update-plan.md) - [Create a new price](https://docs.paygentic.io/api-reference/prices/create-a-new-price.md) - [Delete price](https://docs.paygentic.io/api-reference/prices/delete-price.md) - [Get price by ID](https://docs.paygentic.io/api-reference/prices/get-price-by-id.md) - [List prices](https://docs.paygentic.io/api-reference/prices/list-prices.md) - [Update price](https://docs.paygentic.io/api-reference/prices/update-price.md) - [Create a new product](https://docs.paygentic.io/api-reference/products/create-a-new-product.md) - [Delete product](https://docs.paygentic.io/api-reference/products/delete-product.md) - [Get product by ID](https://docs.paygentic.io/api-reference/products/get-product-by-id.md) - [List products](https://docs.paygentic.io/api-reference/products/list-products.md) - [Update product](https://docs.paygentic.io/api-reference/products/update-product.md) - [Approve source event](https://docs.paygentic.io/api-reference/sources/approve-source-event.md): Approve a pending source event to create a usage event - [Bulk approve source events](https://docs.paygentic.io/api-reference/sources/bulk-approve-source-events.md): Approve multiple pending source events at once - [Bulk reject source events](https://docs.paygentic.io/api-reference/sources/bulk-reject-source-events.md): Reject multiple pending source events at once - [Create a new source](https://docs.paygentic.io/api-reference/sources/create-a-new-source.md): Create a new source for automated usage event generation from external data sources. - [Delete source](https://docs.paygentic.io/api-reference/sources/delete-source.md) - [Get source by ID](https://docs.paygentic.io/api-reference/sources/get-source-by-id.md) - [List source events](https://docs.paygentic.io/api-reference/sources/list-source-events.md): List events for a specific source with optional status filtering - [List sources](https://docs.paygentic.io/api-reference/sources/list-sources.md) - [Reject source event](https://docs.paygentic.io/api-reference/sources/reject-source-event.md): Reject a pending source event - [Update source](https://docs.paygentic.io/api-reference/sources/update-source.md) - [Create a subscription](https://docs.paygentic.io/api-reference/subscriptions/create-a-subscription.md): Creates a subscription for a customer. The customer must already exist in the system. Currently this endpoint is only available for Paygentic admins as part of the subscription authorization flow. - [Get a subscription](https://docs.paygentic.io/api-reference/subscriptions/get-a-subscription.md) - [List subscriptions](https://docs.paygentic.io/api-reference/subscriptions/list-subscriptions.md) - [Update a subscription](https://docs.paygentic.io/api-reference/subscriptions/update-a-subscription.md) - [Update alert](https://docs.paygentic.io/api-reference/update-alert.md) - [Batch create usage events](https://docs.paygentic.io/api-reference/usage-events/batch-create-usage-events.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 a usage event](https://docs.paygentic.io/api-reference/usage-events/create-a-usage-event.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 a usage event by ID](https://docs.paygentic.io/api-reference/usage-events/get-a-usage-event-by-id.md) - [List usage events](https://docs.paygentic.io/api-reference/usage-events/list-usage-events.md) - [Create a new principal for a user](https://docs.paygentic.io/api-reference/users/create-a-new-principal-for-a-user.md): Create a new principal for a user. A principal links a user to an organization and a set of roles. Every action is carried out by a principal. At the moment this endpoint can only be accessed by Paygentic admins. - [Create a new user](https://docs.paygentic.io/api-reference/users/create-a-new-user.md): Create a new user. A user is an entity that has access to an Organization's resources. Every action is carried out by a user. At the moment this endpoint can only be accessed by Paygentic admins. - [Create API key for user](https://docs.paygentic.io/api-reference/users/create-api-key-for-user.md) - [Delete user](https://docs.paygentic.io/api-reference/users/delete-user.md): Delete a user by ID. This endpoint is currently only used by the Paygentic platform as part of the subscription flow. - [Delete user API key](https://docs.paygentic.io/api-reference/users/delete-user-api-key.md) - [Get user by ID](https://docs.paygentic.io/api-reference/users/get-user-by-id.md) - [List users](https://docs.paygentic.io/api-reference/users/list-users.md) - [List user's API keys](https://docs.paygentic.io/api-reference/users/list-users-api-keys.md) - [Update user](https://docs.paygentic.io/api-reference/users/update-user.md) - [Create a new topup for a wallet](https://docs.paygentic.io/api-reference/wallets/create-a-new-topup-for-a-wallet.md) - [Create a new wallet](https://docs.paygentic.io/api-reference/wallets/create-a-new-wallet.md) - [Creates an auto topup configuration for a wallet](https://docs.paygentic.io/api-reference/wallets/creates-an-auto-topup-configuration-for-a-wallet.md) - [Deletes an auto topup configuration for a wallet](https://docs.paygentic.io/api-reference/wallets/deletes-an-auto-topup-configuration-for-a-wallet.md) - [Execute a transaction between wallets](https://docs.paygentic.io/api-reference/wallets/execute-a-transaction-between-wallets.md) - [Get a specific topup by ID](https://docs.paygentic.io/api-reference/wallets/get-a-specific-topup-by-id.md) - [Get auto topup configuration for a wallet](https://docs.paygentic.io/api-reference/wallets/get-auto-topup-configuration-for-a-wallet.md) - [Get transaction by ID](https://docs.paygentic.io/api-reference/wallets/get-transaction-by-id.md) - [Get wallet by ID](https://docs.paygentic.io/api-reference/wallets/get-wallet-by-id.md) - [List topups for a wallet](https://docs.paygentic.io/api-reference/wallets/list-topups-for-a-wallet.md) - [List wallets owned by an organization or associated with a plan](https://docs.paygentic.io/api-reference/wallets/list-wallets-owned-by-an-organization-or-associated-with-a-plan.md) - [Update a wallet balance (only for virtual wallets)](https://docs.paygentic.io/api-reference/wallets/update-a-wallet-balance-only-for-virtual-wallets.md) - [Updates an auto topup configuration for a wallet](https://docs.paygentic.io/api-reference/wallets/updates-an-auto-topup-configuration-for-a-wallet.md) - [Authentication](https://docs.paygentic.io/authentication.md) - [Introduction](https://docs.paygentic.io/introduction.md) - [Privacy Policy](https://docs.paygentic.io/legal/privacy-policy.md): How we collect, use, and protect your data - [Terms and Conditions](https://docs.paygentic.io/legal/terms-and-conditions.md): Legal terms and conditions for using Paygentic services - [Building on Paygentic with LLMs](https://docs.paygentic.io/platform/building-with-llms.md): Leverage LLMs in your Paygentic development process - [Billable Metrics](https://docs.paygentic.io/platform/core-concepts/billable-metrics.md) - [Customers and Subscriptions](https://docs.paygentic.io/platform/core-concepts/customers-and-subscriptions.md) - [Entitlements](https://docs.paygentic.io/platform/core-concepts/entitlements.md) - [Organizations and Users](https://docs.paygentic.io/platform/core-concepts/organizations-and-users.md) - [Plans and Prices](https://docs.paygentic.io/platform/core-concepts/plans-and-prices.md) - [Products](https://docs.paygentic.io/platform/core-concepts/products.md) - [Usage Events](https://docs.paygentic.io/platform/core-concepts/usage-events.md) - [Wallets](https://docs.paygentic.io/platform/core-concepts/wallets.md) - [Monetising a Lovable App](https://docs.paygentic.io/platform/tutorials/lovable-paygentic.md): A step-by-step guide to building and monetising a Bulk QR Code Generator with Lovable & Paygentic - [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 using Paygentic](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. - [Quickstart](https://docs.paygentic.io/quickstart.md)