Get Subscription Summary by ID
Overview
Retrieve a subscription summary, including customer and purchase details, for the authenticated Implementation Partner.
Endpoint
GET /api/integration/partner/subscription/summary
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
| Parameter | Type | Requirement | Description |
|---|---|---|---|
subscriptionId | string | Required | Subscription 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/subscription/summary?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.
{
"id": 29,
"subscriptionId": "IBIS20250131000029",
"description": "Test-subscription-for-auto-renewal - Production",
"status": "Expired",
"createdOn": "2025-01-31T12:45:45.14649",
"lastModifiedOn": "2025-01-31T12:46:02.153696",
"edition": "INTELLIAPPZ",
"appZCustomerId": 1,
"approvalDays": 3,
"expiresOn": "2025-02-03T23:59:59",
"activatedOn": "2025-01-31T12:47:56.368987",
"skuCode": "400010",
"neverExpires": false,
"autoRenewal": false,
"partner": {
"partnerId": 1,
"firstName": "Alex",
"lastName": "Example",
"emailAddress": "partner@example.com",
"phone": "+1-202-555-0100",
"jobTitle": "IntelliAppZ Implementation",
"companyName": "VIT",
"country": "India",
"city": "Bengaluru",
"industry": "Software & IT Services",
"businessRegion": "Western America;#India",
"partnerType": "Implementation Partner",
"status": "Active",
"number": "IBPR20250124000001",
"state": null,
"postalCode": null,
"address": null,
"created": "2025-01-24T13:02:53.665853",
"modified": "2025-01-24T13:13:22.204731",
"createdBy": "Sample User",
"modifiedBy": "Sample User"
},
"appzCustomer": {
"id": 1,
"name": "IAZCustomer",
"address": "123 Example Street",
"email": "partner@example.com",
"telephone": "+1-202-555-0100",
"business": "V IB",
"url": "",
"comments": "",
"state": null,
"country": null,
"city": null,
"postalCode": null,
"created": "2025-01-31T12:26:44.487833",
"modified": "2025-01-31T12:26:44.487833",
"createdBy": "Sample User",
"modifiedBy": "Sample User"
},
"purchases": [
{
"purchaseId": 32,
"number": "IAPO20250131000032",
"status": "Approved",
"description": "Test-subscription-for-auto-renewal - Production",
"type": "New",
"products": [
{
"skuCode": "100024",
"name": "Production_RenewalCheck",
"description": "",
"quantity": 1,
"unitType": "Product",
"executionCount": 20,
"isMeteringEnabled": true,
"intelliAppZId": 6,
"addToRenewal": false,
"services": []
}
]
}
]
}
Response fields
The table describes selected fields in the response. Types reflect the example; this is not an exhaustive schema or nullability contract.
| Field | Example type | Description |
|---|---|---|
subscriptionId | string | Public subscription number. |
status | string | Resource or operation status shown in the example; the complete allowed set is not defined here. |
partner | object | Profile of the authenticated partner. |
appzCustomer | object | Customer associated with the subscription. |
purchases | array | Purchases associated with the subscription. |
Errors
Documented error statuses are listed below. Exact response bodies and validation details are not documented.
| Status | Description |
|---|---|
| 400 | Bad Request – The subscription ID, partner ID or user ID is invalid. |
| 401 | Unauthorized – Authentication is required to access this resource. |
| 403 | Forbidden – The user lacks subscription access or is not authenticated as a partner. |
| 404 | Not Found – No subscription or partner found for the given subscription ID. |
| 500 | Internal Server Error – An unexpected error occurred during request processing. |