Agent-ready OpenAPI document · curated by JenticPaymentsBilling Subscriptionsbearer27 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Create products, manage subscription billing, process transactions, and handle adjustments with Paddle as merchant of record. Paddle handles sales tax, VAT, and compliance automatically.
Use for: I need to create a new product with monthly and annual pricing, Set up a subscription for a customer on a specific price, Check whether a transaction was successfully completed, List all active subscriptions for a customer
Not supported: Does not handle direct card processing, marketplace multi-party payouts, or in-person POS - use for SaaS subscription billing with tax-handled payments only.
Handle subscription billing as a merchant of record where Paddle collects payment, calculates sales tax and VAT, and remits to tax authorities on your behalf. The API manages the full billing lifecycle across products, prices, customers, subscriptions, transactions, invoices, and adjustments. Paddle supports multiple currencies, automatic tax calculation for 200+ countries, and configurable proration on plan changes.
Install Jentic One Beta
Connect the Paddle API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Paddle API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fpaddle.com%2Fpaddle" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fpaddle.com%2Fpaddle" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Paddle API.
Define products with multiple price points across currencies and billing intervals
Create and manage customer subscriptions with automatic tax calculation for 200+ jurisdictions
Process one-time and recurring transactions with Paddle handling payment collection and remittance
Issue adjustments (credits and refunds) against completed transactions with reason tracking
Configure discount codes with percentage or flat-amount reductions and usage limits
Subscribe to event notifications for transaction completions, subscription changes, and payment failures
Use Cases
Patterns agents use Paddle API for, with concrete tasks.
★ AI Agent Billing Automation
AI agents manage Paddle billing through Jentic without storing API tokens directly. An agent searches for 'create a Paddle subscription' via Jentic, receives the operation schema with required customer and price fields, and executes the call with credential isolation. Transaction monitoring, invoice retrieval, and refund processing follow the same intent-based pattern, all while Paddle handles tax compliance.
Search Jentic for 'create a Paddle subscription', load the schema, create a subscription for a customer on a monthly price, then verify the subscription status is active
SaaS Product Billing with Tax Compliance
Sell software subscriptions globally with Paddle acting as merchant of record, meaning Paddle collects payment from customers, calculates and remits sales tax and VAT in 200+ countries, and pays the net revenue to your bank account. You define products and prices, Paddle handles checkout, invoicing, and tax obligations. This eliminates the need for tax registration in multiple jurisdictions.
Create a product, add a monthly price of $29 USD, create a customer, then retrieve a subscription to confirm tax was calculated and the total includes VAT
Transaction and Refund Management
Track payment transactions from initiation through completion with full details on payment method, tax breakdown, and settlement status. Issue refunds and credits via the adjustments endpoint, specifying the original transaction ID, refund amount, and reason. Paddle handles the refund processing and adjusts the payout to your account accordingly.
Retrieve a completed transaction by ID, create an adjustment of type refund for the full amount with reason 'customer_request', then verify the adjustment status
Subscription Lifecycle and Upgrades
Manage subscription state transitions including upgrades, downgrades, pauses, and cancellations with automatic proration. When a customer changes plans mid-cycle, Paddle calculates the credit for unused time and charges the difference immediately or applies it to the next invoice. Cancellations can be immediate or scheduled for the end of the current billing period.
Update a subscription to a higher-tier price, verify the proration credit was applied, then cancel the subscription effective at period end using POST /subscriptions/{id}/cancel
Key Endpoints
27 endpoints — handle subscription billing as a merchant of record where paddle collects payment, calculates sales tax and vat, and remits to tax authorities on your behalf.
METHOD
PATH
DESCRIPTION
POST
/products
Create a new product in the catalog
POST
/prices
Create a price for a product
POST
/customers
Create a new customer record
GET
/subscriptions
List all subscriptions with filtering
POST
/subscriptions/{subscription_id}/cancel
Cancel a subscription
GET
/transactions/{transaction_id}
Retrieve transaction details
POST
/adjustments
Create a credit or refund adjustment
GET
/invoices/{transaction_id}
Retrieve invoice for a transaction
POST
/products
Create a new product in the catalog
POST
/prices
Create a price for a product
POST
/customers
Create a new customer record
GET
/subscriptions
List all subscriptions with filtering
POST
/subscriptions/{subscription_id}/cancel
Cancel a subscription
GET
/transactions/{transaction_id}
Retrieve transaction details
POST
/adjustments
Create a credit or refund adjustment
GET
/invoices/{transaction_id}
Retrieve invoice for a transaction
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
P
Paddle API
- AI-Aware (A-)71/100
90
Foundational Compliance63
Developer Experience & Jentic Compatibility56
AI-Readiness & Agent Experience94
Agent Usability60
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
90
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
60%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
56
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: CSignals: 4
63%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
61%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
60
Security
Trust, risk posture, and security compliance.
Grade: B-Signals: 1
60%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Paddle by hand means learning its bearer-key auth against api.paddle.com, shaping product, price, and subscription payloads correctly, and handling errors and retries yourself. Through Jentic you install once, import the Paddle API from the API Directory, store the key once, and your agent calls it.
Permission scoping
Paddle puts the subscription id in the URL path (/subscriptions/{subscription_id}/cancel), so a rule can pin your agent to the subscription operations you approve. You choose the operations it may call, so a cancel or an adjustment is not included unless you add it.
Credential isolation
Your Paddle key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create a subscription' or 'issue a refund', and Jentic returns the matching Paddle operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Alternative
Stripe API
Full-stack payment platform where you handle tax obligations yourself
Choose Stripe when you want full control over pricing, tax handling, and payment method support rather than a merchant-of-record model
Complementary
Stripe API
Use Stripe for payment methods and checkout that Paddle doesn't natively support
Combine with Stripe when you need payment methods or checkout experiences not available through Paddle's managed checkout
FAQs
Specific to using Paddle API through Jentic.
Is there an official OpenAPI spec for Paddle API?
Yes. PaddleHQ publishes an OpenAPI 3.1 description of the Paddle API in its GitHub repository, currently served from `https://raw.githubusercontent.com/PaddleHQ/paddle-openapi/main/v1/openapi.yaml`, and that repository states the file is generated automatically whenever Paddle releases API changes. It covers considerably more of the Paddle API than this specification, which Jentic generated from Paddle's published API reference and validates against the live API. Use the Paddle repository directly when you need the vendor's full surface. Run it through Jentic One, the self-hosted execution layer.
What authentication does the Paddle API use?
The Paddle API uses Bearer token authentication. Pass your API key in the Authorization header as 'Bearer {api_key}'. Keys are generated in the Paddle dashboard under Developer Tools > Authentication. Through Jentic, your Paddle API key is stored encrypted in your Jentic One instance - agents receive scoped access without seeing the raw token.
How does Paddle handle sales tax and VAT?
As merchant of record, Paddle automatically calculates sales tax and VAT for 200+ countries based on the customer's location and your product's tax category. The tax amount is included in transaction totals and Paddle remits directly to tax authorities. You receive net revenue after tax. Transaction details via GET /transactions/{transaction_id} show the full tax breakdown.
What are the rate limits for the Paddle API?
Paddle applies rate limits of 100 requests per minute for write operations (POST, PUT, PATCH, DELETE) and 200 requests per minute for read operations (GET). If exceeded, the API returns HTTP 429 with a Retry-After header. Higher limits are available on enterprise plans.
How do I create a subscription through the Paddle API via Jentic?
Search Jentic for 'create a Paddle subscription' to find the subscription creation flow. You need a customer ID and price ID (create these first via POST /customers and POST /prices). The subscription links the customer to a recurring price with automatic billing. Jentic loads the full schema so your agent knows which fields are required. Run it through Jentic One, the self-hosted execution layer.
Can I issue refunds through the Paddle API?
Yes. Create an adjustment via POST /adjustments with action 'refund', the original transaction_id, and the items to refund. You can refund full or partial amounts. Paddle processes the refund to the customer's original payment method and deducts the amount from your next payout. The adjustment response includes the refund status and breakdown.
Does the Paddle API support multiple currencies?
Yes. Prices can be configured in multiple currencies (USD, EUR, GBP, and 20+ others). Each price object specifies the currency and amount. When a customer subscribes, the transaction is processed in the price's currency. Paddle handles currency conversion for payouts to your bank account if your payout currency differs.
Can I limit what my agent is allowed to do with the Paddle API?
Yes. Because Jentic One is self-hosted, you decide which Paddle operations your agent may call, so it can create products, prices, and customers or list subscriptions without ever being able to run a cancel or a refund unless you explicitly add those. Paddle puts the subscription id in the URL path, as in POST /subscriptions/{subscription_id}/cancel, so your own rules can pin the agent to just the subscription operations you approve. Destructive actions like POST /adjustments stay out of reach until you grant them, and the encrypted Paddle key is injected only for the calls you allow.
GET STARTED