Hyros icon

Hyros

Interact with Hyros API - Complete coverage of all endpoints

Actions60

Subscription → Get

AI-generated

Summary

Fetches Hyros subscriptions matching the supplied filters. Choose whether to retrieve all pages or limit the result, and use the page ID returned by the API to continue pagination when retrieving a page at a time.

Inputs

  • Return All — When enabled, retrieves all matching subscriptions across pages. When disabled, retrieves one page, limited by Page Size.
  • Emails — Comma-separated email addresses to filter by (maximum 50).
  • From Date — Include subscriptions created on or after this date, in ISO 8601 format.
  • IDs — Comma-separated subscription IDs to filter by (maximum 50).
  • Lead IDs — Comma-separated lead IDs to filter by (maximum 50).
  • Page ID — Page cursor for continuing pagination; use the nextPageId from the prior response.
  • Page Size — Maximum subscriptions per page (1–250; defaults to 50).
  • Product Tags — Comma-separated product tags to filter by (maximum 20).
  • Subscription States — Comma-separated states to include: ACTIVE, TRIALING, CANCELED, PAST_DUE, INCOMPLETE, INCOMPLETE_EXPIRED, UNPAID, COMPLETED, or PAUSED.
  • To Date — Include subscriptions created on or before this date, in ISO 8601 format.
  • Updated From Date — Include subscriptions modified on or after this date; useful for incremental syncs.
  • Updated To Date — Include subscriptions modified on or before this date.

Output shape

A list of subscription records.

With Return All disabled, returns one page according to Page Size and Page ID. With Return All enabled, the node automatically retrieves all pages.

Links

Discussion