For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling — append .md to any URL.

Skip to content
Docs

Default scopes

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

AI summary

Most Paddle list endpoints return only active entities by default; you can use the status query parameter to include archived entities or retrieve all entities regardless of status.

  • • Entities like transactions, subscriptions, adjustments, notifications, and reports are returned for all statuses by default; most other list operations scope to active only.
  • • Pass status=archived to return only archived entities, or status=archived,active (comma-separated) to return all entities regardless of status.
  • • The estimated_total in the pagination object reflects only the entities that match the current scope, not the total across all statuses.

Most list endpoints only return active entities by default, so archived entities aren't included in the results.

EntityDefault scope
Most list operationsactive
Adjustmentsall
Notificationsall
Notification settingsall
Reportsall
Subscriptionsall
Transactionsall

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:

GET /products?status=archived
status array[string]

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:

GET /products?status=archived,active
status array[string]

Return entities that match the specified status. Use a comma-separated list to specify multiple status values.

Was this page helpful?