Nexus

Nexus APIs

GET /v1/organizations/{organizationId}/subscriptions

Gets a list of subscriptions for the organization

Requires the organization.read permission Requires the subscription.read permission

Parameters
Name In Required Description
organizationId path Yes —
select query No One or more comma separated fields to select.
orderby query No One or more fields to sort by, with optional ascending/descending indicator. (e.g. name DESC)
filter query No An OData filter expression. e.g. field_name eq 123
top query No The maximum number of rows to return in the response.
count query No Indicates if the response should contain a field with the total count of records.
expand query No Indicates if the response should expand nested objects.
skip query No Indicates the number of records to skip. Combine with $top for paging operations.
Responses
200
Example 
{
  "value": [
    {
      "id": 0,
      "logs": [
        {
          "severity": null,
          "subscription": null
        }
      ],
      "type": "string",
      "status": "string",
      "created": "string",
      "details": "string",
      "expires": "string",
      "product": {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      },
      "modified": "string",
      "createdBy": "string",
      "isEnabled": false,
      "productId": 0,
      "modifiedBy": "string",
      "statusText": "string",
      "description": "string",
      "organization": {
        "id": 0,
        "name": "string",
        "type": null,
        "aliases": [],
        "contact": "string",
        "created": "string",
        "domains": [],
        "members": [],
        "isActive": false,
        "modified": "string",
        "products": [],
        "createdBy": "string",
        "modifiedBy": "string",
        "allowUpsell": false,
        "displayName": "string",
        "applications": [],
        "crmAccountId": "string",
        "isMfaRequired": false,
        "isSelfService": false,
        "subscriptions": [],
        "technicalContact": "string",
        "isEnabledForPreviewFeatures": false,
        "isDomainVerificationRequired": false
      },
      "customMetadata": {},
      "organizationId": 0,
      "readonlyMetadata": {},
      "applicationDeployments": [
        {
          "application": null,
          "subscription": null,
          "customMetadata": null,
          "deploymentTarget": null,
          "readonlyMetadata": null
        }
      ]
    }
  ],
  "@odata.count": 0,
  "@odata.context": "string"
}
Schema
Name Type Attributes Description Extensions
@odata.context string nullable — —
@odata.count number nullable — —
value — — —
Example 
{
  "value": [
    {
      "id": 0,
      "logs": [
        {
          "severity": null,
          "subscription": null
        }
      ],
      "type": "string",
      "status": "string",
      "created": "string",
      "details": "string",
      "expires": "string",
      "product": {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      },
      "modified": "string",
      "createdBy": "string",
      "isEnabled": false,
      "productId": 0,
      "modifiedBy": "string",
      "statusText": "string",
      "description": "string",
      "organization": {
        "id": 0,
        "name": "string",
        "type": null,
        "aliases": [],
        "contact": "string",
        "created": "string",
        "domains": [],
        "members": [],
        "isActive": false,
        "modified": "string",
        "products": [],
        "createdBy": "string",
        "modifiedBy": "string",
        "allowUpsell": false,
        "displayName": "string",
        "applications": [],
        "crmAccountId": "string",
        "isMfaRequired": false,
        "isSelfService": false,
        "subscriptions": [],
        "technicalContact": "string",
        "isEnabledForPreviewFeatures": false,
        "isDomainVerificationRequired": false
      },
      "customMetadata": {},
      "organizationId": 0,
      "readonlyMetadata": {},
      "applicationDeployments": [
        {
          "application": null,
          "subscription": null,
          "customMetadata": null,
          "deploymentTarget": null,
          "readonlyMetadata": null
        }
      ]
    }
  ],
  "@odata.count": 0,
  "@odata.context": "string"
}
Schema
Name Type Attributes Description Extensions
@odata.context string nullable — —
@odata.count number nullable — —
value — — —
Example 
{
  "value": [
    {
      "id": 0,
      "logs": [
        {
          "severity": null,
          "subscription": null
        }
      ],
      "type": "string",
      "status": "string",
      "created": "string",
      "details": "string",
      "expires": "string",
      "product": {
        "id": 0,
        "url": "string",
        "name": "string",
        "created": "string",
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "displayName": "string",
        "applications": [],
        "organization": null,
        "subscriptions": [],
        "organizationId": 0,
        "publicMetadata": null,
        "longDescription": "string"
      },
      "modified": "string",
      "createdBy": "string",
      "isEnabled": false,
      "productId": 0,
      "modifiedBy": "string",
      "statusText": "string",
      "description": "string",
      "organization": {
        "id": 0,
        "name": "string",
        "type": null,
        "aliases": [],
        "contact": "string",
        "created": "string",
        "domains": [],
        "members": [],
        "isActive": false,
        "modified": "string",
        "products": [],
        "createdBy": "string",
        "modifiedBy": "string",
        "allowUpsell": false,
        "displayName": "string",
        "applications": [],
        "crmAccountId": "string",
        "isMfaRequired": false,
        "isSelfService": false,
        "subscriptions": [],
        "technicalContact": "string",
        "isEnabledForPreviewFeatures": false,
        "isDomainVerificationRequired": false
      },
      "customMetadata": {},
      "organizationId": 0,
      "readonlyMetadata": {},
      "applicationDeployments": [
        {
          "application": null,
          "subscription": null,
          "customMetadata": null,
          "deploymentTarget": null,
          "readonlyMetadata": null
        }
      ]
    }
  ],
  "@odata.count": 0,
  "@odata.context": "string"
}
Schema
Name Type Attributes Description Extensions
@odata.context string nullable — —
@odata.count number nullable — —
value — — —
Security

Authentication is required for this operation.

Source: default

Requirements (any one option may satisfy)

  • Bearer and ApplicationToken
  • Basic

Try it