# Plude ## Docs - [Overview](https://docs.plude.io/analytics/overview.md): Running a subscription business require insights and analytics to optimize - [Account object](https://docs.plude.io/api-reference/accounts/account.md): A financial object which represents a financial account details, including account type, balance, status, and transaction history. It provides a structured way to access and manage key information for transactions, limits, and account status updates. - [Create account](https://docs.plude.io/api-reference/accounts/create-account.md): Create a new account. - [Get account](https://docs.plude.io/api-reference/accounts/get-account.md): Get account by id. - [List accounts](https://docs.plude.io/api-reference/accounts/list-accounts.md) - [Create account set](https://docs.plude.io/api-reference/accountsets/create-account-set.md) - [Account Statement Report](https://docs.plude.io/api-reference/analytics/account-statement-report.md): Requests an account statement report. Notification via webhook is sent when the report is ready. - [Get analytics ](https://docs.plude.io/api-reference/analytics/get-analytics-.md) - [Get analyticsmrr](https://docs.plude.io/api-reference/analytics/get-analyticsmrr.md) - [Authentication](https://docs.plude.io/api-reference/authentication.md): To use our API you must first connect and authenticate - [Exchange token](https://docs.plude.io/api-reference/authorization/exchange-token.md): Retrieve the authorization and refresh tokens. - [Initiate connect](https://docs.plude.io/api-reference/authorization/initiate-connect.md): Start a connect session by providing a code challenge. Record the sessionId, and use the returned url to authenticate in a browser. - [Refresh token](https://docs.plude.io/api-reference/authorization/refresh-token.md): Refresh the authorization token and return new credentials. - [Create customer](https://docs.plude.io/api-reference/customers/create-customer.md): Create a new customer. - [Create payment source](https://docs.plude.io/api-reference/customers/create-payment-source.md) - [Customer object](https://docs.plude.io/api-reference/customers/customer.md): Provides properties for a customer whether a consumer or business customer. - [Delete customer](https://docs.plude.io/api-reference/customers/delete-customer.md) - [Get customer](https://docs.plude.io/api-reference/customers/get-customer.md): Retrieve a customer by id. - [List customers](https://docs.plude.io/api-reference/customers/list-customers.md) - [List payment sources](https://docs.plude.io/api-reference/customers/list-payment-sources.md): List payment sources for a customer. - [Partial update customer.](https://docs.plude.io/api-reference/customers/partial-update-customer.md) - [Payment source object](https://docs.plude.io/api-reference/customers/paymentsource.md): Store details of digital payment means such as credit cards, mandates and wallets. - [Update customer](https://docs.plude.io/api-reference/customers/update-customer.md): Updates an given customer by id. - [Data types](https://docs.plude.io/api-reference/datatypes.md) - [Create discount](https://docs.plude.io/api-reference/discounts/create-discount.md): Create a discount. - [Create discount codes](https://docs.plude.io/api-reference/discounts/create-discount-codes.md): Create up to 1.000 discount codes for a discount. The codes are generated based on the syntax provided. - [Delete discount](https://docs.plude.io/api-reference/discounts/delete-discount.md): Delete discount by Id. - [Discount object](https://docs.plude.io/api-reference/discounts/discount.md) - [Get discount](https://docs.plude.io/api-reference/discounts/get-discount.md): Get discount by Id. - [List discount](https://docs.plude.io/api-reference/discounts/list-discount.md): Lists all discounts. - [List dunningplans](https://docs.plude.io/api-reference/dunningplans/list-dunningplans.md): Lists all dunningplans. - [Clear environment](https://docs.plude.io/api-reference/environments/clear-environment.md): Permanently clears an environment for all data. - [Create environment](https://docs.plude.io/api-reference/environments/create-environment.md): Createa new environment. - [Environment object](https://docs.plude.io/api-reference/environments/environment.md) - [Get settings](https://docs.plude.io/api-reference/environments/get-settings.md): Gets settings of the current environment. - [Gets current environment.](https://docs.plude.io/api-reference/environments/gets-current-environment.md): Retrives the current environment. - [List environments](https://docs.plude.io/api-reference/environments/list-environments.md): Returns a list of environments the user has access to. - [Update environment](https://docs.plude.io/api-reference/environments/update-environment.md) - [Update settings](https://docs.plude.io/api-reference/environments/update-settings.md): Update environment settings. - [Errors](https://docs.plude.io/api-reference/errors.md): When a request fails, Plude returns an error object with an appropriate HTTP response code. Errors are consistent and include information to help troubleshoot. - [Filter & sort](https://docs.plude.io/api-reference/filterandsort.md) - [Introduction](https://docs.plude.io/api-reference/introduction.md): Example section for showcasing API endpoints - [InvoiceLine object](https://docs.plude.io/api-reference/invoices/InvoiceLine.md) - [Book invoice](https://docs.plude.io/api-reference/invoices/book-invoice.md): Books a draft invoice. - [Create invoice](https://docs.plude.io/api-reference/invoices/create-invoice.md) - [Duplicate invoice](https://docs.plude.io/api-reference/invoices/duplicate-invoice.md): Create a new invoice based on an existing invoice. - [Get invoice](https://docs.plude.io/api-reference/invoices/get-invoice.md): Retrieve an invoice by id. - [Invoice object](https://docs.plude.io/api-reference/invoices/invoice.md) - [List invoices](https://docs.plude.io/api-reference/invoices/list-invoices.md) - [Pdf invoice](https://docs.plude.io/api-reference/invoices/pdf-invoice.md): Queues the invoice for PDF generation. A webhook is returned upon completed generation. - [Put invoices](https://docs.plude.io/api-reference/invoices/put-invoices.md) - [Settle invoice](https://docs.plude.io/api-reference/invoices/settle-invoice.md) - [Limitations](https://docs.plude.io/api-reference/limitations.md) - [Pagination](https://docs.plude.io/api-reference/pagination.md): List endpoints always return paged results. - [Disable a configured payment provider](https://docs.plude.io/api-reference/paymentproviders/disable-a-configured-payment-provider.md) - [Enable paymentprovider](https://docs.plude.io/api-reference/paymentproviders/enable-paymentprovider.md): Enable a payment provider - [Get paymentprovider](https://docs.plude.io/api-reference/paymentproviders/get-paymentprovider.md): Get paymentprovider by id. - [List payment providers](https://docs.plude.io/api-reference/paymentproviders/list-payment-providers.md) - [Get payment by id](https://docs.plude.io/api-reference/payments/get-payment-by-id.md): Retrieves a payment by its id. - [List payments](https://docs.plude.io/api-reference/payments/list-payments.md) - [Payment object](https://docs.plude.io/api-reference/payments/payment.md) - [Refund payment](https://docs.plude.io/api-reference/payments/refund-payment.md) - [Create price](https://docs.plude.io/api-reference/prices/create-price.md) - [Delete prices](https://docs.plude.io/api-reference/prices/delete-prices.md) - [Get price](https://docs.plude.io/api-reference/prices/get-price.md): Get price by id. - [List prices](https://docs.plude.io/api-reference/prices/list-prices.md) - [Price object](https://docs.plude.io/api-reference/prices/price.md): The Price object represents a price of a product or service. - [Update price](https://docs.plude.io/api-reference/prices/update-price.md) - [Create product](https://docs.plude.io/api-reference/products/create-product.md) - [Delete product](https://docs.plude.io/api-reference/products/delete-product.md) - [Get product](https://docs.plude.io/api-reference/products/get-product.md) - [List products](https://docs.plude.io/api-reference/products/list-products.md) - [Partial update product](https://docs.plude.io/api-reference/products/partial-update-product.md) - [Product object](https://docs.plude.io/api-reference/products/product.md) - [Update product](https://docs.plude.io/api-reference/products/update-product.md) - [Get profile](https://docs.plude.io/api-reference/profile/get-profile.md): Returns the profile of the authenticated user. - [Cancel subscription](https://docs.plude.io/api-reference/subscriptions/cancel-subscription.md) - [Create subscription](https://docs.plude.io/api-reference/subscriptions/create-subscription.md): Creates a new subscription. - [Get subscription](https://docs.plude.io/api-reference/subscriptions/get-subscription.md) - [List subscriptions](https://docs.plude.io/api-reference/subscriptions/list-subscriptions.md) - [Subscription object](https://docs.plude.io/api-reference/subscriptions/subscription.md) - [Update subscription](https://docs.plude.io/api-reference/subscriptions/update-subscription.md): Updates a given subscription and items. Update cannot be partial, a full request mus be sent. - [Create template group](https://docs.plude.io/api-reference/templates/create-template-group.md): Create a template group and all associated templates. - [Get template group](https://docs.plude.io/api-reference/templates/get-template-group.md): Get a template group by id. - [List template groups.](https://docs.plude.io/api-reference/templates/list-template-groups.md): List template groups. - [Template object](https://docs.plude.io/api-reference/templates/template.md) - [Template group object](https://docs.plude.io/api-reference/templates/templategroup.md) - [Update template](https://docs.plude.io/api-reference/templates/update-template.md): Update a single template. - [Ingress events](https://docs.plude.io/api-reference/usageevents/ingress-events.md): Ingress events in bulk. - [Versioning](https://docs.plude.io/api-reference/versioning.md) - [List webhooks](https://docs.plude.io/api-reference/webhooks/list-webhooks.md): Lists all webhooks of the environment. - [Subscribe to a webhook](https://docs.plude.io/api-reference/webhooks/subscribe-to-a-webhook.md) - [Unsubscribe to a webhook](https://docs.plude.io/api-reference/webhooks/unsubscribe-to-a-webhook.md) - [Overview](https://docs.plude.io/customer/customers.md): Introduction to customers - [Advanced](https://docs.plude.io/customer/customers-advanced.md) - [Going live](https://docs.plude.io/environments/golive.md): Here is the checklist for going live with Plude. - [Overview](https://docs.plude.io/environments/overview.md): Learn the different types of environments and how to handle environment lifecycle for your Plude account. - [Advanced invoicing](https://docs.plude.io/invoicing/invoicing-advanced.md) - [E-invoicing](https://docs.plude.io/invoicing/invoicing-einvoice.md): E-invoicing, also known as electronic invoicing, refers to the practice of exchanging invoices digitally between businesses. - [Overview](https://docs.plude.io/invoicing/invoicing-overview.md) - [Payment & refund](https://docs.plude.io/invoicing/invoicing-payment.md) - [PDF template](https://docs.plude.io/invoicing/invoicing-pdf.md) - [Payment terms](https://docs.plude.io/invoicing/payment-terms.md): Payment terms specify the conditions under which a buyer must complete payment for goods or services. - [Bank settlement](https://docs.plude.io/invoicing/settlement.md): Automatic settlement of invoices from bank accounts. - [Checkout](https://docs.plude.io/payment/checkout.md) - [Adyen](https://docs.plude.io/payment/gateway/adyen.md) - [Altapay](https://docs.plude.io/payment/gateway/altapay.md) - [Debitdirect](https://docs.plude.io/payment/gateway/debitdirect.md) - [Quickpay](https://docs.plude.io/payment/gateway/quickpay.md) - [Vipps Mobilepay](https://docs.plude.io/payment/gateway/vippsmobilepay.md) - [Overview](https://docs.plude.io/payment/payment.md): Overview of payment gateways and methods - [Fee](https://docs.plude.io/product/fee.md): The fee price model is the simplest and most common in subscription businesses. Customers such as Netflix and Shopify apply this pricing model. - [Graduated](https://docs.plude.io/product/graduated.md): The graduated pricing is a common price model for consumption based subscription pricing. Customers such as Microsoft and Amazon leverage the graduated price to provide discounts on growth. - [Package](https://docs.plude.io/product/package.md): The package pricing is a common price model for example APIs. Customers such as Twillio use package to apply fee units and consumption pricing. - [Our concept](https://docs.plude.io/product/pricing.md): Pricing is a vital element of setting the right business model. Plude serve multiple price models and configuration to match your needs. - [Overview](https://docs.plude.io/product/products.md): Introduction to products & pricing - [Volume](https://docs.plude.io/product/volume.md): The volume pricing is a common price model for consumption based subscription pricing. Customers such as Microsoft and Amazon leverage the volume price to provide discounts on growth. - [Getting Started](https://docs.plude.io/quickstart.md): Learn the steps to set up your Plude account and authenticate API calls. - [Supported currencies](https://docs.plude.io/references/currencies.md): See currencies supported by Plude - [Month closing](https://docs.plude.io/revenue/revenue-monthclosing.md) - [Overview](https://docs.plude.io/revenue/revenue-overview.md): Revenue recognition strategies determine when and how revenue is recognized, including even distribution, exact daily accrual, and daily accrual based on days remaining. - [Recognition](https://docs.plude.io/revenue/revenue-recognition.md) - [What's next](https://docs.plude.io/roadmap/future.md): The future roadmap. - [What's new](https://docs.plude.io/roadmap/latest.md): The current version is v.2024.4.1. - [Configure](https://docs.plude.io/settings/configure.md): Configure your Plude environment settings. - [Changes](https://docs.plude.io/subscription/subscription-changes.md) - [Overview](https://docs.plude.io/subscription/subscriptions.md): Introduction to subscription - [Support](https://docs.plude.io/support.md): Get help from our team of experts. Learn how you can get assistance from the Plude team. - [Overview](https://docs.plude.io/usagedata/usagedata.md): Usage event for metered billing. - [Overview](https://docs.plude.io/webhooks/overview.md): Webhooks let you subscribe to Plude events and receive notice when an event occurs. - [Event reference](https://docs.plude.io/webhooks/reference.md) - [Troubleshooting](https://docs.plude.io/webhooks/troubleshoot.md) - [Welcome to Plude](https://docs.plude.io/welcome.md): Learn how we grow with you using our headless capabilities. ## OpenAPI Specs - [openapi](https://docs.plude.io/api-source/openapi.json) ## Optional - [Community](https://pludecommunity.slack.com/) - [Github](https://github.com/plude)