FynnInstall

Summary

Retrieves a list of subscriptions from the Fynn API with optional filtering, sorting, and pagination.

Inputs

• Return All — Whether to return all results or only up to a given limit. When true, the node will paginate automatically to fetch all matching subscriptions. When false, Limit and Page are used to control the result set size and offset. Defaults to false (exclusive). Type: boolean; Default: false; Routing: paginate={{$value}} (enables offset pagination).
• Limit — Maximum number of subscriptions to return per page when Return All is false. Ignored when Return All is true. Type: number; Minimum: 1; Maximum: 100; Default: 50; Routing: query parameter 'limit'.
• Page — Page number to fetch when Return All is false (1‑based). Ignored when Return All is true. Type: number; Minimum: 1; Default: 1; Routing: query parameter 'page'.
• Filters — Collection of filter criteria applied as query parameters to narrow the subscription list. All filter fields are optional and default to empty strings (no filter) or default option for status. Each filter maps directly to a query parameter of the same name (dot‑notation for nested fields). Sub‑fields: Customer (string), Partner (string), Payment Method Type (string), Product ID (string), Search (string), Status (options: active, cancelled, draft, offer, paused, terminated; default: draft), Subscription ID (string), Subscription Number (string). Routing: each sends as query parameter with the same property path.
• Sort — Collection of sorting options applied as query parameters. Each option specifies a field and direction (asc or desc). Default direction is asc for all fields. Sub‑fields: Activated At (order[activatedAt]), Contract End (order[contractDetails.contractEnd]), Created At (order[createdAt]), Status (order[status]), Trial Ends On (order[trialEndsOn]). Routing: each sends as query parameter 'order[]' with value 'asc' or 'desc'.
• Request Options — Advanced HTTP request settings that affect how the node communicates with the Fynn API. These are node‑level settings and do not change the API request shape. Sub‑fields: Batching (fixed collection with Items per Batch (number, default 50, -1 disables, 0 treated as 1) and Batch Interval (ms) (number, default 1000)); Ignore SSL Issues (Insecure) (boolean, default false); Proxy (string, default empty); Timeout (number, milliseconds, default 10000).

Output shape

array

When the operation executes, the node returns an array of subscription objects under the key 'data' (as configured by the pagination helper's rootProperty). Each object contains the full subscription record as returned by the Fynn API, including fields such as id, number, status, customer, items, etc. If Return All is true, the array contains all matching subscriptions across pages; otherwise it contains the subset defined by Limit and Page.

Examples

Example 1: Fetch the first 20 active subscriptions

Set Return All to false, Limit to 20, Page to 1, and set Filters.Status to 'active'.

Example 2: Retrieve every subscription for a given customer

Set Return All to true, and set Filters.Customer to the desired customer UUID.