List Coupons

post

/2.0/product/list_coupons

List all coupons valid for a specified one-time product or subscription plan

Example Request

preparing...

Usage Notes

This endpoint is paginated, with a max 500 results per page. Use the limit and offset parameters to work with pagination

Pagination is scheduled to be enforced on this endpoint from March 11, 2025. To learn more, see Pagination for Paddle Classic endpoints

Request

Body

vendor_id

integer

required

The vendor ID identifies your seller account. This can be found in Developer Tools > Authentication.

>= 1

vendor_auth_code

string

required

The vendor auth code is a private API key for authenticating API requests. This key should never be used in client side code or shared publicly. This can be found in Developer Tools > Authentication.

Match pattern:

[0-9a-f]+

product_id

integer

required

The specific product/plan ID.

>= 1

limit

integer

Number of records to return per page.

>= 1

offset

integer

Record to return results from.

>= 1

is_valid

boolean

Whether this coupon is valid (true) or invalid (false).

coupon

string

Filter: A specific code.

Body