Paddle

Activates a trialing subscription using its ID. Only automatically-collected subscriptions where the status is `trialing` can be activated. On activation, Paddle bills for a subscription immediately. Subscription billing dates are recalculated based on the activation date (the time the activation request is made). If successful, Paddle returns a copy of the updated subscription entity. The subscription status is `active`, and billing dates are updated to reflect the activation date. This operation results in an immediate charge, so responses may take longer than usual while a payment attempt is processed.

Cancels a subscription using its ID. By default, active subscriptions are canceled at the end of the billing period. When you send a request to cancel, Paddle creates a `scheduled_change` against the subscription entity to say that it should cancel at the end of the current billing period. Its `status` remains `active` until after the effective date of the scheduled change, at which point it changes to `canceled`. You can cancel a subscription right away by including `effective_from` in your request, setting the value to `immediately`. If successful, your response includes a copy of the updated subscription entity with the `status` of `canceled`. Canceling immediately is the default behavior for paused subscriptions. You can't reinstate a canceled subscription.

Creates a new address for a customer. For tax calculation, fraud prevention, and compliance purposes, you must include a `postal_code` when creating addresses for some countries. For example, ZIP codes in the USA and postcodes in the UK. See: [Supported countries](https://developer.paddle.com/concepts/sell/supported-countries-locales) If successful, your response includes a copy of the new address entity.

Creates an adjustment for one or more transaction items. You can create adjustments to refund or credit all or part of a transaction and its items: * Refunds return an amount to a customer's original payment method. You can create refund adjustments for transactions that are `completed`. * Credits reduce the amount that a customer has to pay for a transaction. You can create credit adjustments for manually-collected transactions that are `billed` or `past_due`. You can create adjustments to refund transactions that are `completed`, or to reduce the amount to due on manually-collected transactions that are `billed` or `past_due`. Most refunds for live accounts are created with the status of `pending_approval` until reviewed by Paddle, but [some are automatically approved](https://developer.paddle.com/build/transactions/create-transaction-adjustments#background-refunds). For sandbox accounts, Paddle automatically approves refunds every ten minutes. Adjustments can apply to some or all items on a transaction. You'll need the Paddle ID of the transaction to create a refund or credit for, along with the Paddle ID of any transaction items (`details.line_items[].id`). If successful, your response includes a copy of the new adjustment entity.

Creates a new business for a customer. If successful, your response includes a copy of the new business entity.

Creates a new client-side token. If successful, your response includes a copy of the new client-side token entity.

Creates a new customer. If successful, your response includes a copy of the new customer entity.

Creates a customer portal session for a customer. The [customer portal](https://developer.paddle.com/concepts/customer-portal) is a secure, Paddle-hosted site that allows customers to manage their own subscriptions, payments, and account information without you having to build custom billing screens. Customers can: * View transaction history * Download invoices * Update payment methods * Manage their subscriptions including making changes or cancellations * Revise details on completed transactions You can create a customer portal session to generate authenticated links for a customer so that they're automatically signed in to the portal. It's typically used when linking to the customer portal from your app where customers are already authenticated. You can include an array of `subscription_ids` to generate authenticated portal links that let customers make changes to their subscriptions. You can use these links as part of subscription management workflows rather than building your own billing screens. Customer portal sessions are temporary and shouldn't be cached. The customer portal is fully hosted by Paddle. For security and the best customer experience, don't embed the customer portal in an iframe.

Creates a new discount. If successful, your response includes a copy of the new discount entity.

Creates a new discount group. If successful, your response includes a copy of the new discount group entity.

Creates a new notification setting (notification destination). Pass an array of event type names to `subscribed_events` to say which events you'd like to subscribe to. Paddle responds with the full event type object for each event type. If successful, your response includes a copy of the new notification setting entity. Use the returned `endpoint_secret_key` for webhook signature verification.

Creates a new price. Prices describe how you charge for products. You must include a `product_id` in your request to relate this price to a product. If you omit the `quantity` object, Paddle automatically sets a minimum of `1` and a maximum of `100` for you. This means the most units that a customer can buy is 100. Set a quantity if you'd like to offer a different amount. If successful, your response includes a copy of the new price entity.

Creates a new product. Paddle does not upload product images to a CDN. For `image_url`, you should host images on an HTTPS server that's publicly accessible. We recommend using square images (`1:1` ratio). If successful, your response includes a copy of the new product entity.

Creates a new report. Reports are created as `pending` initially while Paddle generates your report. They move to `ready` when they're ready to download. You can download a report when it's ready using the [get a CSV file for a report operation](https://developer.paddle.com/api-reference/reports/get-report-csv). If successful, your response includes a copy of the new report entity.

Creates a new simulation for a notification setting (notification destination). simulated webhook payloads with real data. The API key making the request needs read permissions: * For the entities you provided, or the request fails. * For related entities which aren't nested in the entities you provided, or static examples will be used instead. For example, when creating a subscription renewal scenario simulation with an API key that has a `subscription.read` permission but not a `transaction.read` permission, the request succeeds and the subscription data will be used in simulated payloads, but the related transaction data won't be used in payloads and falls back to a static example. If you don't provide a `config.entities` object, simulated webhook payloads are populated with static examples. If successful, your response includes a copy of the new simulation entity.

Creates a new simulation run for a simulation. If successful, your response includes a copy of the new simulation run entity.

Creates a new one-time charge for a subscription. Use to bill non-recurring items to a subscription. Non-recurring items are price entities where the `billing_cycle` is `null`. If successful, Paddle responds with the updated subscription entity. However, one-time charges aren't held against the subscription entity, so the charges billed aren't returned in the response. Once created, to get details of a one-time charge: * When created with `effective_from` as `next_billing_period`, get the subscription the charge was billed to and use the `include` query parameter with the `next_transaction` value. * When created with `effective_from` as `immediately`, list transactions and use the `subscription_id` query parameter with the subscription ID of the subscription the charge was billed to. When an update results in an immediate charge, responses may take longer than usual while a payment attempt is processed.

Creates a new transaction. Transactions are typically created with the status of `draft` or `ready` initially: * Draft transactions have `items` against them, but don't have all of the required fields for billing. Paddle creates draft transactions automatically when a checkout is opened. * Paddle automatically marks transactions as `ready` when all of the required fields are present for billing. This includes `customer_id` and `address_id` for automatically-collected transactions, and `billing_details` for manually-collected transactions. The `collection_mode` against a transaction determines how Paddle tries to collect for payment: * Manually-collected transactions are for sales-assisted billing. Paddle sends an invoice to your customer when a transaction is `billed`. Payment is often by wire transfer. * Automatically-collected transactions are for self-serve checkouts. You may pass the transaction to a checkout or use the returned `checkout.url` to collect for payment. When a manually-collected transaction is marked as `billed` or an automatically-collected transaction is `completed`, Paddle automatically creates a related subscription for the items on the transaction. If successful, your response includes a copy of the new transaction entity. Use the `include` parameter to include related entities in the response.

Deletes a customer payment method using its ID. Deleted payment methods are no longer saved and presented to the customer for future purchases. Saved payment methods can't be deleted if tied to an `active`, `trialing`, `paused`, or `past_due` subscription. Update the subscription's payment method first, then delete the saved payment method. There's no way to recover a deleted saved payment method. It's permanently removed from that customer.

Deletes a notification setting (notification destination) using its ID. When you delete a notification setting, it's permanently removed from your account. Paddle stops sending events to your destination, and you'll lose access to all the logs for this notification setting. There's no way to recover a deleted notification setting. Deactivate a notification setting using the update notification setting operation if you'll need access to the logs or want to reactivate later on.

Generates an authentication token for a customer. You can pass a generated authentication token to Paddle.js when opening a checkout to let customers work with saved payment methods. Authentication tokens are temporary and shouldn't be cached. They're valid until the `expires_at` date returned in the response.

Returns an address for a customer using its ID and related customer ID.

Returns a link to a credit note PDF for an adjustment. Credit note PDFs are created for refunds and credits as a record of an adjustment. The link returned is not a permanent link. It expires after an hour.

Returns a business for a customer using its ID and related customer ID.

Returns a client-side token using its ID.

Returns a customer using its ID.

Returns a payment method for a customer using its ID and related customer ID.

Returns a discount using its ID.

Returns a discount group using its ID.

Returns Paddle IP addresses. You can add these IP addresses to your allowlist. IP addresses returned are for the environment that you're making the request in. For example, making the request to the production base URL returns all production IP addresses.

Returns a notification using its ID. Notifications older than 90 days aren't retained. If you try to get a notification that's no longer retained, Paddle returns an error.

Returns a notification setting (notification destination) using its ID.

Returns a price using its ID. Use the `include` parameter to include the related product entity in the response.

Returns a product using its ID. Use the `include` parameter to include related price entities in the response.

Returns a report using its ID.

Returns a link to a CSV file for a report. Only returned for reports that are `ready`. This means Paddle has completed processing the report and it's ready to download. The link returned is not a permanent link. It expires after 3 minutes.

Returns a simulation using its ID.

Returns a simulation event using its ID.

Returns a simulation run using its ID. Use the `include` parameter to include related entities in the response.

Returns a subscription using its ID. Use the `include` parameter to include transaction information in the response.

Returns a transaction that you can pass to a checkout to let customers update their payment details. Only for subscriptions where `collection_mode` is `automatic`. The transaction returned depends on the status of the related subscription: * Where a subscription is `past_due`, it returns the most recent `past_due` transaction. * Where a subscription is `active`, it creates a new zero amount transaction for the items on a subscription. You can use the returned `checkout.url`, or pass the returned transaction ID to Paddle.js to open a checkout to present customers with a way of updating their payment details. The `customer`, `address`, `business`, `discount`, `adjustments` and `adjustments_totals` properties are only returned in the response if the API key has read permissions for those related entities.

Returns a transaction using its ID. Use the `include` parameter to include related entities in the response.

Returns a link to an invoice PDF for a transaction. Invoice PDFs are available for both automatically and manually-collected transactions: * The PDF for manually-collected transactions includes payment terms, purchase order number, and notes for your customer. It's a demand for payment from your customer. It's available for transactions that are `billed` or `completed`. * The PDF for automatically-collected transactions lets your customer know that payment was taken successfully. Customers may require this for for tax-reporting purposes. It's available for transactions that are `completed`. Invoice PDFs aren't available for zero-value transactions. The link returned is not a permanent link. It expires after an hour.

Returns a paginated list of addresses for a customer. Use the query parameters to page through results. By default, Paddle returns addresses that are `active`. Use the `status` query parameter to return addresses that are archived.

Returns a paginated list of adjustments. Use the query parameters to page through results.

Returns a paginated list of businesses for a customer. Use the query parameters to page through results. By default, Paddle returns businesses that are `active`. Use the `status` query parameter to return businesses that are archived.

Returns a paginated list of client-side tokens. Use the query parameters to [page through results](https://developer.paddle.com/api-reference/about/pagination).

Returns a list of credit balances for each currency for a customer. Each balance has three totals: * `available`: total available to use. * `reserved`: total temporarily reserved for billed transactions. * `used`: total amount of credit used. Credit is added to the `available` total initially. When used, it moves to the `used` total. The `reserved` total is used when a credit balance is applied to a transaction that's marked as `billed`, like when working with an issued invoice. It's not available for other transactions at this point, but isn't considered `used` until the transaction is completed. If a `billed` transaction is `canceled`, any reserved credit moves back to `available`. Credit balances are created automatically by Paddle when you take an action that results in Paddle creating a credit for a customer, like making prorated changes to a subscription. An empty `data` array is returned where a customer has no credit balances. The response is not paginated.

Returns a paginated list of payment methods that a customer has saved. Use the query parameters to page through results. Customers can choose to save payment methods when purchasing one-time items and subscriptions by checking a box when completing checkout. You can present customers with their saved payment methods when they make a purchase in the future. Returns an empty list where customers have not saved any payment methods, or have deleted all previously saved payment methods.

Returns a paginated list of customers. Use the query parameters to page through results. By default, Paddle returns customers that are `active`. Use the `status` query parameter to return customers that are archived.

Returns a paginated list of discount groups. Use the query parameters to page through results.

Returns a paginated list of discounts. Use the query parameters to page through results. By default, Paddle returns discounts that are `active`. Use the `status` query parameter to return discounts that are archived or expired.

Returns a list of event types. The response is not paginated.

Returns a paginated list of events that have occurred in the last 90 days. Use the query parameters to page through results. Events older than 90 days aren't retained. This is sometimes referred to as "the event stream."

Returns a paginated list of notification logs for a notification. A log includes information about delivery attempts, including failures. Notifications older than 90 days aren't retained. If you try to list logs for a notification that's no longer retained, Paddle returns an error.

Returns a paginated list of notification settings (notification destinations).

Returns a paginated list of notifications created in the last 90 days. Use the query parameters to page through results. Notifications older than 90 days aren't retained.

Returns a paginated list of prices. Use the query parameters to page through results. By default, Paddle returns prices that are `active`. Use the `status` query parameter to return prices that are archived. Use the `include` parameter to include the related product entity in the response.

Returns a paginated list of products. Use the query parameters to page through results. By default, Paddle returns products that are `active`. Use the `status` query parameter to return products that are archived. Use the `include` parameter to include related price entities in the response.

Returns a paginated list of reports. Use the query parameters to page through results. By default, Paddle returns reports that are `pending` or `ready`. Use the `status` query parameter to return reports that are `failed`, `expired`, or `deleted`.

Returns a paginated list of simulation runs. Use the query parameters to [page through results](https://developer.paddle.com/api-reference/about/pagination). Use the `include` parameter to [include related entities](https://developer.paddle.com/api-reference/about/include-entities) in the response.

Returns a list of simulation types (events and scenarios) that you can choose from when creating simulations.

Returns a paginated list of simulations. Use the query parameters to [page through results](https://developer.paddle.com/api-reference/about/pagination).

Returns a paginated list of simulations. Use the query parameters to [page through results](https://developer.paddle.com/api-reference/about/pagination).

Returns a paginated list of subscriptions. Use the query parameters to page through results.

Returns a paginated list of transactions. Use the query parameters to page through results. Use the `include` parameter to include related entities in the response.

Pauses a subscription using its ID. By default, subscriptions are paused at the end of the billing period. When you send a request to pause, Paddle creates a `scheduled_change` against the subscription entity to say that it should pause at the end of the current billing period. Its `status` remains `active` until after the effective date of the scheduled change, at which point it changes to `paused`. You can pause a subscription right away by including `effective_from` in your request, setting the value to `immediately`. If successful, your response includes a copy of the updated subscription entity with the `status` of `paused`. To set a resume date, include the `resume_at` field in your request. The subscription remains paused until the resume date, or until you send a resume request. Omit to create an open-ended pause. The subscription remains paused indefinitely, until you send a resume request.

Previews calculations for one or more prices. Typically used for building pricing pages. You can provide location information when previewing prices. You must provide this if you want Paddle to calculate tax or [automatically localize prices](https://developer.paddle.com/build/products/offer-localized-pricing). You can provide one of: * `customer_ip_address`: Paddle fetches location using the IP address to calculate totals. * `address`: Paddle uses the country and ZIP code (where supplied) to calculate totals. * `customer_id`, `address_id`, `business_id`: Paddle uses existing customer data to calculate totals. Typically used for logged-in customers. If successful, your response includes the data you sent with a `details` object that includes totals for the supplied prices. Each line item includes `formatted_unit_totals` and `formatted_totals` objects that return totals formatted for the country or region you're working with, including the currency symbol. You can work with the preview prices operation using the [`Paddle.PricePreview()`](https://developer.paddle.com/paddlejs/methods/paddle-pricepreview) method in Paddle.js. When working with `Paddle.PricePreview()`, request and response fields are `camelCase` rather than `snake_case`.

Previews creating a one-time charge for a subscription without billing that charge. Typically used for previewing calculations before making changes to a subscription. One-time charges are non-recurring items. These are price entities where the `billing_cycle` is `null`. If successful, your response includes `immediate_transaction`, `next_transaction`, and `recurring_transaction_details` so you can see expected transactions for the changes.

Previews an update for a subscription without applying those changes. Typically used for previewing proration before making changes to a subscription. If successful, your response includes `immediate_transaction`, `next_transaction`, and `recurring_transaction_details` so you can see expected transactions for the changes. The `update_summary` object contains details of prorated credits and charges created, along with the overall result of the update.

Previews a transaction without creating a transaction entity. Typically used for creating more advanced, dynamic pricing pages where users can build their own plans. Consider using [the preview prices operation](https://developer.paddle.com/api-reference/pricing-preview/preview-prices) for simpler pricing pages. You can provide location information when previewing a transaction. You must provide this if you want Paddle to calculate tax or [automatically localize prices](https://developer.paddle.com/build/products/offer-localized-pricing). You can provide one of: * `customer_ip_address`: Paddle fetches location using the IP address to calculate totals. * `address`: Paddle uses the country and ZIP code (where supplied) to calculate totals. * `customer_id`, `address_id`, `business_id`: Paddle uses existing customer data to calculate totals. Typically used for logged-in customers. When supplying items, you can exclude items from the total calculation using the `include_in_totals` boolean. By default, recurring items with trials are considered to have a zero charge when previewing. Set `ignore_trials` to `true` to ignore trial periods against prices for transaction preview calculations. If successful, your response includes the data you sent with a `details` object that includes totals for the supplied prices. Transaction previews don't create transactions, so no `id` is returned.

Attempts to resend a `delivered` or `failed` notification using its ID. Paddle creates a new notification entity for the replay, related to the same `event_id`. Your response includes the new `notification_id` of the created notification. Notifications older than 90 days aren't retained. If you try to replay a notification that's no longer retained, Paddle returns an error. Only notifications with the `origin` of `event` can be replayed. You can't replay a notification created for a replay.

Attempts to resend a simulation run log using its ID. Paddle creates a new simulation run log entity for the replay, related to the same simulation run. If successful, your response includes the new simulation run log entity.

Resumes a paused subscription using its ID. Only `paused` subscriptions can be resumed. If an `active` subscription has a scheduled change to pause in the future, use this operation to set or change the resume date. You can't resume a `canceled` subscription. On resume, Paddle bills for a subscription immediately by default. Subscription billing dates are recalculated based on the resume date. Use the `on_resume` field to change this behavior. If successful, Paddle returns a copy of the updated subscription entity: * When resuming a `paused` subscription immediately, the subscription status is `active`, and billing dates are updated to reflect the resume date. * When scheduling a `paused` subscription to resume on a date in the future, the subscription status is `paused`, and `scheduled_change.resume_at` is updated to reflect the scheduled resume date. * When changing the resume date for an `active` subscription that's scheduled to pause, the subscription status is `active` and `scheduled_change.resume_at` is updated to reflect the scheduled resume date. This operation may result in an immediate charge, so responses may take longer than usual while a payment attempt is processed.

Revises customer information for a billed or completed transaction. Revise a transaction to rectify incorrect customer, address, or business information on invoice documents generated by Paddle. You can revise transaction details that don't impact the tax rates on a transaction. This includes: * Customer name * Business name and tax or VAT number (`tax_identifier`) * Address details, apart from the country You can't remove a valid tax or VAT number, only replace it with another valid one. If a valid tax or VAT number is added, Paddle automatically creates an adjustment to refund any tax where applicable. Transactions can only be revised once. If successful, your response includes a copy of the transaction entity. [Get a transaction](https://developer.paddle.com/api-reference/transactions/get-transaction) using the `include` parameter with the `customer`, `address`, and `business` values to see the revised customer information. Only the customer information for this transaction is updated. The related customer, address, and business entities aren't updated.

Updates an address for a customer using its ID and related customer ID. If successful, your response includes a copy of the updated address entity.

Updates a business for a customer using its ID and related customer ID. If successful, your response includes a copy of the updated business entity.

Updates a client-side token using its ID. You can revoke a client-side token by changing its `status` to `revoked`. Client-side tokens that are revoked can't be updated to `active`. If successful, your response includes a copy of the updated client-side token entity.

Updates a customer using its ID. If successful, your response includes a copy of the updated customer entity.

Updates a discount using its ID. If successful, your response includes a copy of the updated discount entity. To update a checkout recovery discount, configure your checkout recovery settings in the dashboard.

Updates a discount group using its ID. If successful, your response includes a copy of the updated discount group entity.

Updates a notification setting (notification destination) using its ID. When updating subscribed events, send the complete list of event types that you'd like to subscribe to — including existing event types. If you omit event types, they're removed from the notification setting. You only need to pass an event type name. Paddle responds with the full event type object for each event type. If successful, your response includes a copy of the updated notification setting entity.

Updates a price using its ID. If successful, your response includes a copy of the updated price entity.

Updates a product using its ID. Paddle does not upload product images to a CDN. For `image_url`, you should host images on an HTTPS server that's publicly accessible. We recommend using square images (`1:1` ratio). If successful, your response includes a copy of the updated product entity.

Updates a simulation using its ID. For scenario simulations, you can optionally include a `config.entities` object in the request body with entity IDs to populate simulated webhook payloads with real data. The API key making the request needs read permissions: * For the entities you provided, or the request fails. * For related entities which aren't nested in the entities you provided, or static examples will be used instead. For example, when updating a subscription renewal scenario simulation with an API key that has a `subscription.read` permission but not a `transaction.read` permission, the request succeeds and the subscription data will be used in simulated payloads, but the related transaction data won't be used in payloads and falls back to a static example. If you don't provide a `config.entities` object, simulated webhook payloads are populated with static examples. If successful, your response includes a copy of the updated simulation entity.

Updates a subscription using its ID. When making changes to items or the next billing date for a subscription, you must include the `proration_billing_mode` field to tell Paddle how to bill for those changes. Send the complete list of items that you'd like to be on a subscription — including existing items. If you omit items, they're removed from the subscription. For each item, send `price_id` and `quantity`. Paddle responds with the full price object for each price. If you're updating an existing item, you can omit the `quantity` if you don't want to update it. If successful, your response includes a copy of the updated subscription entity. When an update results in an immediate charge, responses may take longer than usual while a payment attempt is processed.

Updates a transaction using its ID. You can update transactions that are `draft` or `ready`. `billed` and `completed` transactions are considered records for tax and legal purposes, so they can't be changed. You can either: * Create [an adjustment](https://developer.paddle.com/api-reference/adjustments/overview) to record a refund or credit for a transaction. * Cancel a `billed` transaction by sending a PATCH request to set `status` to `canceled`. The transaction `status` may only be set to `billed` or `canceled`. Other statuses are set automatically by Paddle. Set a manually-collected transaction to `billed` to mark it as finalized. This is essentially issuing an invoice. At this point, it becomes a legal record so you can't make changes to it. Paddle automatically assigns an invoice number, creates [a related subscription](https://developer.paddle.com/api-reference/subscriptions/overview), and sends it to your customer. When making changes to items on a transaction, send the complete list of items that you'd like to be on a transaction — including existing items. For each item, send an object containing `price_id` and `quantity`. Paddle responds with the full `price` object for each item. See: [Work with lists](https://developer.paddle.com/api-reference/about/lists) If successful, your response includes a copy of the updated transaction entity.