Most list endpoints only return active entities by default, so archived entities aren't included in the results.
| Entity | Default scope |
|---|---|
| Most list operations | active |
| Adjustments | all |
| Notifications | all |
| Notification settings | all |
| Reports | all |
| Subscriptions | all |
| Transactions | all |
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:
/products?status=archived Return entities that match the specified status. Use a comma-separated list to specify multiple status values.
To return all entities, use a comma to include active and archived. For example:
/products?status=archived,active Return entities that match the specified status. Use a comma-separated list to specify multiple status values.