Zoho Billing icon

Zoho Billing

Consume Zoho Billing API v1 (Subscriptions, Plans, Addons, Coupons, Invoices)

Plan → Get Many

AI-generated

Summary

Retrieve a list of plans from a Zoho Billing organization, optionally filtered by status and product, either all pages or up to a limit. Each plan is returned as a separate output item.

Inputs

  • organizationId (required) — Zoho Billing organization, chosen from a list loaded from the API. Sent as the X-com-zoho-subscriptions-organizationid header.
  • returnAll — If true, pages through /plans (200 per page) until a page returns fewer than 200 results. Default false.
  • limit — Maximum number of plans to fetch when Return All is off (min 1, default 200). Sent as per_page for a single page-1 request.
  • filterBy — Status filter sent as filter_by, e.g. PlanStatus.ACTIVE or Status.All. Omitted if empty.
  • productIdFilter — Restricts results to plans of this product ID, sent as product_id. Omitted if empty.

Output shape

A list of items, one per plan, each holding the plan object from Zoho's plans array in json.

Without Return All, only the first page (up to Limit, with the page size set by Limit) is fetched. Non-object entries are dropped. An empty result produces no items. With Continue On Fail enabled, an error produces an item containing an error message.

Examples

Example 1: List all active plans for a product

Organization selected, Return All on, Filter By = PlanStatus.ACTIVE, Product ID Filter = product ID

Example 2: Quickly sample 10 plans of any status

Return All off, Limit = 10, Filter By = Status.All

Links

Discussion