API Reference paddlex v#0.2.0

Copy Markdown View Source

Modules

An Elixir client for the Paddle Classic API.

Resolves library configuration.

Create, list, update, and delete coupons for products or checkouts.

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.

Internal helpers for converting Paddle API responses into structs, dates, and datetimes.

Generate license codes for your framework products.

Create, list, and delete recurring charge modifiers on subscriptions.

Make immediate one-off charges on top of an existing subscription.

Retrieve details of an order after a successful checkout.

Generate custom pay links to charge users for products or subscription plans.

Create and list the subscription plans in your Paddle account.

Retrieve prices for one or more products or subscription plans.

List the one-time products in your Paddle account.

Refund payments made for one-time products or subscriptions.

Low-level HTTP layer for the Paddle API.

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.

List and reschedule payments related to subscriptions.

List transactions for related entities (user, subscription, order, checkout, or product) within Paddle.

Request a link to the transaction history of a customer, sent to their email.

Retrieve past events and alerts that Paddle has sent to your registered webhooks.

Structs for subscription-related webhook payloads sent by Paddle.