APappdirect
Subscriptions

Read addon instances for a subscription

Changed on

Read addon instances for a subscription

get/billing/v1/subscriptions/{subscriptionId}/addons

Request

Path parameters

subscriptionIdstring required

Subscription ID

Query parameters

filterstring

Search filter

sortField'DATE' | 'STATUS' | 'UUID'

Sort field (UUID, DATE or STATUS)

sortOrder'ASC' | 'DESC'

Sort order (ASC or DESC)

Response

OK

creationDatenumber nullable

Creation date of the addon instance

offeringUuidstring nullable

Unique identifier for add-on offering

statusstring nullable

Addon instance status. May be ACTIVE, CANCELLED or FAILED.

unitsnumber nullable

Units for add-on instance

uuidstring nullable

Unique identifier for add-on instance

Example response

[
  {
    "creationDate": 12345,
    "offeringUuid": "...",
    "order": {
      "_embedded": {
        "property1": {},
        "property2": {}
      },
      "activated": true,
      "company": {
        "href": "...",
        "id": "..."
      },
      "contract": {},
      "currency": "...",
      "customAttribute": [
        {
          "attributeType": "MULTISELECT",
          "name": "...",
          "value": "...",
          "valueKeys": [
            "...",
            "..."
          ]
        },
        {
          "attributeType": "MULTISELECT",
          "name": "...",
          "value": "...",
          "valueKeys": [
            "...",
            "..."
          ]
        }
      ],
      "discount": {
        "href": "...",
        "id": "..."
      },
      "discountId": 12345,
      "endDate": 12345,
      "endOfDiscountDate": 12345,
      "frequency": "...",
      "id": 12345,
      "links": [
        {
          "href": "...",
          "rel": "..."
        },
        {
          "href": "...",
          "rel": "..."
        }
      ],
      "nextBillingDate": 12345,
      "nextOrder": {
        "href": "...",
        "id": "..."
      },
      "oneTimeOrder": [
        {
          "_embedded": {
            "property1": {},
            "property2": {}
          },
          "company": {},
          "currency": "...",
          "endDate": 12345,
          "endOfDiscountDate": 12345,
          "frequency": "...",
          "id": 12345,
          "links": [
            {},
            {}
          ],
          "nextBillingDate": 12345,
          "paymentPlan": {},
          "referenceCode": "...",
          "salesSupportUser": {},
          "startDate": 12345,
          "status": "...",
          "totalPrice": 12345,
          "type": "...",
          "user": {}
        },
        {
          "_embedded": {
            "property1": {},
            "property2": {}
          },
          "company": {},
          "currency": "...",
          "endDate": 12345,
          "endOfDiscountDate": 12345,
          "frequency": "...",
          "id": 12345,
          "links": [
            {},
            {}
          ],
          "nextBillingDate": 12345,
          "paymentPlan": {},
          "referenceCode": "...",
          "salesSupportUser": {},
          "startDate": 12345,
          "status": "...",
          "totalPrice": 12345,
          "type": "...",
          "user": {}
        }
      ],
      "orderLine": [
        {},
        {}
      ],
      "parameter": [
        {
          "name": "...",
          "value": "..."
        },
        {
          "name": "...",
          "value": "..."
        }
      ],
      "paymentPlan": {
        "allowCustomUsage": true,
        "contract": {},
        "cost": [
          {},
          {}
        ],
        "discount": {},
        "frequency": "...",
        "href": "...",
        "id": 12345,
        "isPrimaryPrice": true,
        "keepBillDateOnUsageChange": true,
        "primaryPrice": true,
        "separatePrepaid": true,
        "tld": "...",
        "uuid": "..."
      },
      "paymentPlanId": 12345,
      "previousOrder": {
        "href": "...",
        "id": "..."
      },
      "referenceCode": "...",
      "salesSupportUser": {
        "href": "...",
        "id": "..."
      },
      "startDate": 12345,
      "status": "...",
      "totalPrice": 12345,
      "type": "...",
      "user": {
        "href": "...",
        "id": "..."
      }
    },
    "status": "...",
    "units": 12345,
    "uuid": "..."
  }
]

Changes