# Paddle API API

> Paddle API API on Apizie: 126 endpoints (Get account, Update account, List addresses for a customer, Create an address for a customer, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/payments:paddle/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:paddle`
- Category: Payments
- Status: byok
- Source: https://developer.paddle.com
- Page: https://apizie.tech/api/payments/paddle
- OpenAPI: https://apizie.tech/api/payments/paddle/openapi.json

Paddle Billing is a complete subscription and recurring revenue management platform, designed for modern SaaS businesses. It helps you increase your revenue, retain customers, and scale your operations. The Paddle API…

## Endpoints

### Get account
`GET https://apizie.tech/v1/payments:paddle/get-account` (byok)

### Update account
`POST https://apizie.tech/v1/payments:paddle/patch-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List addresses for a customer
`GET https://apizie.tech/v1/payments:paddle/list-addresses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| status | array | no | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
| search | string | no | Return entities that match a search query. Searches all fields except `status`, `created_at`, and `updated_at`. |
| customer_id | string | yes | Paddle ID of the customer entity to work with. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Create an address for a customer
`POST https://apizie.tech/v1/payments:paddle/create-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | Paddle ID of the customer entity to work with. |
| body | object | yes | JSON request body |

### Get an address for a customer
`GET https://apizie.tech/v1/payments:paddle/get-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| address_id | string | yes | Paddle ID of the address entity to work with. |
| customer_id | string | yes | Paddle ID of the customer entity to work with. |

### Update an address for a customer
`POST https://apizie.tech/v1/payments:paddle/update-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| address_id | string | yes | Paddle ID of the address entity to work with. |
| customer_id | string | yes | Paddle ID of the customer entity to work with. |
| body | object | yes | JSON request body |

### List adjustments
`GET https://apizie.tech/v1/payments:paddle/list-adjustments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| action | array | no | Return entities for the specified action. Use a comma-separated list to specify multiple action values. |
| customer_id | array | no | Return entities related to the specified customer. Use a comma-separated list to specify multiple customer IDs. |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| status | array | no | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
| subscription_id | array | no | Return entities related to the specified subscription. Use a comma-separated list to specify multiple subscription IDs. |
| transaction_id | array | no | Return entities related to the specified transaction. Use a comma-separated list to specify multiple transaction IDs. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Create an adjustment
`POST https://apizie.tech/v1/payments:paddle/create-adjustment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a PDF credit note for an adjustment
`GET https://apizie.tech/v1/payments:paddle/get-adjustment-credit-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| adjustment_id | string | yes | Paddle ID of the adjustment entity to work with. |
| disposition | string | no | Determine whether the generated URL should download the PDF as an attachment saved locally, or open it inline in the browser. Default:… |

### Get balance currency settings
`GET https://apizie.tech/v1/payments:paddle/get-balance-currency` (byok)

### Update balance currency settings
`POST https://apizie.tech/v1/payments:paddle/update-balance-currency` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List businesses for a customer
`GET https://apizie.tech/v1/payments:paddle/list-businesses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| status | array | no | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
| search | string | no | Return entities that match a search query. Searches all fields, including contacts, except `status`, `created_at`, and `updated_at`. |
| customer_id | string | yes | Paddle ID of the customer entity to work with. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Create a business for a customer
`POST https://apizie.tech/v1/payments:paddle/create-business` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | Paddle ID of the customer entity to work with. |
| body | object | yes | JSON request body |

### Get a business for a customer
`GET https://apizie.tech/v1/payments:paddle/get-business` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| business_id | string | yes | Paddle ID of the business entity to work with. |
| customer_id | string | yes | Paddle ID of the customer entity to work with. |

### Update a business for a customer
`POST https://apizie.tech/v1/payments:paddle/update-business` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| business_id | string | yes | Paddle ID of the business entity to work with. |
| customer_id | string | yes | Paddle ID of the customer entity to work with. |
| body | object | yes | JSON request body |

### List checkout domains
`GET https://apizie.tech/v1/payments:paddle/list-checkout-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| domain | string | no | Filter results to include the specified fully qualified domain name (FQDN), its ancestors, and any of its subdomains. For example, if you… |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| status | array | no | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Get a checkout domain
`GET https://apizie.tech/v1/payments:paddle/get-checkout-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| domain_id | string | yes | Paddle ID of the checkout domain entity to work with. |

### Delete a checkout domain
`POST https://apizie.tech/v1/payments:paddle/delete-checkout-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| domain_id | string | yes | Paddle ID of the checkout domain entity to work with. |

### Verify a payment method for a checkout domain
`POST https://apizie.tech/v1/payments:paddle/verify-checkout-domain-payment-method` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| domain_id | string | yes | Paddle ID of the checkout domain entity to work with. |
| body | object | yes | JSON request body |

### Get checkout feature settings
`GET https://apizie.tech/v1/payments:paddle/get-checkout-features` (byok)

### Update checkout feature settings
`POST https://apizie.tech/v1/payments:paddle/update-checkout-features` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get checkout payment method settings
`GET https://apizie.tech/v1/payments:paddle/get-checkout-payment-method-settings` (byok)

### Update checkout payment method settings
`POST https://apizie.tech/v1/payments:paddle/update-checkout-payment-method-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get checkout recovery settings
`GET https://apizie.tech/v1/payments:paddle/get-checkout-recovery` (byok)

### Update checkout recovery settings
`POST https://apizie.tech/v1/payments:paddle/update-checkout-recovery` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get overlay checkout style settings
`GET https://apizie.tech/v1/payments:paddle/get-checkout-styles-overlay` (byok)

### Update overlay checkout style settings
`POST https://apizie.tech/v1/payments:paddle/update-checkout-styles-overlay` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get checkout URL settings
`GET https://apizie.tech/v1/payments:paddle/get-checkout-url` (byok)

### Update checkout URL settings
`POST https://apizie.tech/v1/payments:paddle/update-checkout-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List client-side tokens
`GET https://apizie.tech/v1/payments:paddle/list-client-tokens` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| status | array | no | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Create a client-side token
`POST https://apizie.tech/v1/payments:paddle/create-client-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a client-side token
`GET https://apizie.tech/v1/payments:paddle/get-client-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| client_token_id | string | yes | Paddle ID of the client-side token entity. |

### Update a client-side token
`POST https://apizie.tech/v1/payments:paddle/update-client-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| client_token_id | string | yes | Paddle ID of the client-side token entity. |
| body | object | yes | JSON request body |

### List Paddle countries
`GET https://apizie.tech/v1/payments:paddle/list-countries` (byok)

### List Paddle currencies
`GET https://apizie.tech/v1/payments:paddle/list-currencies` (byok)

### Get currency conversion settings
`GET https://apizie.tech/v1/payments:paddle/get-currency-conversions` (byok)

### Update currency conversion settings
`POST https://apizie.tech/v1/payments:paddle/update-currency-conversions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List customers
`GET https://apizie.tech/v1/payments:paddle/list-customers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| email | array | no | Return entities that exactly match the specified email address. Use a comma-separated list to specify multiple email addresses.… |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| status | array | no | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
| search | string | no | Return entities that match a search query. Searches `id`, `name`, and `email` fields. Use the `email` query parameter for precise matching… |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Create a customer
`POST https://apizie.tech/v1/payments:paddle/create-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a customer
`GET https://apizie.tech/v1/payments:paddle/get-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | Paddle ID of the customer entity to work with. |

### Update a customer
`POST https://apizie.tech/v1/payments:paddle/update-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | Paddle ID of the customer entity to work with. |
| body | object | yes | JSON request body |

### List credit balances for a customer
`GET https://apizie.tech/v1/payments:paddle/list-credit-balances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | Paddle ID of the customer entity to work with. |
| currency_code | array | no | Return entities that match the currency code. Use a comma-separated list to specify multiple currency codes. |

### Generate an authentication token for a customer
`POST https://apizie.tech/v1/payments:paddle/generate-customer-authentication-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | Paddle ID of the customer entity to work with. |

### Create a customer portal session
`POST https://apizie.tech/v1/payments:paddle/create-customer-portal-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | Paddle ID of the customer entity to work with. |
| body | object | yes | JSON request body |

### List discount groups
`GET https://apizie.tech/v1/payments:paddle/list-discount-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Create a discount group
`POST https://apizie.tech/v1/payments:paddle/create-discount-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a discount group
`GET https://apizie.tech/v1/payments:paddle/get-discount-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| discount_group_id | string | yes | Paddle ID of the discount group entity to work with. |

### Update a discount group
`POST https://apizie.tech/v1/payments:paddle/update-discount-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| discount_group_id | string | yes | Paddle ID of the discount group entity to work with. |
| body | object | yes | JSON request body |

### List discounts
`GET https://apizie.tech/v1/payments:paddle/list-discounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| include | array | no | Include related entities in the response. Use a comma-separated list to specify multiple entities. |
| code | array | no | Return entities that match the discount code. Use a comma-separated list to specify multiple discount codes. |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| status | array | no | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
| mode | string | no | Return entities that match the specified mode. |
| discount_group_id | array | no | Return entities related to the specified discount group. Use a comma-separated list to specify multiple discount group IDs. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Create a discount
`POST https://apizie.tech/v1/payments:paddle/create-discount` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a discount
`GET https://apizie.tech/v1/payments:paddle/get-discount` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| include | array | no | Include related entities in the response. Use a comma-separated list to specify multiple entities. |
| discount_id | string | yes | Paddle ID of the discount entity to work with. |

### Update a discount
`POST https://apizie.tech/v1/payments:paddle/update-discount` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| discount_id | string | yes | Paddle ID of the discount entity to work with. |
| body | object | yes | JSON request body |

### List events types
`GET https://apizie.tech/v1/payments:paddle/list-event-types` (byok)

### List events
`GET https://apizie.tech/v1/payments:paddle/list-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| event_type | array | no | Return events that match the specified event type. Use a comma-separated list to specify multiple event types. |
| filter | string | no | Return entities that contain the value specified. Pass a Paddle ID or email address that appears in the event payload, or part of one.… |
| to | string | no | Return entities up to a specific time. Pass an RFC 3339 datetime string. |
| from | string | no | Return entities from a specific time. Pass an RFC 3339 datetime string. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Get Paddle IP addresses
`GET https://apizie.tech/v1/payments:paddle/get-ip-addresses` (byok)

### List Explore metric entities
`GET https://apizie.tech/v1/payments:paddle/list-explore-metric-entities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| entity | string | no | Return the metric that matches the specified entity name. Omit to return all metrics that are available. An unknown value, including… |

### Run an Explore metrics query
`POST https://apizie.tech/v1/payments:paddle/run-explore-metrics-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| after | string | no | Pagination cursor from the previous response's `meta.pagination.next`. Omit for the first page. Send the same request body with it: a… |
| body | object | yes | JSON request body |

### Get MRR (monthly recurring revenue) metrics
`GET https://apizie.tech/v1/payments:paddle/get-metrics-monthly-recurring-revenue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| from | string | yes | Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`. |
| to | string | yes | Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`. |

### Get active subscribers metrics
`GET https://apizie.tech/v1/payments:paddle/get-metrics-active-subscribers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| from | string | yes | Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`. |
| to | string | yes | Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`. |

### Get MRR change (monthly recurring revenue change) metrics
`GET https://apizie.tech/v1/payments:paddle/get-metrics-monthly-recurring-revenue-change` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| from | string | yes | Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`. |
| to | string | yes | Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`. |

### Get net revenue metrics
`GET https://apizie.tech/v1/payments:paddle/get-metrics-revenue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| from | string | yes | Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`. |
| to | string | yes | Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`. |

### Get refund metrics
`GET https://apizie.tech/v1/payments:paddle/get-metrics-refunds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| from | string | yes | Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`. |
| to | string | yes | Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`. |

### Get chargeback metrics
`GET https://apizie.tech/v1/payments:paddle/get-metrics-chargebacks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| from | string | yes | Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`. |
| to | string | yes | Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`. |

### Get checkout conversion metrics
`GET https://apizie.tech/v1/payments:paddle/get-metrics-checkout-conversion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| from | string | yes | Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`. |
| to | string | yes | Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`. |

### List notification settings
`GET https://apizie.tech/v1/payments:paddle/list-notification-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| active | boolean | no | Determine whether returned entities are active (`true`) or not (`false`). |
| traffic_source | string | no | Return entities that match the specified traffic source. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Create a notification setting
`POST https://apizie.tech/v1/payments:paddle/create-notification-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a notification setting
`GET https://apizie.tech/v1/payments:paddle/get-notification-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| notification_setting_id | string | yes | Paddle ID of the notification setting entity (notification destination) to work with. |

### Update a notification setting
`POST https://apizie.tech/v1/payments:paddle/update-notification-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| notification_setting_id | string | yes | Paddle ID of the notification setting entity (notification destination) to work with. |
| body | object | yes | JSON request body |

### Delete a notification setting
`POST https://apizie.tech/v1/payments:paddle/delete-notification-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| notification_setting_id | string | yes | Paddle ID of the notification setting entity (notification destination) to work with. |

### List notifications
`GET https://apizie.tech/v1/payments:paddle/list-notifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| notification_setting_id | array | no | Return entities related to the specified notification destination. Use a comma-separated list to specify multiple notification destination… |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| search | string | no | Return entities that match a search query. Searches `id` and `type` fields. |
| status | array | no | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
| filter | string | no | Return entities that contain the value specified. Pass a Paddle ID or email address that appears in the event payload, or part of one.… |
| to | string | no | Return entities up to a specific time. Pass an RFC 3339 datetime string. |
| from | string | no | Return entities from a specific time. Pass an RFC 3339 datetime string. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Get a notification
`GET https://apizie.tech/v1/payments:paddle/get-notification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| notification_id | string | yes | Paddle ID of the notification entity to work with. |

### List logs for a notification
`GET https://apizie.tech/v1/payments:paddle/list-notification-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| notification_id | string | yes | Paddle ID of the notification entity to work with. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Replay a notification
`POST https://apizie.tech/v1/payments:paddle/replay-notification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| notification_id | string | yes | Paddle ID of the notification entity to work with. |

### List payment methods for a customer
`GET https://apizie.tech/v1/payments:paddle/list-customer-payment-methods` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | Paddle ID of the customer entity to work with. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| address_id | array | no | Return entities related to the specified address. Use a comma-separated list to specify multiple address IDs. |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| supports_checkout | boolean | no | Return entities that support being presented at checkout (`true`) or not (`false`). |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Get a payment method for a customer
`GET https://apizie.tech/v1/payments:paddle/get-customer-payment-method` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | Paddle ID of the customer entity to work with. |
| payment_method_id | string | yes | Paddle ID of the payment method entity to work with. |

### Delete a payment method for a customer
`POST https://apizie.tech/v1/payments:paddle/delete-customer-payment-method` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | Paddle ID of the customer entity to work with. |
| payment_method_id | string | yes | Paddle ID of the payment method entity to work with. |

### List prices
`GET https://apizie.tech/v1/payments:paddle/list-prices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| include | array | no | Include related entities in the response. |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| product_id | array | no | Return entities related to the specified product. Use a comma-separated list to specify multiple product IDs. |
| status | array | no | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
| recurring | boolean | no | Determine whether returned entities are for recurring prices (`true`) or one-time prices (`false`). |
| billing_cycle.interval | string | no | Return entities where the price billing cycle interval matches this value. |
| billing_cycle.frequency | integer | no | Return entities where the price billing cycle frequency matches this value. |
| type | string | no | Return items that match the specified type. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Create a price
`POST https://apizie.tech/v1/payments:paddle/create-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a price
`GET https://apizie.tech/v1/payments:paddle/get-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| include | array | no | Include related entities in the response. |
| price_id | string | yes | Paddle ID of the price entity to work with. |

### Update a price
`POST https://apizie.tech/v1/payments:paddle/update-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| price_id | string | yes | Paddle ID of the price entity to work with. |
| body | object | yes | JSON request body |

### Preview prices
`POST https://apizie.tech/v1/payments:paddle/preview-prices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List products
`GET https://apizie.tech/v1/payments:paddle/list-products` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| include | array | no | Include related entities in the response. Use a comma-separated list to specify multiple entities. |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| status | array | no | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
| tax_category | array | no | Return entities that match the specified tax category. Use a comma-separated list to specify multiple tax categories. |
| type | string | no | Return items that match the specified type. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Create a product
`POST https://apizie.tech/v1/payments:paddle/create-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a product
`GET https://apizie.tech/v1/payments:paddle/get-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| include | array | no | Include related entities in the response. Use a comma-separated list to specify multiple entities. |
| product_id | string | yes | Paddle ID of the product entity to work with. |

### Update a product
`POST https://apizie.tech/v1/payments:paddle/update-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| product_id | string | yes | Paddle ID of the product entity to work with. |
| body | object | yes | JSON request body |

### List reports
`GET https://apizie.tech/v1/payments:paddle/list-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| status | array | no | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Create a report
`POST https://apizie.tech/v1/payments:paddle/create-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a report
`GET https://apizie.tech/v1/payments:paddle/get-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| report_id | string | yes | Paddle ID of the report entity. |

### Get a CSV file for a report
`GET https://apizie.tech/v1/payments:paddle/get-report-csv` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| report_id | string | yes | Paddle ID of the report entity. |

### Get API root
`GET https://apizie.tech/v1/payments:paddle/get-api-root` (byok)

### Get statement descriptor settings
`GET https://apizie.tech/v1/payments:paddle/get-statement-descriptor-settings` (byok)

### Update statement descriptor settings
`POST https://apizie.tech/v1/payments:paddle/update-statement-descriptor-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List simulation types
`GET https://apizie.tech/v1/payments:paddle/list-simulation-types` (byok)

### List simulations
`GET https://apizie.tech/v1/payments:paddle/list-simulations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| notification_setting_id | array | no | Return entities related to the specified notification destination. Use a comma-separated list to specify multiple notification destination… |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| status | array | no | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Create a simulation
`POST https://apizie.tech/v1/payments:paddle/create-simulation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a simulation
`GET https://apizie.tech/v1/payments:paddle/get-simulation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| simulation_id | string | yes | Paddle ID of the simulation entity to work with. |

### Update a simulation
`POST https://apizie.tech/v1/payments:paddle/update-simulation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| simulation_id | string | yes | Paddle ID of the simulation entity to work with. |
| body | object | yes | JSON request body |

### List runs for a simulation
`GET https://apizie.tech/v1/payments:paddle/list-simulation-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| simulation_id | string | yes | Paddle ID of the simulation entity to work with. |
| id | array | no | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| include | array | no | Include related entities in the response. |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Create a run for a simulation
`POST https://apizie.tech/v1/payments:paddle/create-simulation-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| simulation_id | string | yes | Paddle ID of the simulation entity to work with. |

### Get a run for a simulation
`GET https://apizie.tech/v1/payments:paddle/get-simulation-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| simulation_id | string | yes | Paddle ID of the simulation entity to work with. |
| simulation_run_id | string | yes | Paddle ID of the simulation run entity to work with. |
| include | array | no | Include related entities in the response. |

### List events for a simulation run
`GET https://apizie.tech/v1/payments:paddle/list-simulations-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| simulation_id | string | yes | Paddle ID of the simulation entity to work with. |
| simulation_run_id | string | yes | Paddle ID of the simulation run entity to work with. |
| id | array | no | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Get an event for a simulation run
`GET https://apizie.tech/v1/payments:paddle/get-simulation-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| simulation_id | string | yes | Paddle ID of the simulation entity to work with. |
| simulation_run_id | string | yes | Paddle ID of the simulation run entity to work with. |
| simulation_event_id | string | yes | Paddle ID of the simulation event entity to work with. |

### Replay an event for a simulation run
`POST https://apizie.tech/v1/payments:paddle/replay-simulation-run-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| simulation_id | string | yes | Paddle ID of the simulation entity to work with. |
| simulation_run_id | string | yes | Paddle ID of the simulation run entity to work with. |
| simulation_event_id | string | yes | Paddle ID of the simulation event entity to work with. |

### List history for a subscription
`GET https://apizie.tech/v1/payments:paddle/list-subscription-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscription_id | string | yes | Unique Paddle ID for this subscription entity, prefixed with `sub_`. |
| action | array | no | Return history entries that match the specified action. Use a comma-separated list to specify multiple action values. |
| source | array | no | Return history entries that match the specified source. Use a comma-separated list to specify multiple source values. |
| actor_type | array | no | Return history entries that match the specified actor type. Use a comma-separated list to specify multiple actor type values. |
| actor_id | array | no | Return history entries that match the specified actor ID. Use a comma-separated list to specify multiple actor ID values. Only applicable… |
| reason | array | no | Return history entries that match the specified reason. Use a comma-separated list to specify multiple reason values. |
| occurred_at | string | no | Return entities that occurred at a specific time. Use `[LTE]` (less than or equal to) or `[GTE]` (greater than or equal to) operators with… |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[DESC]`. Valid fields for… |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### List subscriptions
`GET https://apizie.tech/v1/payments:paddle/list-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| address_id | array | no | Return entities related to the specified address. Use a comma-separated list to specify multiple address IDs. |
| collection_mode | string | no | Return entities that match the specified collection mode. |
| customer_id | array | no | Return entities related to the specified customer. Use a comma-separated list to specify multiple customer IDs. |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| price_id | array | no | Return entities related to the specified price. Use a comma-separated list to specify multiple price IDs. |
| scheduled_change_action | array | no | Return subscriptions that have a scheduled change. Use a comma-separated list to specify multiple scheduled change actions. |
| next_billed_at | string | no | Return entities next billed at a specific time. Pass `null` to return entities with no next billing date. |
| status | array | no | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Get a subscription
`GET https://apizie.tech/v1/payments:paddle/get-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| include | array | no | Include related entities in the response. Use a comma-separated list to specify multiple entities. |
| subscription_id | string | yes | Paddle ID of the subscription entity to work with. |

### Update a subscription
`POST https://apizie.tech/v1/payments:paddle/update-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscription_id | string | yes | Paddle ID of the subscription entity to work with. |
| body | object | yes | JSON request body |

### Cancel a subscription
`POST https://apizie.tech/v1/payments:paddle/cancel-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscription_id | string | yes | Paddle ID of the subscription entity to work with. |
| body | object | yes | JSON request body |

### Pause a subscription
`POST https://apizie.tech/v1/payments:paddle/pause-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscription_id | string | yes | Paddle ID of the subscription entity to work with. |
| body | object | yes | JSON request body |

### Resume a paused subscription
`POST https://apizie.tech/v1/payments:paddle/resume-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscription_id | string | yes | Paddle ID of the subscription entity to work with. |
| body | object | yes | JSON request body |

### Activate a trialing subscription
`POST https://apizie.tech/v1/payments:paddle/activate-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscription_id | string | yes | Paddle ID of the subscription entity to work with. |

### Get a transaction to update payment method
`GET https://apizie.tech/v1/payments:paddle/get-subscription-update-payment-method-transaction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscription_id | string | yes | Paddle ID of the subscription entity to work with. |

### Preview an update to a subscription
`POST https://apizie.tech/v1/payments:paddle/preview-subscription-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscription_id | string | yes | Paddle ID of the subscription entity to work with. |
| body | object | yes | JSON request body |

### Create a one-time charge for a subscription
`POST https://apizie.tech/v1/payments:paddle/create-subscription-charge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscription_id | string | yes | Paddle ID of the subscription entity to work with. |
| body | object | yes | JSON request body |

### Preview a one-time charge for a subscription
`POST https://apizie.tech/v1/payments:paddle/preview-subscription-charge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscription_id | string | yes | Paddle ID of the subscription entity to work with. |
| body | object | yes | JSON request body |

### Get tax settings
`GET https://apizie.tech/v1/payments:paddle/get-tax-settings` (byok)

### Update tax settings
`POST https://apizie.tech/v1/payments:paddle/update-tax-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List transactions
`GET https://apizie.tech/v1/payments:paddle/list-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| include | array | no | Include related entities in the response. Use a comma-separated list to specify multiple entities. |
| id | array | no | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
| after | string | no | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses… |
| billed_at | string | no | Return entities billed at a specific time. Pass an RFC 3339 datetime string, or use `[LT]` (less than), `[LTE]` (less than or equal to),… |
| collection_mode | string | no | Return entities that match the specified collection mode. |
| created_at | string | no | Return entities created at a specific time. Pass an RFC 3339 datetime string, or use `[LT]` (less than), `[LTE]` (less than or equal to),… |
| customer_id | array | no | Return entities related to the specified customer. Use a comma-separated list to specify multiple customer IDs. |
| invoice_number | array | no | Return entities that match the invoice number. Use a comma-separated list to specify multiple invoice numbers. |
| origin | array | no | Return entities related to the specified origin. Use a comma-separated list to specify multiple origins. |
| order_by | string | no | Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for… |
| status | array | no | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
| subscription_id | string | no | Return entities related to the specified subscription. Use a comma-separated list to specify multiple subscription IDs. Pass `null` to… |
| per_page | integer | no | Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is… |
| updated_at | string | no | Return entities updated at a specific time. Pass an RFC 3339 datetime string, or use `[LT]` (less than), `[LTE]` (less than or equal to),… |
| Skip-Count | string | no | Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact… |

### Create a transaction
`POST https://apizie.tech/v1/payments:paddle/create-transaction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| include | array | no | Include related entities in the response. Use a comma-separated list to specify multiple entities. |
| body | object | yes | JSON request body |

### Get a transaction
`GET https://apizie.tech/v1/payments:paddle/get-transaction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| include | array | no | Include related entities in the response. Use a comma-separated list to specify multiple entities. |
| transaction_id | string | yes | Paddle ID of the transaction entity to work with. |

…and 6 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/payments:paddle/get-account" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Paddle API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/payments:paddle/get-account with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Paddle API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Paddle API itself also needs your own key from paddle.

### Can AI agents use the Paddle API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:paddle.

### What is the status of the Paddle API API?
Needs your own provider key (bring your own key)