# API reference

Use the Paddle API to create, read, and update information in your Paddle system, and integrate Paddle into your app.

---

## Featured

- [Quickstart](https://developer.paddle.com/api-reference/about.md): Everything you need to make your first call to the Paddle API in a few minutes.
- [Authentication](https://developer.paddle.com/api-reference/about/authentication.md): Learn how to get an API key and authenticate your requests.
- [Permissions](https://developer.paddle.com/api-reference/about/permissions.md): Give your key the required permissions to access the API.
- [Pagination](https://developer.paddle.com/api-reference/about/pagination.md): Understand how to work with paginated responses
- [Errors](https://developer.paddle.com/api-reference/about/errors.md): Common error codes, error response shape, and how to handle errors.
- [Related entities](https://developer.paddle.com/api-reference/about/related-entities.md): Use the include parameter to fetch related entities in a single request.

## All pages

### About

- [Quickstart](https://developer.paddle.com/api-reference/about.md)
- [Authentication](https://developer.paddle.com/api-reference/about/authentication.md)
- [Custom data](https://developer.paddle.com/api-reference/about/custom-data.md)
- [Data types](https://developer.paddle.com/api-reference/about/data-types.md)
- [Default scopes](https://developer.paddle.com/api-reference/about/default-scopes.md)
- [Delete entities](https://developer.paddle.com/api-reference/about/delete-entities.md)
- [Errors](https://developer.paddle.com/api-reference/about/errors.md)
- [Filter and sort](https://developer.paddle.com/api-reference/about/filter-search-sort.md)
- [Paddle IDs](https://developer.paddle.com/api-reference/about/paddle-ids.md)
- [Pagination](https://developer.paddle.com/api-reference/about/pagination.md)
- [Permissions](https://developer.paddle.com/api-reference/about/permissions.md)
- [Rate limiting](https://developer.paddle.com/api-reference/about/rate-limiting.md)
- [Related entities](https://developer.paddle.com/api-reference/about/include-entities.md)
- [Rotate API keys](https://developer.paddle.com/api-reference/about/rotate-api-keys.md)
- [Success responses](https://developer.paddle.com/api-reference/about/success-responses.md)
- [Versioning](https://developer.paddle.com/api-reference/about/versioning.md)
- [Work with lists](https://developer.paddle.com/api-reference/about/lists.md)

### Addresses

- [Overview](https://developer.paddle.com/api-reference/addresses.md)
- [List addresses for a customer](https://developer.paddle.com/api-reference/addresses/list-addresses.md)
- [Create an address for a customer](https://developer.paddle.com/api-reference/addresses/create-address.md)
- [Get an address for a customer](https://developer.paddle.com/api-reference/addresses/get-address.md)
- [Update an address for a customer](https://developer.paddle.com/api-reference/addresses/update-address.md)

### Adjustments

- [Overview](https://developer.paddle.com/api-reference/adjustments.md)
- [List adjustments](https://developer.paddle.com/api-reference/adjustments/list-adjustments.md)
- [Create an adjustment](https://developer.paddle.com/api-reference/adjustments/create-adjustment.md)
- [Get a PDF credit note for an adjustment](https://developer.paddle.com/api-reference/adjustments/get-adjustment-credit-note.md)

### Businesses

- [Overview](https://developer.paddle.com/api-reference/businesses.md)
- [List businesses for a customer](https://developer.paddle.com/api-reference/businesses/list-businesses.md)
- [Create a business for a customer](https://developer.paddle.com/api-reference/businesses/create-business.md)
- [Get a business for a customer](https://developer.paddle.com/api-reference/businesses/get-business.md)
- [Update a business for a customer](https://developer.paddle.com/api-reference/businesses/update-business.md)

### Client-side tokens

- [Overview](https://developer.paddle.com/api-reference/client-tokens.md)
- [List client-side tokens](https://developer.paddle.com/api-reference/client-tokens/list-client-tokens.md)
- [Create a client-side token](https://developer.paddle.com/api-reference/client-tokens/create-client-token.md)
- [Get a client-side token](https://developer.paddle.com/api-reference/client-tokens/get-client-token.md)
- [Update a client-side token](https://developer.paddle.com/api-reference/client-tokens/update-client-token.md)

### Customer portal sessions

- [Overview](https://developer.paddle.com/api-reference/customer-portals.md)
- [Create a customer portal session](https://developer.paddle.com/api-reference/customer-portals/create-customer-portal-session.md)

### Customers

- [Overview](https://developer.paddle.com/api-reference/customers.md)
- [List customers](https://developer.paddle.com/api-reference/customers/list-customers.md)
- [Create a customer](https://developer.paddle.com/api-reference/customers/create-customer.md)
- [Get a customer](https://developer.paddle.com/api-reference/customers/get-customer.md)
- [Update a customer](https://developer.paddle.com/api-reference/customers/update-customer.md)
- [List credit balances for a customer](https://developer.paddle.com/api-reference/customers/list-credit-balances.md)
- [Generate an authentication token for a customer](https://developer.paddle.com/api-reference/customers/generate-customer-authentication-token.md)

### Discount groups

- [Overview](https://developer.paddle.com/api-reference/discount-groups.md)
- [List discount groups](https://developer.paddle.com/api-reference/discount-groups/list-discount-groups.md)
- [Create a discount group](https://developer.paddle.com/api-reference/discount-groups/create-discount-group.md)
- [Get a discount group](https://developer.paddle.com/api-reference/discount-groups/get-discount-group.md)
- [Update a discount group](https://developer.paddle.com/api-reference/discount-groups/update-discount-group.md)

### Discounts

- [Overview](https://developer.paddle.com/api-reference/discounts.md)
- [List discounts](https://developer.paddle.com/api-reference/discounts/list-discounts.md)
- [Create a discount](https://developer.paddle.com/api-reference/discounts/create-discount.md)
- [Get a discount](https://developer.paddle.com/api-reference/discounts/get-discount.md)
- [Update a discount](https://developer.paddle.com/api-reference/discounts/update-discount.md)

### Event types

- [Overview](https://developer.paddle.com/api-reference/event-types.md)
- [List events types](https://developer.paddle.com/api-reference/event-types/list-event-types.md)

### Events

- [Overview](https://developer.paddle.com/api-reference/events.md)
- [List events](https://developer.paddle.com/api-reference/events/list-events.md)

### IP addresses

- [Get Paddle IP addresses](https://developer.paddle.com/api-reference/ip-addresses/get-ip-addresses.md)

### Metrics

- [Overview](https://developer.paddle.com/api-reference/metrics.md)
- [Get active subscribers metrics](https://developer.paddle.com/api-reference/metrics/get-metrics-active-subscribers.md)
- [Get chargeback metrics](https://developer.paddle.com/api-reference/metrics/get-metrics-chargebacks.md)
- [Get checkout conversion metrics](https://developer.paddle.com/api-reference/metrics/get-metrics-checkout-conversion.md)
- [Get MRR (monthly recurring revenue) metrics](https://developer.paddle.com/api-reference/metrics/get-metrics-monthly-recurring-revenue.md)
- [Get MRR change (monthly recurring revenue change) metrics](https://developer.paddle.com/api-reference/metrics/get-metrics-monthly-recurring-revenue-change.md)
- [Get refund metrics](https://developer.paddle.com/api-reference/metrics/get-metrics-refunds.md)
- [Get net revenue metrics](https://developer.paddle.com/api-reference/metrics/get-metrics-revenue.md)

### Notification logs

- [Overview](https://developer.paddle.com/api-reference/notification-logs.md)
- [List logs for a notification](https://developer.paddle.com/api-reference/notification-logs/list-notification-logs.md)

### Notification settings

- [Overview](https://developer.paddle.com/api-reference/notification-settings.md)
- [List notification settings](https://developer.paddle.com/api-reference/notification-settings/list-notification-settings.md)
- [Create a notification setting](https://developer.paddle.com/api-reference/notification-settings/create-notification-setting.md)
- [Get a notification setting](https://developer.paddle.com/api-reference/notification-settings/get-notification-setting.md)
- [Update a notification setting](https://developer.paddle.com/api-reference/notification-settings/update-notification-setting.md)
- [Delete a notification setting](https://developer.paddle.com/api-reference/notification-settings/delete-notification-setting.md)

### Notifications

- [Overview](https://developer.paddle.com/api-reference/notifications.md)
- [List notifications](https://developer.paddle.com/api-reference/notifications/list-notifications.md)
- [Get a notification](https://developer.paddle.com/api-reference/notifications/get-notification.md)
- [Replay a notification](https://developer.paddle.com/api-reference/notifications/replay-notification.md)

### Prices

- [Overview](https://developer.paddle.com/api-reference/prices.md)
- [List prices](https://developer.paddle.com/api-reference/prices/list-prices.md)
- [Create a price](https://developer.paddle.com/api-reference/prices/create-price.md)
- [Get a price](https://developer.paddle.com/api-reference/prices/get-price.md)
- [Update a price](https://developer.paddle.com/api-reference/prices/update-price.md)

### Pricing preview

- [Overview](https://developer.paddle.com/api-reference/pricing-preview.md)
- [Preview prices](https://developer.paddle.com/api-reference/pricing-preview/preview-prices.md)

### Products

- [Overview](https://developer.paddle.com/api-reference/products.md)
- [List products](https://developer.paddle.com/api-reference/products/list-products.md)
- [Create a product](https://developer.paddle.com/api-reference/products/create-product.md)
- [Get a product](https://developer.paddle.com/api-reference/products/get-product.md)
- [Update a product](https://developer.paddle.com/api-reference/products/update-product.md)

### Reports

- [Overview](https://developer.paddle.com/api-reference/reports.md)
- [List reports](https://developer.paddle.com/api-reference/reports/list-reports.md)
- [Create a report](https://developer.paddle.com/api-reference/reports/create-report.md)
- [Get a report](https://developer.paddle.com/api-reference/reports/get-report.md)
- [Get a CSV file for a report](https://developer.paddle.com/api-reference/reports/get-report-csv.md)

### Saved payment methods

- [Overview](https://developer.paddle.com/api-reference/payment-methods.md)
- [List payment methods for a customer](https://developer.paddle.com/api-reference/payment-methods/list-customer-payment-methods.md)
- [Get a payment method for a customer](https://developer.paddle.com/api-reference/payment-methods/get-customer-payment-method.md)
- [Delete a payment method for a customer](https://developer.paddle.com/api-reference/payment-methods/delete-customer-payment-method.md)

### Simulation run events

- [Overview](https://developer.paddle.com/api-reference/simulation-run-events.md)
- [List events for a simulation run](https://developer.paddle.com/api-reference/simulation-run-events/list-simulations-events.md)
- [Get an event for a simulation run](https://developer.paddle.com/api-reference/simulation-run-events/get-simulation-event.md)
- [Replay an event for a simulation run](https://developer.paddle.com/api-reference/simulation-run-events/replay-simulation-run-event.md)

### Simulation runs

- [Overview](https://developer.paddle.com/api-reference/simulation-runs.md)
- [List runs for a simulation](https://developer.paddle.com/api-reference/simulation-runs/list-simulation-runs.md)

### Simulation types

- [Overview](https://developer.paddle.com/api-reference/simulation-types.md)
- [List simulation types](https://developer.paddle.com/api-reference/simulation-types/list-simulation-types.md)

### Simulations

- [Overview](https://developer.paddle.com/api-reference/simulations.md)
- [List simulations](https://developer.paddle.com/api-reference/simulations/list-simulations.md)
- [Create a simulation](https://developer.paddle.com/api-reference/simulations/create-simulation.md)
- [Get a simulation](https://developer.paddle.com/api-reference/simulations/get-simulation.md)
- [Update a simulation](https://developer.paddle.com/api-reference/simulations/update-simulation.md)
- [Create a run for a simulation](https://developer.paddle.com/api-reference/simulations/create-simulation-run.md)
- [Get a run for a simulation](https://developer.paddle.com/api-reference/simulations/get-simulation-run.md)

### Subscriptions

- [Overview](https://developer.paddle.com/api-reference/subscriptions.md)
- [List subscriptions](https://developer.paddle.com/api-reference/subscriptions/list-subscriptions.md)
- [Get a subscription](https://developer.paddle.com/api-reference/subscriptions/get-subscription.md)
- [Update a subscription](https://developer.paddle.com/api-reference/subscriptions/update-subscription.md)
- [Get a transaction to update payment method](https://developer.paddle.com/api-reference/subscriptions/get-subscription-update-payment-method-transaction.md)
- [Activate a trialing subscription](https://developer.paddle.com/api-reference/subscriptions/activate-subscription.md)
- [Cancel a subscription](https://developer.paddle.com/api-reference/subscriptions/cancel-subscription.md)
- [Create a one-time charge for a subscription](https://developer.paddle.com/api-reference/subscriptions/create-subscription-charge.md)
- [Pause a subscription](https://developer.paddle.com/api-reference/subscriptions/pause-subscription.md)
- [Resume a paused subscription](https://developer.paddle.com/api-reference/subscriptions/resume-subscription.md)
- [Preview an update to a subscription](https://developer.paddle.com/api-reference/subscriptions/preview-subscription-update.md)
- [Preview a one-time charge for a subscription](https://developer.paddle.com/api-reference/subscriptions/preview-subscription-charge.md)

### Transactions

- [Overview](https://developer.paddle.com/api-reference/transactions.md)
- [List transactions](https://developer.paddle.com/api-reference/transactions/list-transactions.md)
- [Create a transaction](https://developer.paddle.com/api-reference/transactions/create-transaction.md)
- [Get a transaction](https://developer.paddle.com/api-reference/transactions/get-transaction.md)
- [Preview a transaction](https://developer.paddle.com/api-reference/transactions/preview-transaction-create.md)
- [Update a transaction](https://developer.paddle.com/api-reference/transactions/update-transaction.md)
- [Get a PDF invoice for a transaction](https://developer.paddle.com/api-reference/transactions/get-transaction-invoice.md)
- [Revise customer information on a billed or completed transaction](https://developer.paddle.com/api-reference/transactions/revise-transaction.md)