Pax8Install

Summary

List Pax8 subscriptions with filtering, sorting, and pagination controls.

Inputs

• baseUrl — Base URL for the Pax8 API. Defaults to https://api.pax8.com.
• returnAll — Automatically paginate through all results. When true, pagination continues until all items are fetched (up to maxResults if set).
• maxResults — Maximum number of results to return. 0 means no limit. Only applies when returnAll is true.
• page — The page number to request in the subscriptions list. Used when returnAll is false.
• size — Number of subscriptions returned per page. Used when returnAll is false.
• sort — Return subscriptions sorted by this field and direction, formatted as fieldName,direction (e.g., createdDate,desc). Defaults to quantity,asc.
• status — Return only subscriptions matching this status value. Options include Active, Cancelled, PendingManual, PendingAutomated, PendingCancel, WaitingForDetails, Trial, Converted, PendingActivation, Activated.
• billingTerm — Return only subscriptions matching this billingTerm value. Options include Monthly, Annual, 2-Year, 3-Year, One-Time, Trial, Activation. Defaults to Monthly.
• companyId — Return only subscriptions matching this companyId value. Populated via the getCompanies load options method.
• productId — Return only subscriptions matching this productId value. Populated via the getProducts load options method.

Output shape

array

Returns an array of subscription objects from the Pax8 API. When returnAll is enabled, items are paginated automatically and output as separate items. If the API returns no content, the raw response is returned instead.

Examples

Example 1: List the first page of active subscriptions.

Leave all filters at defaults; set page to 1 or omit for default page 1.

Example 2: Retrieve all subscriptions with a maximum of 50 results.

Set returnAll to true and maxResults to 50.

Links

• n8n community nodes installation guide