Skip to main content
Version: Current

List Licenses by Subscription ID

Overview​

Retrieve licenses for a subscription associated with the authenticated Implementation Partner.

Endpoint​

GET /api/integration/partner/licenses/bysubscription

Use the service origin described in Getting started. The path above already includes /api.

Authentication​

Send the access token obtained from Get Access Token in the Authorization header. Access is limited by the authenticated account’s permissions.

Request headers​

Accept: application/json
Authorization: Bearer ACCESS_TOKEN

Query parameters​

ParameterTypeRequirementDescription
subscriptionIdstringRequiredSubscription number, such as IBIS20250131000029; do not substitute the numeric database id.

Request example​

The following example uses cURL in a POSIX shell. Replace example credentials and IDs before running it.

curl --request GET \
--url 'https://accounts.onintellibuddies.com/api/integration/partner/licenses/bysubscription?subscriptionId=IBIS20250131000029' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN'

Response​

Successful status: 200 OK.

The following is an illustrative response with synthetic contact and credential values. Arrays are shortened to one representative item.

{
"edition": "INTELLIAPPZ",
"partnerId": 1,
"partnerFirstName": "Alex",
"partnerLastName": "Example",
"organizationName": "VIT",
"emailAddress": "partner@example.com",
"daysLeft": 0,
"customerId": 1,
"customerEmail": "partner@example.com",
"customerBusiness": "V IB",
"keyGeneratedAt": "2025-01-31T12:46:02.14787",
"licenseType": "PRODUCTION",
"expiresOn": "2025-02-03T23:59:59",
"licenses": [
{
"licenseId": 427,
"parentLicenseId": null,
"appId": 7,
"isAssigned": true,
"isOnlineActivation": true,
"intelliAppZId": 6,
"activeFrom": "2025-01-31T12:47:56.555149",
"status": "Expired",
"appName": "IntelliAppZ",
"machineName": "example-station",
"activatedBy": "EXAMPLE\\sample-user",
"ipAddress": "192.0.2.10",
"intelliAppZName": "Production_RenewalCheck",
"intelliAppZVersion": "1.0.0",
"created": "2025-01-31T12:46:02.131477",
"modified": "2025-02-04T03:26:12.963498",
"createdBy": "Sample User",
"modifiedBy": "Sample User"
}
]
}

Response fields​

The table describes selected fields in the response. Types reflect the example; this is not an exhaustive schema or nullability contract.

FieldExample typeDescription
partnerIdintegerID of the partner.
licensesarrayLicense records for the subscription.

Errors​

Documented error statuses are listed below. Exact response bodies and validation details are not documented.

StatusDescription
400Bad Request – The subscription ID, partner ID or user ID is invalid.
401Unauthorized – Authentication is required to access this resource.
403Forbidden – The user lacks subscription access or is not authenticated as a partner.
404Not Found – No subscription or partner found for the given subscription ID.
500Internal Server Error – An unexpected error occurred during request processing.