Paddle Billing

Default scopes

Most list endpoints return active entities. Filter by status to see entities with other statuses.

When listing entities using the Paddle API, most endpoints only return entities that are active. This means that entities that are archived aren't included in the results.

EntityDefault scope
Most list operationsactive
Notification settingsall

Most entities in the Paddle API can either be active or archived. More complex entities like transactions, subscriptions, and adjustments have their own unique status values.

The estimated total in the pagination object is for entities that match the scope.

Change scope

Use the status query parameter when making a request to get archived or active entities.

For example, to list archived products:

To return all entities, use a comma to include active and archived. For example:

Related pages