# paddlex v0.2.0 - Table of Contents

> A Paddle client for Elixir.

## Pages

- [Paddlex](readme.md)
- [Changelog](changelog.md)

## Modules

- [Paddle](Paddle.md): An Elixir client for the [Paddle Classic API](https://developer.paddle.com/classic/api-reference).
- [Paddle.Config](Paddle.Config.md): Resolves library configuration.
- [Paddle.Error](Paddle.Error.md): Error struct returned by all API functions: `code` holds the Paddle API error code (or a transport-level atom such as `:econnrefused`) and `message` a human-readable description.

- [Paddle.Helpers](Paddle.Helpers.md): Internal helpers for converting Paddle API responses into structs, dates, and datetimes.

- [Paddle.Request](Paddle.Request.md): Low-level HTTP layer for the Paddle API.
- [Paddle.Webhooks.SubscriptionWebhook](Paddle.Webhooks.SubscriptionWebhook.md): Structs for subscription-related webhook payloads sent by Paddle.

- Alert
  - [Paddle.Webhook](Paddle.Webhook.md): Retrieve past events and alerts that Paddle has sent to your registered webhooks.

- Checkout
  - [Paddle.OrderDetails](Paddle.OrderDetails.md): Retrieve details of an order after a successful checkout.

  - [Paddle.Price](Paddle.Price.md): Retrieve prices for one or more products or subscription plans.

  - [Paddle.UserHistory](Paddle.UserHistory.md): Request a link to the transaction history of a customer, sent to their email.

- Product
  - [Paddle.Coupon](Paddle.Coupon.md): Create, list, update, and delete coupons for products or checkouts.

  - [Paddle.License](Paddle.License.md): Generate license codes for your framework products.

  - [Paddle.PayLink](Paddle.PayLink.md): Generate custom pay links to charge users for products or subscription plans.

  - [Paddle.Product](Paddle.Product.md): List the one-time products in your Paddle account.

  - [Paddle.ProductPayment](Paddle.ProductPayment.md): Refund payments made for one-time products or subscriptions.

  - [Paddle.Transaction](Paddle.Transaction.md): List transactions for related entities (user, subscription, order, checkout, or product) within Paddle.

- Subscription
  - [Paddle.Modifier](Paddle.Modifier.md): Create, list, and delete recurring charge modifiers on subscriptions.

  - [Paddle.OneOffCharge](Paddle.OneOffCharge.md): Make immediate one-off charges on top of an existing subscription.

  - [Paddle.Plan](Paddle.Plan.md): Create and list the subscription plans in your Paddle account.

  - [Paddle.Subscription](Paddle.Subscription.md): This module corresponds to the `subscription/users` endpoint in the Paddle API,
I've changed the name to Subscription as I found it to be more accurate.

  - [Paddle.SubscriptionPayment](Paddle.SubscriptionPayment.md): List and reschedule payments related to subscriptions.

