Plan Collection

June 5, 2026 ยท View on GitHub

The list of plans with details.

Structure

PlanCollection

Fields

NameTypeTagsDescriptionGetterSetter
PlansList<BillingPlan>OptionalAn array of plans.

Constraints: Minimum Items: 0, Maximum Items: 32767
List getPlans()setPlans(List plans)
TotalItemsIntegerOptionalThe total number of items.

Constraints: >= 0, <= 500000000
Integer getTotalItems()setTotalItems(Integer totalItems)
TotalPagesIntegerOptionalThe total number of pages.

Constraints: >= 0, <= 100000000
Integer getTotalPages()setTotalPages(Integer totalPages)
LinksList<LinkDescription>Optional, Read-onlyAn array of request-related HATEOAS links.

Constraints: Minimum Items: 1, Maximum Items: 10
List getLinks()setLinks(List links)

Example (as JSON)

{
  "plans": [
    {
      "id": "id4",
      "product_id": "product_id0",
      "name": "name4",
      "status": "INACTIVE",
      "description": "description4"
    }
  ],
  "total_items": 158,
  "total_pages": 194,
  "links": [
    {
      "href": "href6",
      "rel": "rel0",
      "method": "HEAD"
    },
    {
      "href": "href6",
      "rel": "rel0",
      "method": "HEAD"
    },
    {
      "href": "href6",
      "rel": "rel0",
      "method": "HEAD"
    }
  ]
}