Subscription Collection

June 5, 2026 ยท View on GitHub

The list of subscriptions.

Structure

SubscriptionCollection

Fields

NameTypeTagsDescriptionGetterSetter
SubscriptionsList<Subscription>OptionalAn array of subscriptions.

Constraints: Minimum Items: 0, Maximum Items: 32767
List getSubscriptions()setSubscriptions(List subscriptions)
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)

{
  "subscriptions": [
    {
      "id": "id6",
      "plan_id": "plan_id8",
      "start_time": "start_time0",
      "quantity": "quantity2",
      "shipping_amount": {
        "currency_code": "currency_code0",
        "value": "value6"
      }
    },
    {
      "id": "id6",
      "plan_id": "plan_id8",
      "start_time": "start_time0",
      "quantity": "quantity2",
      "shipping_amount": {
        "currency_code": "currency_code0",
        "value": "value6"
      }
    }
  ],
  "links": [
    {
      "href": "href6",
      "rel": "rel0",
      "method": "HEAD"
    }
  ]
}