Connect Claude & ChatGPT to Paddle

99 tools for Paddle

These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.

• cancel_subscriptionDeletesCancel a subscription by `subscription_id`, either at the end of the billing period or immediately (`effective_from`). Immediate cancellation cannot be undone.
• create_a_customer_portal_sessionChanges dataCreate a new customer for a customer. Search customers first to avoid duplicates. API summary: Create a customer portal session.
• create_customerChanges dataCreate a customer with `email` and optional name and locale. Search first to avoid duplicates.
• create_customer_2DeletesCreate a new customer. Required: name. Search customers first to avoid duplicates. Destructive action; may require approval. API summary: Create a client-side token.
• create_customer_addressChanges dataCreate a new address for a customer. Required: country code. Search addresses first to avoid duplicates. API summary: Create an address for a customer.
• create_customer_auth_tokenDeletesCreate a new auth token for a customer. Destructive action; may require approval. API summary: Generate an authentication token for a customer.
• create_customer_companyChanges dataCreate a new company for a customer. Required: name. Search companies first to avoid duplicates. API summary: Create a business for a customer.
• create_discountChanges dataCreate a discount with `type` (percentage or flat), `amount` and `description`, plus optional checkout `code`, expiry and usage limit.
• create_discount_groupChanges dataCreate a new discount group. Required: name. API summary: Create a discount group.
• create_event_replayChanges dataCreate a new replay for a event. API summary: Replay an event for a simulation run.
• create_notification_replayChanges dataCreate a new replay for a notification. API summary: Replay a notification.
• create_notification_settingChanges dataCreate a new notification setting. Required: description, type, destination or subscribed events. API summary: Create a notification setting.
• create_payment_revise_transactionChanges dataCreate a new payment for a payment. API summary: Revise customer information on a billed or completed transaction.
• create_priceChanges dataCreate a price for a `product_id` with `unit_price` (amount in lowest unit + currency) and `description`; add `billing_cycle` for recurring prices.
• create_pricing_previewChanges dataCreate a new pricing preview. Required: items. API summary: Preview prices.
• create_productChanges dataCreate a product with `name` and `tax_category`, plus optional description and image.
• create_refundChanges dataRefund or credit a completed transaction: pass `transaction_id`, `action` (refund or credit), `reason` and `type` (full or partial with `items`). Refunds return money to the customer and cannot be undone.
• create_reportChanges dataCreate a new report. Required: body. API summary: Create a report.
• create_simulationChanges dataCreate a new simulation. Required: body. API summary: Create a simulation.
• create_simulation_runChanges dataCreate a new run for a simulation. API summary: Create a run for a simulation.
• create_subscriptionChanges dataCreate a new subscription for a subscription. API summary: Pause a subscription.
• create_subscription_resume_subscriptionChanges dataCreate a new subscription for a subscription. Required: body. API summary: Resume a paused subscription.
• create_transactionChanges dataCreate a transaction from `items` (price IDs and quantities) for a customer, e.g. to issue an invoice or a checkout. Set `collection_mode` manual to invoice.
• delete_customer_payment_methodDeletesPermanently delete a payment method by payment method id. Destructive action; may require approval. API summary: Delete a payment method for a customer.
• delete_notification_settingDeletesPermanently delete a notification setting by notification setting id. Destructive action; may require approval.
• delete_paymentDeletesPermanently delete a payment by domain id. Destructive action; may require approval. API summary: Delete a checkout domain.
• download_report_urlDownload the document for a report. API summary: Get a CSV file for a report.
• get_active_subscriber_metricsGet the number of active subscribers per day between `from` and `to` dates.
• get_customerGet one customer by `customer_id` (ctm_...), including name, email and status.
• get_customer_2Get one customer by customer id. API summary: Get a client-side token.
• get_customer_addressGet one address for a customer by address id. API summary: Get an address for a customer.
• get_customer_companyGet one company for a customer by company id. API summary: Get a business for a customer.
• get_customer_payment_methodGet one payment method for a customer by payment method id. API summary: Get a payment method for a customer.
• get_discountGet one discount by `discount_id` (dsc_...).
• get_discount_groupGet one discount group by discount group id. API summary: Get a discount group.
• get_mrr_metricsGet monthly recurring revenue (MRR) per day between `from` and `to` dates.
• get_notificationGet one notification by notification id. API summary: Get a notification.
• get_notification_settingGet one notification setting by notification setting id. API summary: Get a notification setting.
• get_paymentGet one payment by domain id. API summary: Get a checkout domain.
• get_priceGet one price by `price_id` (pri_...).
• get_productGet one product by `product_id` (pro_...).
• get_reportGet one report by report id. API summary: Get a report.
• get_revenue_metricsGet net revenue per day between `from` and `to` dates.
• get_run_eventGet one event for a run by simulation event id. API summary: Get an event for a simulation run.
• get_simulationGet one simulation by simulation id. API summary: Get a simulation.
• get_simulation_runGet one run for a simulation by simulation run id. API summary: Get a run for a simulation.
• get_subscriptionGet one subscription by `subscription_id` (sub_...), with items, status, next billing date and scheduled changes.
• get_transactionGet one transaction by ID (txn_...), including items, totals, status and payments.
• get_transaction_invoice_pdfGet a link to the PDF invoice for a billed or completed transaction by `transaction_id`.
• list_addressesList addresses. API summary: Get Paddle IP addresses.
• list_adjustment_credit_notesList credit notes for a adjustment. Optional filters: disposition. API summary: Get a PDF credit note for an adjustment.
• list_adjustmentsList adjustments (refunds and credits), filtered by `customer_id`, `transaction_id`, `subscription_id`, `action` or `status`.
• list_chargebacksList chargebacks. Optional filters: from or to. API summary: Get chargeback metrics.
• list_checkout_conversionsList checkout conversions. Optional filters: from or to. API summary: Get checkout conversion metrics.
• list_customer_credit_balancesList credit balances for a customer. Optional filters: currency code.
• list_customer_payment_methodsList payment methods for a customer. Optional filters: address id, order by or supports checkout. Results are paginated.
• list_customersList or search customers by `search` text, `email`, `id` or `status`. Use to find a customer ID.
• list_customers_2List customers. Optional filters: order by or status. Results are paginated. API summary: List client-side tokens.
• list_discount_groupsList discount groups. Optional filters: id or order by. Results are paginated.
• list_discountsList discounts, filtered by `code`, `status` or `mode`.
• list_event_typesList event types. API summary: List events types.
• list_eventsList events. Optional filters: order by or event type. Results are paginated.
• list_monthly_recurring_revenue_changesList monthly recurring revenue changes. Optional filters: from or to. API summary: Get MRR change (monthly recurring revenue change) metrics.
• list_notification_logsList logs for a notification. Results are paginated.
• list_notification_settingsList notification settings. Optional filters: order by, active or traffic source. Results are paginated.
• list_paymentsList payments. Optional filters: id, domain, order by or status. Results are paginated. API summary: List checkout domains.
• list_pricesList prices, filtered by `product_id`, `status`, `recurring` or billing cycle.
• list_productsList products, filtered by `status`, `type` or `tax_category`.
• list_refundsList refunds. Optional filters: from or to. API summary: Get refund metrics.
• list_reportsList reports. Optional filters: order by or status. Results are paginated.
• list_run_eventsList events for a run. Optional filters: id or order by. Results are paginated. API summary: List events for a simulation run.
• list_simulation_runsList runs for a simulation. Optional filters: id or order by. Results are paginated.
• list_simulation_typesList simulation types.
• list_simulationsList simulations. Optional filters: id, notification setting id, order by or status. Results are paginated.
• list_subscription_historiesList histories for a subscription. Optional filters: action, source, actor type, actor id, reason or occurred at. Results are paginated. API summary: List history for a subscription.
• list_subscriptionsList subscriptions, filtered by `customer_id`, `status`, `price_id`, `next_billed_at` or `scheduled_change_action`.
• list_transactionsList transactions (orders, renewals, invoices), filtered by `customer_id`, `subscription_id`, `status`, `invoice_number`, `billed_at` or `created_at`.
• pay_subscriptionMoves moneyCharge a subscription (subscription id). Financial or irreversible action; may require approval. API summary: Create a one-time charge for a subscription.
• search_customer_addressesSearch addresses for a customer by id, order by, status or search. Use this to find existing addresses before creating a new address. Results are paginated. API summary: List addresses for a customer.
• search_customer_companiesSearch companies for a customer by id, order by, status or search. Use this to find existing companies before creating a new company. Results are paginated. API summary: List businesses for a customer.
• search_notificationsSearch notifications by notification setting id, order by, search, status, filter or to. Use this to find existing notifications before creating a new notification. Results are paginated. API summary: List notifications.
• submit_paymentMoves moneyPreview a payment (subscription id). Financial or irreversible action; may require approval. API summary: Preview a one-time charge for a subscription.
• submit_payment_payment_methodVisible to othersVerify a payment (domain id). Has effects visible outside this system. API summary: Verify a payment method for a checkout domain.
• submit_payment_previewVisible to othersPreview a payment. Has effects visible outside this system. API summary: Preview a transaction.
• submit_subscriptionVisible to othersActivate a subscription (subscription id). Has effects visible outside this system. API summary: Activate a trialing subscription.
• submit_subscription_previewVisible to othersPreview a subscription (subscription id). Has effects visible outside this system. API summary: Preview an update to a subscription.
• update_customerChanges dataUpdate a customer's name, email, locale, status or custom data by `customer_id`.
• update_customer_2DeletesUpdate an existing customer identified by customer id. Only the fields you pass are changed. Destructive action; may require approval. API summary: Update a client-side token.
• update_customer_addressChanges dataUpdate an existing address identified by address id. Only the fields you pass are changed. API summary: Update an address for a customer.
• update_customer_companyChanges dataUpdate an existing company identified by company id. Only the fields you pass are changed. API summary: Update a business for a customer.
• update_discountChanges dataUpdate an existing discount identified by discount id. Only the fields you pass are changed. API summary: Update a discount.
• update_discount_groupChanges dataUpdate an existing discount group identified by discount group id. Only the fields you pass are changed. API summary: Update a discount group.
• update_notification_settingChanges dataUpdate an existing notification setting identified by notification setting id. Only the fields you pass are changed. API summary: Update a notification setting.
• update_paymentChanges dataUpdate an existing payment identified by payment id. Only the fields you pass are changed. API summary: Update a transaction.
• update_priceChanges dataUpdate a price's amount, name, description, trial or status by `price_id`. Existing subscriptions keep their price.
• update_productChanges dataUpdate a product's name, description, image, tax category or status (archive) by `product_id`.
• update_simulationChanges dataUpdate an existing simulation identified by simulation id. Only the fields you pass are changed. API summary: Update a simulation.
• update_subscriptionChanges dataChange a subscription by `subscription_id`: items, quantities, discount, next billing date or billing details; `proration_billing_mode` controls charging. Changes can bill the customer.
• update_subscription_payment_method_transactionChanges dataUpdate an existing subscription identified by subscription id. API summary: Get a transaction to update payment method.

Questions