The Paddle connector lets your AI agent act in each user's Paddle account. Each user connects their own Paddle access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 30 tools.
- Tools
- 30
- What they doRead · write · destructive
- 14 · 16 · 014 read16 write0 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Paddle connection
In AgentKit > Connections, create a Paddle connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'paddle'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Paddle:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'paddle_adjustments_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "paddle"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Paddle:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="paddle_adjustments_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Paddle credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolpaddle_addresses_listList the addresses saved for one customer, optionally searching their fields.Read-onlyList Customer Addresses
List the addresses saved for one customer, optionally searching their fields. Returns a page of addresses (id, customer_id, description, first_line, second_line, city, postal_code, region, country_code, status) plus meta.pagination. Use this to find an address ID for a transaction or subscription. Requires a customer ID from paddle_customers_list.
Inputs
customer_idstringrequired- Paddle ID of the customer whose addresses to list (starts with ctm_). Get it from paddle_customers_list. Example: ctm_01hrffh7gvp29kc7xahm8wddwa
afterstring- Pagination cursor. Pass the Paddle ID of the last entity on the previous page (also found in the after= parameter of meta.pagination.next) to get the next page. Leave empty for the first page. Example: add_01hv8gwdfkw5z6d1yy6pa3xyrz
idstring- Comma-separated Paddle IDs to return only those addresses. Example: add_01hv8gwdfkw5z6d1yy6pa3xyrz
order_bystring- Field and direction to sort by, written as field[ASC] or field[DESC]. Paddle defaults to id[DESC]. Example: id[DESC]one of
id[ASC]id[DESC] per_pageinteger- Number of entities to return per page, up to 200. Paddle defaults to 50. Example: 25
searchstring- Text to search for in the address fields (all except status and timestamps). Example: London
statusstring- Comma-separated statuses to filter by. Allowed values: active, archived. Paddle returns only active records by default. Example: active
paddle_adjustments_listList adjustments (refunds, credits and chargebacks), filtered by transaction, subscription, customer, action or status.Read-onlyList Adjustments
List adjustments (refunds, credits and chargebacks), filtered by transaction, subscription, customer, action or status. Returns a page of adjustments (id, action, type, transaction_id, subscription_id, customer_id, reason, status, items, totals) plus meta.pagination. Use this to check refund status or a customer's refund history; use paddle_adjustment_create to issue a refund or credit.
Inputs
actionstring- Comma-separated actions to filter by. Allowed values: credit, refund, chargeback, chargeback_reverse, chargeback_warning, chargeback_warning_reverse, credit_reverse. Example: refund
afterstring- Pagination cursor. Pass the Paddle ID of the last entity on the previous page (also found in the after= parameter of meta.pagination.next) to get the next page. Leave empty for the first page. Example: adj_01hvgf2s84dr6reszzg29zbvcm
customer_idstring- Comma-separated customer IDs; returns only their adjustments. Example: ctm_01hrffh7gvp29kc7xahm8wddwa
idstring- Comma-separated Paddle IDs to return only those adjustments. Example: adj_01hvgf2s84dr6reszzg29zbvcm
order_bystring- Field and direction to sort by, written as field[ASC] or field[DESC]. Paddle defaults to id[DESC]. Example: id[DESC]one of
id[ASC]id[DESC] per_pageinteger- Number of entities to return per page, up to 50. Paddle defaults to 10. Example: 25
statusstring- Comma-separated statuses to filter by. Allowed values: pending_approval, approved, rejected, reversed. Example: pending_approval
subscription_idstring- Comma-separated subscription IDs; returns only their adjustments. Example: sub_01hv8y5ehszzq0yv20ttx3166y
transaction_idstring- Comma-separated transaction IDs; returns only their adjustments. Example: txn_01hv8wptq8987qeep44cyrewp9
paddle_customer_getGet one customer by their Paddle ID.Read-onlyGet Customer
Get one customer by their Paddle ID. Returns the customer's name, email, locale, status, marketing_consent, custom_data and timestamps. Use this when you have a customer ID; use paddle_customers_list to search by name or email.
Inputs
customer_idstringrequired- Paddle ID of the customer (starts with ctm_). Get it from paddle_customers_list. Example: ctm_01hrffh7gvp29kc7xahm8wddwa
paddle_customers_listList customers, optionally searching by name, email or ID, or matching exact email addresses.Read-onlyList Customers
List customers, optionally searching by name, email or ID, or matching exact email addresses. Returns a page of customers (id, name, email, locale, status, marketing_consent, custom_data) plus meta.pagination. Use this to find a customer; use paddle_customer_get when you already have a customer ID.
Inputs
afterstring- Pagination cursor. Pass the Paddle ID of the last entity on the previous page (also found in the after= parameter of meta.pagination.next) to get the next page. Leave empty for the first page. Example: ctm_01hrffh7gvp29kc7xahm8wddwa
emailstring- Comma-separated email addresses to match exactly (up to 100). Example: sam@example.com
idstring- Comma-separated Paddle IDs to return only those customers. Example: ctm_01hrffh7gvp29kc7xahm8wddwa
order_bystring- Field and direction to sort by, written as field[ASC] or field[DESC]. Paddle defaults to id[DESC]. Example: id[DESC]one of
id[ASC]id[DESC] per_pageinteger- Number of entities to return per page, up to 200. Paddle defaults to 50. Example: 25
searchstring- Text to search for in customer IDs, names and emails (up to 100 characters). Use email for an exact email match. Example: sam
statusstring- Comma-separated statuses to filter by. Allowed values: active, archived. Paddle returns only active records by default. Example: active
paddle_discounts_listList discounts, filtered by code, status, mode or discount group.Read-onlyList Discounts
List discounts, filtered by code, status, mode or discount group. Returns a page of discounts (id, code, description, type, amount, currency_code, recur, usage_limit, times_used, expires_at, status) plus meta.pagination. Use this to find a discount by code or ID before applying or updating it.
Inputs
afterstring- Pagination cursor. Pass the Paddle ID of the last entity on the previous page (also found in the after= parameter of meta.pagination.next) to get the next page. Leave empty for the first page. Example: dsc_01hv6scyf7qdnzcdq01t2y8dx4
codestring- Comma-separated discount codes to match. Example: BF20OFF
discount_group_idstring- Comma-separated discount group IDs; returns only discounts in these groups. Example: dsg_01gtf15svsqzgp9325ss4ebmwt
idstring- Comma-separated Paddle IDs to return only those discounts. Example: dsc_01hv6scyf7qdnzcdq01t2y8dx4
modestring- Discount mode to filter by: standard (catalog discounts) or custom (non-catalog, e.g. checkout recovery). Example: standardone of
standardcustom order_bystring- Field and direction to sort by, written as field[ASC] or field[DESC]. Paddle defaults to id[DESC]. Example: created_at[DESC]one of
created_at[ASC]created_at[DESC]id[ASC]id[DESC] per_pageinteger- Number of entities to return per page, up to 200. Paddle defaults to 50. Example: 25
statusstring- Comma-separated statuses to filter by. Allowed values: active, archived. Paddle returns only active records by default. Example: active
paddle_price_getGet one price by its Paddle ID.Read-onlyGet Price
Get one price by its Paddle ID. Returns the price's product_id, description, name, billing_cycle, trial_period, tax_mode, unit_price, unit_price_overrides, quantity limits and status, and the product if requested. Use this when you have a price ID; use paddle_prices_list to find one.
Inputs
price_idstringrequired- Paddle ID of the price (starts with pri_). Get it from paddle_prices_list. Example: pri_01gsz8x8sawmvhz1pv30nge1ke
includestring- Set to product to include the related product in the response. Example: productone of
product
paddle_prices_listList prices in the Paddle catalog, filtered by product, status, recurrence or billing interval.Read-onlyList Prices
List prices in the Paddle catalog, filtered by product, status, recurrence or billing interval. Returns a page of prices (id, product_id, description, name, billing_cycle, trial_period, unit_price, unit_price_overrides, quantity, status) plus meta.pagination. Use this to find the price IDs to bill for; use paddle_price_get when you already have a price ID.
Inputs
afterstring- Pagination cursor. Pass the Paddle ID of the last entity on the previous page (also found in the after= parameter of meta.pagination.next) to get the next page. Leave empty for the first page. Example: pri_01gsz8x8sawmvhz1pv30nge1ke
billing_cycle_frequencyinteger- Return only prices whose billing cycle frequency matches this number, e.g. 3 with interval month for quarterly prices. Example: 1
billing_cycle_intervalstring- Return only prices that bill on this interval: day, week, month or year. Example: monthone of
dayweekmonthyear idstring- Comma-separated Paddle IDs to return only those prices. Example: pri_01gsz8x8sawmvhz1pv30nge1ke
includestring- Set to product to include each price's related product in the response. Example: productone of
product order_bystring- Field and direction to sort by, written as field[ASC] or field[DESC]. Paddle defaults to id[DESC]. Example: billing_cycle.frequency[DESC]one of
billing_cycle.frequency[ASC]billing_cycle.frequency[DESC]billing_cycle.interval[ASC]billing_cycle.interval[DESC]id[ASC]id[DESC]product_id[ASC]product_id[DESC]quantity.maximum[ASC]quantity.maximum[DESC]quantity.minimum[ASC]quantity.minimum[DESC]status[ASC]status[DESC]tax_mode[ASC]tax_mode[DESC]unit_price.amount[ASC]unit_price.amount[DESC]unit_price.currency_code[ASC]unit_price.currency_code[DESC] per_pageinteger- Number of entities to return per page, up to 200. Paddle defaults to 50. Example: 25
product_idstring- Comma-separated product IDs; returns only prices for these products. Example: pro_01htz88xpr0mm7b3ta2pjkr7w2
recurringboolean- true returns only recurring (subscription) prices; false returns only one-time prices. Example: true
statusstring- Comma-separated statuses to filter by. Allowed values: active, archived. Paddle returns only active records by default. Example: active
typestring- Item type to filter by: standard (catalog) or custom (non-catalog). Example: standardone of
standardcustom
paddle_product_getGet one product by its Paddle ID.Read-onlyGet Product
Get one product by its Paddle ID. Returns the product's name, description, type, tax_category, image_url, status, custom_data and timestamps, and its prices if requested. Use this when you have a product ID; use paddle_products_list to find one.
Inputs
product_idstringrequired- Paddle ID of the product (starts with pro_). Get it from paddle_products_list. Example: pro_01htz88xpr0mm7b3ta2pjkr7w2
includestring- Set to prices to include the product's related prices in the response. Example: pricesone of
prices
paddle_products_listList products in the Paddle catalog, filtered by status, tax category or type.Read-onlyList Products
List products in the Paddle catalog, filtered by status, tax category or type. Returns a page of products (id, name, description, tax_category, status, custom_data, optionally their prices) plus meta.pagination. Use this to browse or find products; use paddle_product_get when you already have a product ID.
Inputs
afterstring- Pagination cursor. Pass the Paddle ID of the last entity on the previous page (also found in the after= parameter of meta.pagination.next) to get the next page. Leave empty for the first page. Example: pro_01htz88xpr0mm7b3ta2pjkr7w2
idstring- Comma-separated Paddle IDs to return only those products. Example: pro_01htz88xpr0mm7b3ta2pjkr7w2,pro_01gsz97mq9pa4fkyy0wqenepkz
includestring- Set to prices to include each product's related prices in the response. Example: pricesone of
prices order_bystring- Field and direction to sort by, written as field[ASC] or field[DESC]. Paddle defaults to id[DESC]. Example: created_at[DESC]one of
created_at[ASC]created_at[DESC]custom_data[ASC]custom_data[DESC]description[ASC]description[DESC]id[ASC]id[DESC]image_url[ASC]image_url[DESC]name[ASC]name[DESC]status[ASC]status[DESC]tax_category[ASC]tax_category[DESC]updated_at[ASC]updated_at[DESC] per_pageinteger- Number of entities to return per page, up to 200. Paddle defaults to 50. Example: 25
statusstring- Comma-separated statuses to filter by. Allowed values: active, archived. Paddle returns only active records by default. Example: active
tax_categorystring- Comma-separated tax categories to filter by. Allowed values: digital-goods, ebooks, implementation-services, professional-services, saas, software-programming-services, standard, training-services, website-hosting. Example: saas
typestring- Item type to filter by: standard (catalog items) or custom (non-catalog items created for one transaction or subscription). Example: standardone of
standardcustom
paddle_subscription_getGet one subscription by its Paddle ID.Read-onlyGet Subscription
Get one subscription by its Paddle ID. Returns the subscription's status, customer, address, items with prices, billing cycle, current_billing_period, next_billed_at, discount, scheduled_change and management URLs; optionally a preview of the next transaction. Use this when you have a subscription ID; use paddle_subscriptions_list to find one.
Inputs
subscription_idstringrequired- Paddle ID of the subscription (starts with sub_). Get it from paddle_subscriptions_list. Example: sub_01hv8y5ehszzq0yv20ttx3166y
includestring- Comma-separated related data to include: next_transaction (preview of the next bill, with prorated and one-time charges) and/or recurring_transaction_details (preview of the regular recurring bill). Example: next_transaction
paddle_subscriptions_listList subscriptions, filtered by customer, price, address, status, collection mode or scheduled change.Read-onlyList Subscriptions
List subscriptions, filtered by customer, price, address, status, collection mode or scheduled change. Returns a page of subscriptions (id, status, customer_id, address_id, currency_code, items, current_billing_period, next_billed_at, scheduled_change, collection_mode) plus meta.pagination. Use this to find a customer's subscriptions; use paddle_subscription_get when you already have a subscription ID.
Inputs
address_idstring- Comma-separated address IDs; returns only subscriptions for these addresses. Example: add_01hv8gwdfkw5z6d1yy6pa3xyrz
afterstring- Pagination cursor. Pass the Paddle ID of the last entity on the previous page (also found in the after= parameter of meta.pagination.next) to get the next page. Leave empty for the first page. Example: sub_01hv8y5ehszzq0yv20ttx3166y
collection_modestring- Return only subscriptions with this collection mode: automatic (card or saved payment method) or manual (invoiced). Example: automaticone of
automaticmanual customer_idstring- Comma-separated customer IDs; returns only their subscriptions. Example: ctm_01hrffh7gvp29kc7xahm8wddwa
idstring- Comma-separated Paddle IDs to return only those subscriptions. Example: sub_01hv8y5ehszzq0yv20ttx3166y
order_bystring- Field and direction to sort by, written as field[ASC] or field[DESC]. Paddle defaults to id[DESC]. Example: id[DESC]one of
id[ASC]id[DESC] per_pageinteger- Number of entities to return per page, up to 200. Paddle defaults to 50. Example: 25
price_idstring- Comma-separated price IDs; returns only subscriptions that include these prices. Example: pri_01gsz8x8sawmvhz1pv30nge1ke
scheduled_change_actionstring- Comma-separated scheduled change actions to filter by. Allowed values: cancel, pause, resume, none. Example: cancel
statusstring- Comma-separated subscription statuses to filter by. Allowed values: active, canceled, past_due, paused, trialing. Example: active,trialing
paddle_transaction_getGet one transaction by its Paddle ID.Read-onlyGet Transaction
Get one transaction by its Paddle ID. Returns the transaction's status, customer, address, subscription, items, line-item totals (details.line_items[].id are needed for partial refunds), payments, invoice number and checkout URL; optionally related entities. Use this when you have a transaction ID; use paddle_transactions_list to find one and paddle_transaction_invoice_get for its PDF.
Inputs
transaction_idstringrequired- Paddle ID of the transaction (starts with txn_). Get it from paddle_transactions_list. Example: txn_01hv8wptq8987qeep44cyrewp9
includestring- Comma-separated related entities to include: address, adjustments, adjustments_totals, available_payment_methods, business, customer, discount. Example: customer,address
paddle_transaction_invoice_getGet a temporary link to the PDF invoice for a transaction.Read-onlyGet Transaction Invoice PDF
Get a temporary link to the PDF invoice for a transaction. The link expires after one hour. Returns data.url, the PDF download URL. Use this for billed or completed manual invoices and completed automatic transactions; zero-value transactions have no PDF. Use paddle_transaction_get for the transaction's data. Requires a transaction ID from paddle_transactions_list.
Inputs
transaction_idstringrequired- Paddle ID of the transaction (starts with txn_). Get it from paddle_transactions_list. Example: txn_01hv8wptq8987qeep44cyrewp9
dispositionstring- attachment (Paddle's default) makes the URL download the PDF; inline makes it open in the browser. Example: inlineone of
attachmentinline
paddle_transactions_listList transactions (checkouts, invoices, renewals and one-time charges), filtered by customer, subscription, status, origin, invoice number or date.Read-onlyList Transactions
List transactions (checkouts, invoices, renewals and one-time charges), filtered by customer, subscription, status, origin, invoice number or date. Returns up to 30 transactions per page (id, status, customer_id, subscription_id, origin, invoice_number, currency_code, items, details.totals, billed_at, created_at) plus meta.pagination. Use this to review billing history; use paddle_transaction_get when you already have a transaction ID.
Inputs
afterstring- Pagination cursor. Pass the Paddle ID of the last entity on the previous page (also found in the after= parameter of meta.pagination.next) to get the next page. Leave empty for the first page. Example: txn_01hv8wptq8987qeep44cyrewp9
billed_afterstring- Return transactions billed at or after this RFC 3339 date-time. Example: 2025-01-01T00:00:00Z
billed_beforestring- Return transactions billed before this RFC 3339 date-time. Example: 2025-02-01T00:00:00Z
collection_modestring- Return only transactions with this collection mode: automatic or manual (invoices). Example: manualone of
automaticmanual created_afterstring- Return transactions created at or after this RFC 3339 date-time. Example: 2025-01-01T00:00:00Z
created_beforestring- Return transactions created before this RFC 3339 date-time. Example: 2025-02-01T00:00:00Z
customer_idstring- Comma-separated customer IDs; returns only their transactions. Example: ctm_01hrffh7gvp29kc7xahm8wddwa
idstring- Comma-separated Paddle IDs to return only those transactions. Example: txn_01hv8wptq8987qeep44cyrewp9
includestring- Comma-separated related entities to include: address, adjustments, adjustments_totals, available_payment_methods, business, customer, discount. Example: customer,address
invoice_numberstring- Comma-separated invoice numbers to match. Example: 123-45678
order_bystring- Field and direction to sort by, written as field[ASC] or field[DESC]. Paddle defaults to id[DESC]. Example: billed_at[DESC]one of
billed_at[ASC]billed_at[DESC]created_at[ASC]created_at[DESC]id[ASC]id[DESC]updated_at[ASC]updated_at[DESC] originstring- Comma-separated origins to filter by. Allowed values: api, subscription_charge, subscription_payment_method_change, subscription_recurring, subscription_update, subscription_import, web. Example: subscription_recurring
per_pageinteger- Number of entities to return per page, up to 30. Paddle defaults to 30. Example: 25
statusstring- Comma-separated statuses to filter by. Allowed values: draft, ready, billed, paid, completed, canceled, past_due. Example: completed
subscription_idstring- Comma-separated subscription IDs; returns only their transactions. Example: sub_01hv8y5ehszzq0yv20ttx3166y
paddle_address_createAdd an address to a customer.WriteCreate Customer Address
Add an address to a customer. Paddle uses addresses to calculate tax. Returns the new address with its add_ ID. Use this before creating a transaction that needs an address_id; use paddle_address_update to change an existing address. Requires a customer ID from paddle_customers_list.
Inputs
country_codestringrequired- Two-letter ISO 3166-1 alpha-2 country code of the address. Example: US
customer_idstringrequired- Paddle ID of the customer to add the address to (starts with ctm_). Get it from paddle_customers_list. Example: ctm_01hrffh7gvp29kc7xahm8wddwa
citystring- City of the address. Example: Astoria
custom_dataobject- Your own key-value data to store on the entity. Example: {"crm_id": "12345"}
descriptionstring- Memorable label for the address, for your reference. Example: Head Office
first_linestring- First line of the street address. Example: 3811 Ditmars Blvd
postal_codestring- ZIP or postal code. Paddle requires it for some countries, such as the US (ZIP code) and the UK (postcode). Example: 10021
regionstring- State, county or region of the address. Example: NY
second_linestring- Second line of the street address, such as an apartment or suite. Example: Suite 200
paddle_address_updateUpdate a customer's address fields, custom data or status.WriteUpdate Customer Address
Update a customer's address fields, custom data or status. Only the fields you send change. Returns the updated address. Use status archived to retire an address (addresses can't be deleted). Use paddle_address_create to add a new one. Requires the customer ID and address ID from paddle_addresses_list.
- Idempotent
Inputs
address_idstringrequired- Paddle ID of the address to update (starts with add_). Get it from paddle_addresses_list. Example: add_01hv8gwdfkw5z6d1yy6pa3xyrz
customer_idstringrequired- Paddle ID of the customer the address belongs to (starts with ctm_). Get it from paddle_customers_list. Example: ctm_01hrffh7gvp29kc7xahm8wddwa
citystring- City of the address. Example: Astoria
country_codestring- Two-letter ISO 3166-1 alpha-2 country code of the address. Example: US
custom_dataobject- Your own key-value data to store on the entity. Example: {"crm_id": "12345"}
descriptionstring- Memorable label for the address, for your reference. Example: Head Office
first_linestring- First line of the street address. Example: 3811 Ditmars Blvd
postal_codestring- ZIP or postal code. Paddle requires it for some countries, such as the US (ZIP code) and the UK (postcode). Example: 10021
regionstring- State, county or region of the address. Example: NY
second_linestring- Second line of the street address, such as an apartment or suite. Example: Suite 200
statusstring- Set to archived to retire the address, or active to restore it. Example: archivedone of
activearchived
paddle_adjustment_createRefund or credit all or part of a transaction.WriteCreate Adjustment
Refund or credit all or part of a transaction. Refunds go back to the customer's payment method for completed transactions; credits reduce the amount due on billed or past-due manual invoices. Returns the new adjustment with its adj_ ID and status; most live refunds start as pending_approval until Paddle reviews them. Use paddle_adjustments_list to check an adjustment's status later. Requires a transaction ID, and for partial adjustments the line item IDs (details.line_items[].id) from paddle_transaction_get.
Inputs
actionstringrequired- refund returns money to the customer's payment method (completed transactions); credit reduces the amount due on a billed or past-due manually-collected transaction. Example: refundone of
refundcredit reasonstringrequired- Why the adjustment is being made. Shown in the Paddle dashboard and kept for records. Example: Customer requested refund for duplicate purchase
transaction_idstringrequired- Paddle ID of the transaction to refund or credit. Get it from paddle_transactions_list. Example: txn_01hv8wptq8987qeep44cyrewp9
itemsarray- Line items to adjust, required for a partial adjustment. Each has item_id (txnitm_ ID from details.line_items[].id in paddle_transaction_get), type (full or partial) and, for partial, amount as a string in the lowest currency unit. Example: [{"item_id": "txnitm_01hv8wt98jahpbm1t1tzr06z6n", "type": "partial", "amount": "500"}]
tax_modestring- Whether the amounts you give include tax (internal) or exclude it, so Paddle adds tax on top (external). Example: internalone of
externalinternal typestring- full adjusts the transaction's whole grand total; partial (Paddle's default) adjusts only the line items you list in items. Example: fullone of
fullpartial
paddle_customer_createCreate a customer from an email address, with optional name, locale and custom data.WriteCreate Customer
Create a customer from an email address, with optional name, locale and custom data. Returns the new customer with its ctm_ ID. Use this before adding addresses or creating transactions for a new buyer. Paddle rejects an email that already belongs to a customer; find that one with paddle_customers_list.
Inputs
emailstringrequired- Email address of the customer (unique per customer). Example: sam@example.com
custom_dataobject- Your own key-value data to store on the entity. Example: {"crm_id": "12345"}
localestring- IETF BCP 47 short locale tag used for emails and documents sent to the customer. Paddle defaults to en. Example: en
namestring- Full name of the customer. Required later if you invoice them with a manually-collected transaction. Example: Sam Miller
paddle_customer_updateUpdate a customer's name, email, locale, custom data or status.WriteUpdate Customer
Update a customer's name, email, locale, custom data or status. Only the fields you send change. Returns the updated customer. Use status archived to retire a customer (customers can't be deleted). Use paddle_customer_create for a new customer.
- Idempotent
Inputs
customer_idstringrequired- Paddle ID of the customer to update (starts with ctm_). Get it from paddle_customers_list. Example: ctm_01hrffh7gvp29kc7xahm8wddwa
custom_dataobject- Your own key-value data to store on the entity. Example: {"crm_id": "12345"}
emailstring- Email address of the customer (unique per customer). Example: sam@example.com
localestring- IETF BCP 47 short locale tag used for emails and documents sent to the customer. Paddle defaults to en. Example: en
namestring- Full name of the customer. Required later if you invoice them with a manually-collected transaction. Example: Sam Miller
statusstring- Set to archived to retire the customer, or active to restore it. Example: archivedone of
activearchived
paddle_discount_createCreate a percentage, flat or per-seat discount, optionally with a checkout code, usage limit, expiry and product restrictions.WriteCreate Discount
Create a percentage, flat or per-seat discount, optionally with a checkout code, usage limit, expiry and product restrictions. Returns the new discount with its dsc_ ID. Use this to set up a promotion; apply it with paddle_transaction_create (discount_id) or paddle_subscription_update (discount). Use paddle_discount_update to change one.
Inputs
amountstringrequired- Amount to discount, as a string. For percentage, a value from 0.01 to 100; for flat and flat_per_seat, the amount in the lowest currency unit (e.g. "500" for 5.00 USD). Example: 20
descriptionstringrequired- Short description of the discount for your reference, not shown to customers (1-500 characters). Example: Black Friday 2025
typestringrequired- Discount type: percentage (e.g. 20%), flat (a fixed amount off the total) or flat_per_seat (a fixed amount off per unit). flat and flat_per_seat need currency_code. Example: percentageone of
flatflat_per_seatpercentage codestring- Code customers enter at checkout to redeem the discount: letters and numbers only, up to 32 characters, not case-sensitive. Leave empty for a discount you only apply through the API. Example: BF20OFF
currency_codestring- Three-letter ISO 4217 currency code. Required for flat and flat_per_seat discounts. Example: USD
custom_dataobject- Your own key-value data to store on the entity. Example: {"crm_id": "12345"}
enabled_for_checkoutboolean- Whether customers can redeem the discount at checkout. Paddle defaults to true. Example: true
expires_atstring- RFC 3339 date-time after which the discount can no longer be redeemed. Leave empty for no expiry. Example: 2025-12-01T00:00:00Z
maximum_recurring_intervalsinteger- Number of billing periods the discount recurs for when recur is true. Leave empty to recur forever. Example: 3
recurboolean- Whether the discount applies to more than one subscription billing period. Paddle defaults to false. Example: true
restrict_toarray- Product (pro_) or price (pri_) IDs the discount is limited to. A product ID covers all its prices. Leave empty to apply to everything. Example: ["pro_01htz88xpr0mm7b3ta2pjkr7w2"]
usage_limitinteger- Total number of times the discount can be redeemed across all customers. Leave empty for unlimited. Example: 1000
paddle_discount_updateUpdate a discount's amount, code, limits, expiry, restrictions, custom data or status.WriteUpdate Discount
Update a discount's amount, code, limits, expiry, restrictions, custom data or status. Only the fields you send change. Returns the updated discount. Use status archived to retire a discount (discounts can't be deleted). Use paddle_discount_create for a new discount. Requires a discount ID from paddle_discounts_list.
- Idempotent
Inputs
discount_idstringrequired- Paddle ID of the discount to update (starts with dsc_). Get it from paddle_discounts_list. Example: dsc_01hv6scyf7qdnzcdq01t2y8dx4
amountstring- Amount to discount, as a string. For percentage, a value from 0.01 to 100; for flat and flat_per_seat, the amount in the lowest currency unit (e.g. "500" for 5.00 USD). Example: 20
codestring- Code customers enter at checkout to redeem the discount: letters and numbers only, up to 32 characters, not case-sensitive. Leave empty for a discount you only apply through the API. Example: BF20OFF
currency_codestring- Three-letter ISO 4217 currency code. Required for flat and flat_per_seat discounts. Example: USD
custom_dataobject- Your own key-value data to store on the entity. Example: {"crm_id": "12345"}
descriptionstring- Short description of the discount for your reference, not shown to customers (1-500 characters). Example: Black Friday 2025
enabled_for_checkoutboolean- Whether customers can redeem the discount at checkout. Paddle defaults to true. Example: true
expires_atstring- RFC 3339 date-time after which the discount can no longer be redeemed. Leave empty for no expiry. Example: 2025-12-01T00:00:00Z
maximum_recurring_intervalsinteger- Number of billing periods the discount recurs for when recur is true. Leave empty to recur forever. Example: 3
recurboolean- Whether the discount applies to more than one subscription billing period. Paddle defaults to false. Example: true
restrict_toarray- Product (pro_) or price (pri_) IDs the discount is limited to. A product ID covers all its prices. Leave empty to apply to everything. Example: ["pro_01htz88xpr0mm7b3ta2pjkr7w2"]
statusstring- Set to archived to retire the discount, or active to restore it. Example: archivedone of
activearchived typestring- Discount type: percentage (e.g. 20%), flat (a fixed amount off the total) or flat_per_seat (a fixed amount off per unit). flat and flat_per_seat need currency_code. Example: percentageone of
flatflat_per_seatpercentage usage_limitinteger- Total number of times the discount can be redeemed across all customers. Leave empty for unlimited. Example: 1000
paddle_price_createCreate a price for an existing product, either one-time or recurring.WriteCreate Price
Create a price for an existing product, either one-time or recurring. Returns the new price with its pri_ ID. Use this after paddle_product_create to define how a product is charged; use paddle_price_update to change an existing price. Requires a product ID from paddle_products_list or paddle_product_create.
Inputs
descriptionstringrequired- Internal description of the price for your team, not shown to customers (2-500 characters). Example: Monthly (per seat)
product_idstringrequired- Paddle ID of the product this price is for. Get it from paddle_products_list. Example: pro_01htz88xpr0mm7b3ta2pjkr7w2
unit_priceobjectrequired- Base price as an object with amount (a string in the lowest currency unit, e.g. "1000" for 10.00 USD) and a three-letter currency_code. Example: {"amount": "1000", "currency_code": "USD"}
billing_cycleobject- How often a recurring price charges, as an object with interval (day, week, month or year) and frequency (a whole number). Leave empty for a one-time price. Example: {"interval": "month", "frequency": 1}
custom_dataobject- Your own key-value data to store on the entity. Example: {"crm_id": "12345"}
namestring- Name of the price shown to customers at checkout and on invoices, typically how often it bills (1-150 characters). Example: Monthly
quantityobject- Minimum and maximum quantity a customer can buy at this price. Paddle defaults to 1-100. Example: {"minimum": 1, "maximum": 999}
tax_modestring- How tax is calculated: account_setting (use your account default), external (prices exclude tax), internal (prices include tax) or location (depends on the customer's country). Paddle defaults to account_setting. Example: account_settingone of
account_settingexternalinternallocation trial_periodobject- Free or discounted trial before billing starts, as an object with interval and frequency (and optionally requires_payment_method). Needs a billing_cycle. Example: {"interval": "day", "frequency": 14}
typestring- Item type: standard for a catalog price (the default) or custom for a non-catalog price. Example: standardone of
standardcustom unit_price_overridesarray- Country-specific prices that replace the base price for customers in those countries. Each override has country_codes (two-letter codes) and a unit_price object. Example: [{"country_codes": ["GB"], "unit_price": {"amount": "900", "currency_code": "GBP"}}]
paddle_price_updateUpdate a price's amount, name, billing cycle, trial, tax mode, overrides, quantity limits, custom data or status.WriteUpdate Price
Update a price's amount, name, billing cycle, trial, tax mode, overrides, quantity limits, custom data or status. Only the fields you send change. Returns the updated price. Use status archived to retire a price (prices can't be deleted). Use paddle_price_create for a new price.
- Idempotent
Inputs
price_idstringrequired- Paddle ID of the price to update (starts with pri_). Get it from paddle_prices_list. Example: pri_01gsz8x8sawmvhz1pv30nge1ke
billing_cycleobject- How often a recurring price charges, as an object with interval (day, week, month or year) and frequency (a whole number). Leave empty for a one-time price. Example: {"interval": "month", "frequency": 1}
custom_dataobject- Your own key-value data to store on the entity. Example: {"crm_id": "12345"}
descriptionstring- Internal description of the price for your team, not shown to customers (2-500 characters). Example: Monthly (per seat)
namestring- Name of the price shown to customers at checkout and on invoices, typically how often it bills (1-150 characters). Example: Monthly
quantityobject- Minimum and maximum quantity a customer can buy at this price. Paddle defaults to 1-100. Example: {"minimum": 1, "maximum": 999}
statusstring- Set to archived to retire the price, or active to restore it. Example: archivedone of
activearchived tax_modestring- How tax is calculated: account_setting (use your account default), external (prices exclude tax), internal (prices include tax) or location (depends on the customer's country). Paddle defaults to account_setting. Example: account_settingone of
account_settingexternalinternallocation trial_periodobject- Free or discounted trial before billing starts, as an object with interval and frequency (and optionally requires_payment_method). Needs a billing_cycle. Example: {"interval": "day", "frequency": 14}
typestring- Item type: standard for a catalog price (the default) or custom for a non-catalog price. Example: standardone of
standardcustom unit_priceobject- Base price as an object with amount (a string in the lowest currency unit, e.g. "1000" for 10.00 USD) and a three-letter currency_code. Example: {"amount": "1000", "currency_code": "USD"}
unit_price_overridesarray- Country-specific prices that replace the base price for customers in those countries. Each override has country_codes (two-letter codes) and a unit_price object. Example: [{"country_codes": ["GB"], "unit_price": {"amount": "900", "currency_code": "GBP"}}]
paddle_product_createCreate a product in the Paddle catalog.WriteCreate Product
Create a product in the Paddle catalog. Returns the new product with its pro_ ID. Use this to add something you sell; then create its prices with paddle_price_create. Use paddle_product_update to change an existing product.
Inputs
namestringrequired- Name of the product, shown to customers at checkout and on invoices (1-200 characters). Example: AeroEdit Pro
tax_categorystringrequired- Tax category Paddle uses to charge the right tax rate. It must be enabled on your Paddle account; saas and standard are enabled by default. Example: saasone of
digital-goodsebooksimplementation-servicesprofessional-servicessaassoftware-programming-servicesstandardtraining-serviceswebsite-hosting custom_dataobject- Your own key-value data to store on the entity. Example: {"crm_id": "12345"}
descriptionstring- Short description of the product (up to 2048 characters). Example: Advanced flight planning tools for professional pilots.
image_urlstring- Public HTTPS URL of a square image for the product, shown at checkout and on some customer documents. Paddle does not host the image. Example: https://example.com/images/aeroedit-pro.png
typestring- Item type: standard for a reusable catalog product (the default) or custom for a non-catalog product that is not listed or shown in the dashboard. Example: standardone of
standardcustom
paddle_product_updateUpdate a product's name, description, tax category, image, custom data or status.WriteUpdate Product
Update a product's name, description, tax category, image, custom data or status. Only the fields you send change. Returns the updated product. Use status archived to retire a product (Paddle products can't be deleted). Use paddle_product_create for a new product.
- Idempotent
Inputs
product_idstringrequired- Paddle ID of the product to update (starts with pro_). Get it from paddle_products_list. Example: pro_01htz88xpr0mm7b3ta2pjkr7w2
custom_dataobject- Your own key-value data to store on the entity. Example: {"crm_id": "12345"}
descriptionstring- Short description of the product (up to 2048 characters). Example: Advanced flight planning tools for professional pilots.
image_urlstring- Public HTTPS URL of a square image for the product, shown at checkout and on some customer documents. Paddle does not host the image. Example: https://example.com/images/aeroedit-pro.png
namestring- Name of the product, shown to customers at checkout and on invoices (1-200 characters). Example: AeroEdit Pro
statusstring- Set to archived to retire the product, or active to restore it. Example: archivedone of
activearchived tax_categorystring- Tax category Paddle uses to charge the right tax rate. It must be enabled on your Paddle account; saas and standard are enabled by default. Example: saasone of
digital-goodsebooksimplementation-servicesprofessional-servicessaassoftware-programming-servicesstandardtraining-serviceswebsite-hosting typestring- Item type: standard for a reusable catalog product (the default) or custom for a non-catalog product that is not listed or shown in the dashboard. Example: standardone of
standardcustom
paddle_subscription_cancelCancel a subscription, either at the end of the current billing period (the default) or immediately.WriteCancel Subscription
Cancel a subscription, either at the end of the current billing period (the default) or immediately. Returns the subscription with its scheduled_change (or status canceled if immediate). Use paddle_subscription_pause to stop billing temporarily instead. A scheduled cancellation can be undone with paddle_subscription_update and remove_scheduled_change; an immediate one can't. Requires a subscription ID from paddle_subscriptions_list.
Inputs
subscription_idstringrequired- Paddle ID of the subscription to cancel (starts with sub_). Get it from paddle_subscriptions_list. Example: sub_01hv8y5ehszzq0yv20ttx3166y
effective_fromstring- When to cancel: next_billing_period (Paddle's default, schedules the change for the end of the current period) or immediately. Example: next_billing_periodone of
next_billing_periodimmediately
paddle_subscription_pausePause a subscription at the end of the current billing period (the default) or immediately, optionally with a date to resume automatically.WritePause Subscription
Pause a subscription at the end of the current billing period (the default) or immediately, optionally with a date to resume automatically. Returns the subscription with its scheduled_change (or status paused if immediate). Use paddle_subscription_resume to restart a paused subscription; use paddle_subscription_cancel to end it. Requires a subscription ID from paddle_subscriptions_list.
Inputs
subscription_idstringrequired- Paddle ID of the subscription to pause (starts with sub_). Get it from paddle_subscriptions_list. Example: sub_01hv8y5ehszzq0yv20ttx3166y
effective_fromstring- When to pause: next_billing_period (Paddle's default, schedules the change for the end of the current period) or immediately. Example: next_billing_periodone of
next_billing_periodimmediately on_resumestring- How the billing period is set when the subscription resumes: start_new_billing_period (Paddle's default, charges for a new period from the resume date) or continue_existing_billing_period. Example: start_new_billing_periodone of
start_new_billing_periodcontinue_existing_billing_period resume_atstring- RFC 3339 date-time when the subscription should resume automatically. Leave empty to pause until resumed. Example: 2025-09-01T00:00:00Z
paddle_subscription_resumeResume a paused subscription immediately or on a set date, or change the resume date of a scheduled resume.WriteResume Subscription
Resume a paused subscription immediately or on a set date, or change the resume date of a scheduled resume. Returns the updated subscription. Use this only for paused subscriptions; use paddle_subscription_pause to pause one. Requires a subscription ID from paddle_subscriptions_list.
Inputs
effective_fromstringrequired- When to resume: immediately, or an RFC 3339 date-time to resume on. Example: immediately
subscription_idstringrequired- Paddle ID of the paused subscription to resume (starts with sub_). Get it from paddle_subscriptions_list. Example: sub_01hv8y5ehszzq0yv20ttx3166y
on_resumestring- How the billing period is set when the subscription resumes: start_new_billing_period (Paddle's default, charges for a new period from the resume date) or continue_existing_billing_period. Example: start_new_billing_periodone of
start_new_billing_periodcontinue_existing_billing_period
paddle_subscription_updateUpdate a subscription: change its items, quantities, customer, address, currency, next billing date, discount, collection mode, billing details or custom data.WriteUpdate Subscription
Update a subscription: change its items, quantities, customer, address, currency, next billing date, discount, collection mode, billing details or custom data. Only the fields you send change. Returns the updated subscription. Use paddle_subscription_cancel, paddle_subscription_pause or paddle_subscription_resume to cancel, pause or resume instead. Changes to items, quantities or the next billing date need proration_billing_mode. Requires a subscription ID from paddle_subscriptions_list.
Inputs
subscription_idstringrequired- Paddle ID of the subscription to update (starts with sub_). Get it from paddle_subscriptions_list. Example: sub_01hv8y5ehszzq0yv20ttx3166y
address_idstring- Paddle ID of a different address for the subscription; it must belong to the subscription's customer. Example: add_01hv8gwdfkw5z6d1yy6pa3xyrz
billing_detailsobject- Invoicing details, required when collection_mode is manual: payment_terms (interval and frequency), and optionally enable_checkout, purchase_order_number and additional_information. Example: {"payment_terms": {"interval": "day", "frequency": 30}, "enable_checkout": false}
collection_modestring- How payment is collected: automatic (saved payment method) or manual (invoices; needs billing_details). Example: manualone of
automaticmanual currency_codestring- Three-letter ISO 4217 currency code to bill in. Manually-collected subscriptions must use USD, EUR or GBP. Example: USD
custom_dataobject- Your own key-value data to store on the entity. Example: {"crm_id": "12345"}
customer_idstring- Paddle ID of a different customer to move the subscription to. Example: ctm_01hrffh7gvp29kc7xahm8wddwa
discountobject- Discount to apply, as an object with the discount id and effective_from (immediately or next_billing_period). Example: {"id": "dsc_01hv6scyf7qdnzcdq01t2y8dx4", "effective_from": "next_billing_period"}
itemsarray- The complete list of recurring items the subscription should have after the update, each with price_id and quantity. Items you leave out are removed. Example: [{"price_id": "pri_01gsz8x8sawmvhz1pv30nge1ke", "quantity": 20}]
next_billed_atstring- New RFC 3339 date-time for the next bill. Example: 2025-06-01T00:00:00Z
on_payment_failurestring- What to do if the payment for the change fails: prevent_change (Paddle's default) or apply_change. Example: prevent_changeone of
prevent_changeapply_change proration_billing_modestring- How Paddle bills for the change. prorated_immediately and full_immediately charge now; prorated_next_billing_period and full_next_billing_period add the charge to the next bill; do_not_bill makes no charge. Required when the change affects billing. Example: prorated_immediatelyone of
prorated_immediatelyprorated_next_billing_periodfull_immediatelyfull_next_billing_perioddo_not_bill remove_discountboolean- Set to true to remove the subscription's current discount. Leave empty to keep it. Example: true
remove_scheduled_changeboolean- Set to true to remove a scheduled cancel, pause or resume, for example to undo a cancellation at the end of the billing period. Example: true
paddle_transaction_createCreate a transaction to bill a customer, for a checkout (automatic collection) or an invoice (manual collection).WriteCreate Transaction
Create a transaction to bill a customer, for a checkout (automatic collection) or an invoice (manual collection). Returns the new transaction with its txn_ ID, status (draft or ready, or billed if requested), totals and checkout.url payment link. Use this to charge for catalog prices or send an invoice. To charge an existing subscription, use paddle_subscription_update instead. Requires price IDs from paddle_prices_list; customer and address IDs come from paddle_customers_list and paddle_addresses_list.
Inputs
itemsarrayrequired- Items to charge for, each with a price_id and a quantity. Example: [{"price_id": "pri_01gsz8x8sawmvhz1pv30nge1ke", "quantity": 1}]
address_idstring- Paddle ID of the customer's address, used for tax. Needs customer_id. Without it the transaction stays draft. Example: add_01hv8gwdfkw5z6d1yy6pa3xyrz
billing_detailsobject- Invoicing details, required when collection_mode is manual: payment_terms (interval and frequency), and optionally enable_checkout, purchase_order_number and additional_information. Example: {"payment_terms": {"interval": "day", "frequency": 14}, "enable_checkout": true}
collection_modestring- How payment is collected: automatic (Paddle Checkout, the default) or manual (an invoice; needs billing_details). Example: automaticone of
automaticmanual currency_codestring- Three-letter ISO 4217 currency code. Must be USD, EUR or GBP when collection_mode is manual. Example: USD
custom_dataobject- Your own key-value data to store on the entity. Example: {"crm_id": "12345"}
customer_idstring- Paddle ID of the customer to bill. Without it the transaction stays draft. Example: ctm_01hrffh7gvp29kc7xahm8wddwa
discount_idstring- Paddle ID of a discount to apply. Example: dsc_01hv6scyf7qdnzcdq01t2y8dx4
includestring- Comma-separated related entities to include: address, adjustments, adjustments_totals, available_payment_methods, business, customer, discount. Example: customer,address
statusstring- Set to billed to issue the transaction right away (for manual invoices it becomes a legal record and can't be edited). Leave empty to let Paddle set draft or ready. Example: billedone of
billed
No tools match.