List Modifiers

post

/2.0/subscription/modifiers

List all subscription modifiers

Example Request

preparing...

Usage Notes

Optionally, the API accepts the plan_id with the value of a Plan/Product ID, to list all the subscriptions modifiers of a certain plan. It also accepts subscription_id to get modifiers applied to a specific subscription plan.
This endpoint is paginated, with a max 250 results per page. Use the after and results_per_page 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]+

subscription_id

string

Filter: Modifiers for a specific subscription.

Match pattern:

\d+

plan_id

string

Filter: The product/plan ID

Match pattern:

\d+

results_per_page

integer

Number of records to return per page.

>= 1

after

integer

Record to return results from. Pass a modifier ID. Use the last modifier on the current page to get the next page.

>= 1

Body