Nexus

Nexus APIs

GET /v1/subscriptions/{subscriptionId}

Gets a single subscription by Id

Parameters
Name In Required Description
subscriptionId path Yes
select query No One or more comma separated fields to select.
expand query No Indicates if the response should expand nested objects.
Responses
200
Example 
{
  "id": 0,
  "logs": [
    {
      "id": 0,
      "created": "string",
      "modified": "string",
      "severity": "string",
      "createdBy": "string",
      "logMessage": "string",
      "modifiedBy": "string",
      "subscription": {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "sfLicenseId": "string",
        "organization": null,
        "sfContractId": "string",
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "sfSubscriptionId": "string",
        "applicationDeployments": []
      },
      "subscriptionId": 0
    }
  ],
  "type": "string",
  "status": "string",
  "created": "string",
  "details": "string",
  "expires": "string",
  "product": {
    "id": 0,
    "url": "string",
    "name": "string",
    "created": "string",
    "isActive": false,
    "metadata": {},
    "modified": "string",
    "createdBy": "string",
    "modifiedBy": "string",
    "displayName": "string",
    "applications": [
      {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      }
    ],
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "aliases": [],
      "contact": "string",
      "created": "string",
      "domains": [],
      "members": [],
      "isActive": false,
      "modified": "string",
      "products": [],
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "crmAccountId": "string",
      "isMfaRequired": false,
      "isSelfService": false,
      "subscriptions": [],
      "technicalContact": "string",
      "isEnabledForPreviewFeatures": false,
      "isDomainVerificationRequired": false
    },
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "sfLicenseId": "string",
        "organization": null,
        "sfContractId": "string",
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "sfSubscriptionId": "string",
        "applicationDeployments": []
      }
    ],
    "organizationId": 0,
    "publicMetadata": {},
    "longDescription": "string"
  },
  "modified": "string",
  "createdBy": "string",
  "isEnabled": false,
  "productId": 0,
  "modifiedBy": "string",
  "statusText": "string",
  "description": "string",
  "sfLicenseId": "string",
  "organization": {
    "id": 0,
    "name": "string",
    "type": "string",
    "aliases": [
      {
        "created": "string",
        "systemId": "string",
        "systemName": "string",
        "organizationId": 0
      }
    ],
    "contact": "string",
    "created": "string",
    "domains": [
      {
        "domain": "string",
        "created": "string",
        "domainId": 0,
        "modified": "string",
        "createdBy": "string",
        "isVerified": false,
        "modifiedBy": "string",
        "organizationId": 0,
        "verificationCode": "string",
        "verificationMethod": "string",
        "ownerOrganizationId": 0,
        "authenticationMethod": "string",
        "verificationCodeExpires": "string"
      }
    ],
    "members": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "isActive": false,
    "modified": "string",
    "products": [
      {
        "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"
      }
    ],
    "createdBy": "string",
    "modifiedBy": "string",
    "displayName": "string",
    "applications": [
      {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      }
    ],
    "crmAccountId": "string",
    "isMfaRequired": false,
    "isSelfService": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "sfLicenseId": "string",
        "organization": null,
        "sfContractId": "string",
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "sfSubscriptionId": "string",
        "applicationDeployments": []
      }
    ],
    "technicalContact": "string",
    "isEnabledForPreviewFeatures": false,
    "isDomainVerificationRequired": false
  },
  "sfContractId": "string",
  "customMetadata": {},
  "organizationId": 0,
  "readonlyMetadata": {},
  "sfSubscriptionId": "string",
  "applicationDeployments": [
    {
      "id": 0,
      "name": "string",
      "steps": [
        {}
      ],
      "status": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "application": {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      },
      "displayName": "string",
      "maxUserCount": 0,
      "subscription": {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "sfLicenseId": "string",
        "organization": null,
        "sfContractId": "string",
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "sfSubscriptionId": "string",
        "applicationDeployments": []
      },
      "applicationId": 0,
      "configuration": "string",
      "customMetadata": {},
      "subscriptionId": 0,
      "deploymentTarget": {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      },
      "readonlyMetadata": {},
      "statusResolution": "string",
      "deploymentTargetId": 0
    }
  ]
}
Schema
Name Type Attributes Description Extensions
applicationDeployments nullable — —
created string (date-time) nullable The date/time the record was created (UTC). —
createdBy string nullable The user or user that created the record. —
customMetadata — JsonObject primitive —
description string nullable Details about the line item —
details string nullable JSON document of the line item details —
expires string (date-time) nullable When specified, the subscription will expire at this date —
id integer (int32) nullable A system assigned unique identifier. —
isEnabled boolean nullable Is the subscription enabled —
logs nullable The list of logs —
modified string (date-time) nullable The date/time the record was last modified (UTC). —
modifiedBy string nullable The user or user that last modified the record. —
organization — Represents an Organization —
organizationId integer (int32) nullable Id of the organization the subscription belongs to —
product — Represents metadata available about a Product. —
productId integer (int32) nullable Id of the product the order belongs to —
readonlyMetadata — JsonObject primitive —
sfContractId string nullable write summary —
sfLicenseId string nullable write summary —
sfSubscriptionId string nullable write summary —
status SubscriptionStatus — Subscription Statuses
Value Description
Active —
Inactive —
—
statusText string nullable Message related to the status —
type string nullable write summary —
Example 
{
  "id": 0,
  "logs": [
    {
      "id": 0,
      "created": "string",
      "modified": "string",
      "severity": "string",
      "createdBy": "string",
      "logMessage": "string",
      "modifiedBy": "string",
      "subscription": {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "sfLicenseId": "string",
        "organization": null,
        "sfContractId": "string",
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "sfSubscriptionId": "string",
        "applicationDeployments": []
      },
      "subscriptionId": 0
    }
  ],
  "type": "string",
  "status": "string",
  "created": "string",
  "details": "string",
  "expires": "string",
  "product": {
    "id": 0,
    "url": "string",
    "name": "string",
    "created": "string",
    "isActive": false,
    "metadata": {},
    "modified": "string",
    "createdBy": "string",
    "modifiedBy": "string",
    "displayName": "string",
    "applications": [
      {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      }
    ],
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "aliases": [],
      "contact": "string",
      "created": "string",
      "domains": [],
      "members": [],
      "isActive": false,
      "modified": "string",
      "products": [],
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "crmAccountId": "string",
      "isMfaRequired": false,
      "isSelfService": false,
      "subscriptions": [],
      "technicalContact": "string",
      "isEnabledForPreviewFeatures": false,
      "isDomainVerificationRequired": false
    },
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "sfLicenseId": "string",
        "organization": null,
        "sfContractId": "string",
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "sfSubscriptionId": "string",
        "applicationDeployments": []
      }
    ],
    "organizationId": 0,
    "publicMetadata": {},
    "longDescription": "string"
  },
  "modified": "string",
  "createdBy": "string",
  "isEnabled": false,
  "productId": 0,
  "modifiedBy": "string",
  "statusText": "string",
  "description": "string",
  "sfLicenseId": "string",
  "organization": {
    "id": 0,
    "name": "string",
    "type": "string",
    "aliases": [
      {
        "created": "string",
        "systemId": "string",
        "systemName": "string",
        "organizationId": 0
      }
    ],
    "contact": "string",
    "created": "string",
    "domains": [
      {
        "domain": "string",
        "created": "string",
        "domainId": 0,
        "modified": "string",
        "createdBy": "string",
        "isVerified": false,
        "modifiedBy": "string",
        "organizationId": 0,
        "verificationCode": "string",
        "verificationMethod": "string",
        "ownerOrganizationId": 0,
        "authenticationMethod": "string",
        "verificationCodeExpires": "string"
      }
    ],
    "members": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "isActive": false,
    "modified": "string",
    "products": [
      {
        "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"
      }
    ],
    "createdBy": "string",
    "modifiedBy": "string",
    "displayName": "string",
    "applications": [
      {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      }
    ],
    "crmAccountId": "string",
    "isMfaRequired": false,
    "isSelfService": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "sfLicenseId": "string",
        "organization": null,
        "sfContractId": "string",
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "sfSubscriptionId": "string",
        "applicationDeployments": []
      }
    ],
    "technicalContact": "string",
    "isEnabledForPreviewFeatures": false,
    "isDomainVerificationRequired": false
  },
  "sfContractId": "string",
  "customMetadata": {},
  "organizationId": 0,
  "readonlyMetadata": {},
  "sfSubscriptionId": "string",
  "applicationDeployments": [
    {
      "id": 0,
      "name": "string",
      "steps": [
        {}
      ],
      "status": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "application": {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      },
      "displayName": "string",
      "maxUserCount": 0,
      "subscription": {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "sfLicenseId": "string",
        "organization": null,
        "sfContractId": "string",
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "sfSubscriptionId": "string",
        "applicationDeployments": []
      },
      "applicationId": 0,
      "configuration": "string",
      "customMetadata": {},
      "subscriptionId": 0,
      "deploymentTarget": {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      },
      "readonlyMetadata": {},
      "statusResolution": "string",
      "deploymentTargetId": 0
    }
  ]
}
Schema
Name Type Attributes Description Extensions
applicationDeployments nullable — —
created string (date-time) nullable The date/time the record was created (UTC). —
createdBy string nullable The user or user that created the record. —
customMetadata — JsonObject primitive —
description string nullable Details about the line item —
details string nullable JSON document of the line item details —
expires string (date-time) nullable When specified, the subscription will expire at this date —
id integer (int32) nullable A system assigned unique identifier. —
isEnabled boolean nullable Is the subscription enabled —
logs nullable The list of logs —
modified string (date-time) nullable The date/time the record was last modified (UTC). —
modifiedBy string nullable The user or user that last modified the record. —
organization — Represents an Organization —
organizationId integer (int32) nullable Id of the organization the subscription belongs to —
product — Represents metadata available about a Product. —
productId integer (int32) nullable Id of the product the order belongs to —
readonlyMetadata — JsonObject primitive —
sfContractId string nullable write summary —
sfLicenseId string nullable write summary —
sfSubscriptionId string nullable write summary —
status SubscriptionStatus — Subscription Statuses
Value Description
Active —
Inactive —
—
statusText string nullable Message related to the status —
type string nullable write summary —
Example 
{
  "id": 0,
  "logs": [
    {
      "id": 0,
      "created": "string",
      "modified": "string",
      "severity": "string",
      "createdBy": "string",
      "logMessage": "string",
      "modifiedBy": "string",
      "subscription": {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "sfLicenseId": "string",
        "organization": null,
        "sfContractId": "string",
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "sfSubscriptionId": "string",
        "applicationDeployments": []
      },
      "subscriptionId": 0
    }
  ],
  "type": "string",
  "status": "string",
  "created": "string",
  "details": "string",
  "expires": "string",
  "product": {
    "id": 0,
    "url": "string",
    "name": "string",
    "created": "string",
    "isActive": false,
    "metadata": {},
    "modified": "string",
    "createdBy": "string",
    "modifiedBy": "string",
    "displayName": "string",
    "applications": [
      {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      }
    ],
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "aliases": [],
      "contact": "string",
      "created": "string",
      "domains": [],
      "members": [],
      "isActive": false,
      "modified": "string",
      "products": [],
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "crmAccountId": "string",
      "isMfaRequired": false,
      "isSelfService": false,
      "subscriptions": [],
      "technicalContact": "string",
      "isEnabledForPreviewFeatures": false,
      "isDomainVerificationRequired": false
    },
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "sfLicenseId": "string",
        "organization": null,
        "sfContractId": "string",
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "sfSubscriptionId": "string",
        "applicationDeployments": []
      }
    ],
    "organizationId": 0,
    "publicMetadata": {},
    "longDescription": "string"
  },
  "modified": "string",
  "createdBy": "string",
  "isEnabled": false,
  "productId": 0,
  "modifiedBy": "string",
  "statusText": "string",
  "description": "string",
  "sfLicenseId": "string",
  "organization": {
    "id": 0,
    "name": "string",
    "type": "string",
    "aliases": [
      {
        "created": "string",
        "systemId": "string",
        "systemName": "string",
        "organizationId": 0
      }
    ],
    "contact": "string",
    "created": "string",
    "domains": [
      {
        "domain": "string",
        "created": "string",
        "domainId": 0,
        "modified": "string",
        "createdBy": "string",
        "isVerified": false,
        "modifiedBy": "string",
        "organizationId": 0,
        "verificationCode": "string",
        "verificationMethod": "string",
        "ownerOrganizationId": 0,
        "authenticationMethod": "string",
        "verificationCodeExpires": "string"
      }
    ],
    "members": [
      {
        "id": "string",
        "user": null,
        "roles": [],
        "userId": "string",
        "created": "string",
        "isGuest": false,
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "isMfaRequired": false,
        "organizationId": 0,
        "organizationName": "string",
        "isMembershipMfaRequired": false,
        "organizationDisplayName": "string"
      }
    ],
    "isActive": false,
    "modified": "string",
    "products": [
      {
        "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"
      }
    ],
    "createdBy": "string",
    "modifiedBy": "string",
    "displayName": "string",
    "applications": [
      {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      }
    ],
    "crmAccountId": "string",
    "isMfaRequired": false,
    "isSelfService": false,
    "subscriptions": [
      {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "sfLicenseId": "string",
        "organization": null,
        "sfContractId": "string",
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "sfSubscriptionId": "string",
        "applicationDeployments": []
      }
    ],
    "technicalContact": "string",
    "isEnabledForPreviewFeatures": false,
    "isDomainVerificationRequired": false
  },
  "sfContractId": "string",
  "customMetadata": {},
  "organizationId": 0,
  "readonlyMetadata": {},
  "sfSubscriptionId": "string",
  "applicationDeployments": [
    {
      "id": 0,
      "name": "string",
      "steps": [
        {}
      ],
      "status": "string",
      "created": "string",
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "application": {
        "id": 0,
        "name": "string",
        "created": "string",
        "product": null,
        "isActive": false,
        "metadata": null,
        "modified": "string",
        "createdBy": "string",
        "productId": 0,
        "modifiedBy": "string",
        "displayName": "string",
        "organization": null,
        "organizationId": 0,
        "publicMetadata": null,
        "deploymentTargets": [],
        "userDefaultIsActive": false
      },
      "displayName": "string",
      "maxUserCount": 0,
      "subscription": {
        "id": 0,
        "logs": [],
        "type": "string",
        "status": null,
        "created": "string",
        "details": "string",
        "expires": "string",
        "product": null,
        "modified": "string",
        "createdBy": "string",
        "isEnabled": false,
        "productId": 0,
        "modifiedBy": "string",
        "statusText": "string",
        "description": "string",
        "sfLicenseId": "string",
        "organization": null,
        "sfContractId": "string",
        "customMetadata": null,
        "organizationId": 0,
        "readonlyMetadata": null,
        "sfSubscriptionId": "string",
        "applicationDeployments": []
      },
      "applicationId": 0,
      "configuration": "string",
      "customMetadata": {},
      "subscriptionId": 0,
      "deploymentTarget": {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      },
      "readonlyMetadata": {},
      "statusResolution": "string",
      "deploymentTargetId": 0
    }
  ]
}
Schema
Name Type Attributes Description Extensions
applicationDeployments nullable — —
created string (date-time) nullable The date/time the record was created (UTC). —
createdBy string nullable The user or user that created the record. —
customMetadata — JsonObject primitive —
description string nullable Details about the line item —
details string nullable JSON document of the line item details —
expires string (date-time) nullable When specified, the subscription will expire at this date —
id integer (int32) nullable A system assigned unique identifier. —
isEnabled boolean nullable Is the subscription enabled —
logs nullable The list of logs —
modified string (date-time) nullable The date/time the record was last modified (UTC). —
modifiedBy string nullable The user or user that last modified the record. —
organization — Represents an Organization —
organizationId integer (int32) nullable Id of the organization the subscription belongs to —
product — Represents metadata available about a Product. —
productId integer (int32) nullable Id of the product the order belongs to —
readonlyMetadata — JsonObject primitive —
sfContractId string nullable write summary —
sfLicenseId string nullable write summary —
sfSubscriptionId string nullable write summary —
status SubscriptionStatus — Subscription Statuses
Value Description
Active —
Inactive —
—
statusText string nullable Message related to the status —
type string nullable write summary —
404
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Example 
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "status": 0,
  "instance": "string"
}
Schema
Name Type Attributes Description Extensions
detail string nullable — —
instance string nullable — —
status integer (int32) nullable — —
title string nullable — —
type string nullable — —
Security

Authentication is required for this operation.

Source: default

Requirements (any one option may satisfy)

  • Bearer and ApplicationToken
  • Basic