TAG LINE
SMALL TITLE

Account / Package

(API Version v2)


This object contains all the information associated with a Package that has been assigned to an Account.


What can you do with AccountPackage?


Properties

Property Details
identity
READ-ONLY
"identity": "Hello World"
Type: String
This is the unique numeric identifier for the AccountPackage
accountId
"accountId": 6
Type: Number
Unique identifier for the associated Account object.
accountName
"accountName": "Sample Name"
Type: String
The name of the object associated with the accountId property.
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
nextBill
READ-ONLY
"nextBill": "2021-04-26T15:25:27.587Z"
Type: Date
The date in which this account will be billed next.

Date and time values are specified in the ISO 8601 format.
name
"name": "Hello World"
Type: String
The name of the Account Package.
lastStatusChanged
"lastStatusChanged": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
effective
"effective": "2021-04-26T15:25:27.587Z"
Type: Date
The start date on when this Account Package is to have its charge calculated.

Date and time values are specified in the ISO 8601 format.
updated
"updated": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
effectiveCancel
"effectiveCancel": "2021-04-26T15:25:27.587Z"
Type: Date
The date in which this Account Package should be cancelled.

Date and time values are specified in the ISO 8601 format.
packageFrequencyId
"packageFrequencyId": 17
Type: Number
Unique identifier for the associated PackageFrequency object.
packageFrequencyName
"packageFrequencyName": "Sample Name"
Type: String
The name of the object associated with the packageFrequencyId property.
termId
"termId": 24
Type: Number
Unique identifier for the associated Term object.
termName
"termName": "Sample Name"
Type: String
The name of the object associated with the termId property.
createdByUserId
READ-ONLY
"createdByUserId": 16
Type: Number
Unique identifier for the associated User object.
createdByUserName
READ-ONLY
"createdByUserName": "Sample Name"
Type: String
The name of the object associated with the createdByUserId property.
billDay
"billDay": 7
Type: Number
If this Account Package is to be billed on a different day than the account's bill day.
updatedByUserId
READ-ONLY
"updatedByUserId": 9
Type: Number
Unique identifier for the associated User object.
updatedByUserName
READ-ONLY
"updatedByUserName": "Sample Name"
Type: String
The name of the object associated with the updatedByUserId property.
usageBillDay
"usageBillDay": 7
Type: Number
If this Account Package is to have it's usage billed on a different day than the account's usage bill day.
activation
"activation": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
finalBill
READ-ONLY
"finalBill": "2021-04-26T15:25:27.587Z"
Type: Date
The date when this Account Package had it's final bill generated. Applies to Account Packages that have been cancelled.

Date and time values are specified in the ISO 8601 format.
lastBilled
READ-ONLY
"lastBilled": "2021-04-26T15:25:27.587Z"
Type: Date
The date when this Account Package was last billed.

Date and time values are specified in the ISO 8601 format.
accountSharePlanId
"accountSharePlanId": 26
Type: Number
Unique identifier for the associated AccountSharePlan object.
accountSharePlanName
"accountSharePlanName": "Sample Name"
Type: String
The name of the object associated with the accountSharePlanId property.
lastUsageBilled
READ-ONLY
"lastUsageBilled": "2021-04-26T15:25:27.587Z"
Type: Date
The date when this Account Package's usage was last billed.

Date and time values are specified in the ISO 8601 format.
accountProductCodeId
"accountProductCodeId": 13
Type: Number
Unique identifier for the associated AccountProductCode object.
accountProductCodeName
"accountProductCodeName": "Sample Name"
Type: String
The name of the object associated with the accountProductCodeId property.
packageCategoryId
"packageCategoryId": 20
Type: Number
Unique identifier for the associated PackageCategory object.
packageCategoryName
"packageCategoryName": "Sample Name"
Type: String
The name of the object associated with the packageCategoryId property.
chargeRecurringIfUsage
READ-ONLY
"chargeRecurringIfUsage": true
Type: Boolean
This is an inherited field from the Package that has been added to the account.
updatedByPortalUserId
READ-ONLY
"updatedByPortalUserId": 6
Type: Number
If this Account Package has been updated by the end customer in the LogiSense customer portal, then this ID represents that User.

Unique identifier for the associated PortalUser object.
updatedByPortalUserName
READ-ONLY
"updatedByPortalUserName": "Sample Name"
Type: String
The name of the object associated with the updatedByPortalUserId property.
id
"id": "Hello World"
Type: String


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • identity
  • accountId
  • name
  • lastStatusChanged
  • effective
  • effectiveCancel
  • packageFrequencyId
  • termId
  • billDay
  • usageBillDay
  • finalBill
  • accountSharePlanId
  • accountProductCodeId
  • packageCategoryId
  • chargeRecurringIfUsage
  • updatedByPortalUserId

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the AccountPackage object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v2/Account/Package/{id}
Delete an instance of the AccountPackage object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the AccountPackage object.
Delete an instance of the AccountPackage object.
DELETE api/v2/Account/Package/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "accountPackage"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v2/Account/Package/
Retrieve all of the AccountPackage objects.
Retrieve all of the AccountPackage objects.
GET api/v2/Account/Package/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountId": 4,
            "accountName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "nextBill": "2021-04-26T15:25:27.587Z",
            "name": "Sample Text Data",
            "lastStatusChanged": "2021-04-26T15:25:27.587Z",
            "effective": "2021-04-26T15:25:27.587Z",
            "updated": "2021-04-26T15:25:27.587Z",
            "effectiveCancel": "2021-04-26T15:25:27.587Z",
            "packageFrequencyId": 13,
            "packageFrequencyName": "Sample Text Data",
            "termId": 9,
            "termName": "Sample Text Data",
            "createdByUserId": 1,
            "createdByUserName": "Sample Text Data",
            "billDay": 7,
            "updatedByUserId": 25,
            "updatedByUserName": "Sample Text Data",
            "usageBillDay": 7,
            "activation": "2021-04-26T15:25:27.587Z",
            "finalBill": "2021-04-26T15:25:27.587Z",
            "lastBilled": "2021-04-26T15:25:27.587Z",
            "accountSharePlanId": 1,
            "accountSharePlanName": "Sample Text Data",
            "lastUsageBilled": "2021-04-26T15:25:27.587Z",
            "accountProductCodeId": 26,
            "accountProductCodeName": "Sample Text Data",
            "packageCategoryId": 2,
            "packageCategoryName": "Sample Text Data",
            "chargeRecurringIfUsage": true,
            "updatedByPortalUserId": 27,
            "updatedByPortalUserName": "Sample Text Data",
            "id": "Sample Text Data"
        }
    ]
}
GETapi/v2/Account/Package/Paged
Retrieve all of the AccountPackage objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the AccountPackage objects in a paged fashion.
GET api/v2/Account/Package/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountId": 27,
                "accountName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "nextBill": "2021-04-26T15:25:27.587Z",
                "name": "Sample Text Data",
                "lastStatusChanged": "2021-04-26T15:25:27.587Z",
                "effective": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z",
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "packageFrequencyId": 21,
                "packageFrequencyName": "Sample Text Data",
                "termId": 1,
                "termName": "Sample Text Data",
                "createdByUserId": 6,
                "createdByUserName": "Sample Text Data",
                "billDay": 7,
                "updatedByUserId": 21,
                "updatedByUserName": "Sample Text Data",
                "usageBillDay": 7,
                "activation": "2021-04-26T15:25:27.587Z",
                "finalBill": "2021-04-26T15:25:27.587Z",
                "lastBilled": "2021-04-26T15:25:27.587Z",
                "accountSharePlanId": 26,
                "accountSharePlanName": "Sample Text Data",
                "lastUsageBilled": "2021-04-26T15:25:27.587Z",
                "accountProductCodeId": 5,
                "accountProductCodeName": "Sample Text Data",
                "packageCategoryId": 3,
                "packageCategoryName": "Sample Text Data",
                "chargeRecurringIfUsage": true,
                "updatedByPortalUserId": 19,
                "updatedByPortalUserName": "Sample Text Data",
                "id": "Sample Text Data"
            }
        ]
    }
}
GETapi/v2/Account/Package/Paged/Detail
Retrieve all of the AccountPackage objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the AccountPackage objects in a paged fashion with all object details.
GET api/v2/Account/Package/Paged/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountId": 8,
                "accountName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "nextBill": "2021-04-26T15:25:27.587Z",
                "name": "Sample Text Data",
                "lastStatusChanged": "2021-04-26T15:25:27.587Z",
                "effective": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z",
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "packageFrequencyId": 9,
                "packageFrequencyName": "Sample Text Data",
                "termId": 23,
                "termName": "Sample Text Data",
                "createdByUserId": 0,
                "createdByUserName": "Sample Text Data",
                "billDay": 7,
                "updatedByUserId": 23,
                "updatedByUserName": "Sample Text Data",
                "usageBillDay": 7,
                "activation": "2021-04-26T15:25:27.587Z",
                "finalBill": "2021-04-26T15:25:27.587Z",
                "lastBilled": "2021-04-26T15:25:27.587Z",
                "accountSharePlanId": 25,
                "accountSharePlanName": "Sample Text Data",
                "lastUsageBilled": "2021-04-26T15:25:27.587Z",
                "accountProductCodeId": 8,
                "accountProductCodeName": "Sample Text Data",
                "packageCategoryId": 3,
                "packageCategoryName": "Sample Text Data",
                "chargeRecurringIfUsage": true,
                "updatedByPortalUserId": 26,
                "updatedByPortalUserName": "Sample Text Data",
                "id": "Sample Text Data",
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v2/Account/Package/{id}
Retrieve an instance of the AccountPackage object by its ID.
{id}Unique identifier for the AccountPackage object.
Retrieve an instance of the AccountPackage object by its ID.
GET api/v2/Account/Package/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountId": 21,
        "accountName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "nextBill": "2021-04-26T15:25:27.587Z",
        "name": "Sample Text Data",
        "lastStatusChanged": "2021-04-26T15:25:27.587Z",
        "effective": "2021-04-26T15:25:27.587Z",
        "updated": "2021-04-26T15:25:27.587Z",
        "effectiveCancel": "2021-04-26T15:25:27.587Z",
        "packageFrequencyId": 22,
        "packageFrequencyName": "Sample Text Data",
        "termId": 17,
        "termName": "Sample Text Data",
        "createdByUserId": 8,
        "createdByUserName": "Sample Text Data",
        "billDay": 7,
        "updatedByUserId": 20,
        "updatedByUserName": "Sample Text Data",
        "usageBillDay": 7,
        "activation": "2021-04-26T15:25:27.587Z",
        "finalBill": "2021-04-26T15:25:27.587Z",
        "lastBilled": "2021-04-26T15:25:27.587Z",
        "accountSharePlanId": 16,
        "accountSharePlanName": "Sample Text Data",
        "lastUsageBilled": "2021-04-26T15:25:27.587Z",
        "accountProductCodeId": 7,
        "accountProductCodeName": "Sample Text Data",
        "packageCategoryId": 1,
        "packageCategoryName": "Sample Text Data",
        "chargeRecurringIfUsage": true,
        "updatedByPortalUserId": 18,
        "updatedByPortalUserName": "Sample Text Data",
        "id": "Sample Text Data"
    }
}
GETapi/v2/Account/Package/{id}/Detail
Retrieve deep detail of the AccountPackage object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the AccountPackage object.
Retrieve deep detail of the AccountPackage object by its ID.
GET api/v2/Account/Package/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountId": 13,
        "accountName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "nextBill": "2021-04-26T15:25:27.587Z",
        "name": "Sample Text Data",
        "lastStatusChanged": "2021-04-26T15:25:27.587Z",
        "effective": "2021-04-26T15:25:27.587Z",
        "updated": "2021-04-26T15:25:27.587Z",
        "effectiveCancel": "2021-04-26T15:25:27.587Z",
        "packageFrequencyId": 0,
        "packageFrequencyName": "Sample Text Data",
        "termId": 25,
        "termName": "Sample Text Data",
        "createdByUserId": 21,
        "createdByUserName": "Sample Text Data",
        "billDay": 7,
        "updatedByUserId": 17,
        "updatedByUserName": "Sample Text Data",
        "usageBillDay": 7,
        "activation": "2021-04-26T15:25:27.587Z",
        "finalBill": "2021-04-26T15:25:27.587Z",
        "lastBilled": "2021-04-26T15:25:27.587Z",
        "accountSharePlanId": 0,
        "accountSharePlanName": "Sample Text Data",
        "lastUsageBilled": "2021-04-26T15:25:27.587Z",
        "accountProductCodeId": 25,
        "accountProductCodeName": "Sample Text Data",
        "packageCategoryId": 8,
        "packageCategoryName": "Sample Text Data",
        "chargeRecurringIfUsage": true,
        "updatedByPortalUserId": 5,
        "updatedByPortalUserName": "Sample Text Data",
        "id": "Sample Text Data",
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHapi/v2/Account/Package/{id}
Update or Add the AccountPackage object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the AccountPackage object.
Update or Add the AccountPackage object and optionally make changes to any child objects.
PATCH api/v2/Account/Package/{id}

{
    "details": {},
    "accountPackages": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "accountId": 12,
                "name": "Sample Text Data",
                "lastStatusChanged": "2021-04-26T15:25:27.587Z",
                "effective": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z",
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "packageFrequencyId": 26,
                "termId": 15,
                "billDay": 7,
                "usageBillDay": 7,
                "activation": "2021-04-26T15:25:27.587Z",
                "accountSharePlanId": 24,
                "accountProductCodeId": 1,
                "packageCategoryId": 8,
                "id": "Sample Text Data"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "accountPackage",
                "instance": {
                    "identity": 1,
                    "accountId": 5,
                    "accountName": "Sample Text Data",
                    "created": "2021-04-26T15:25:27.587Z",
                    "nextBill": "2021-04-26T15:25:27.587Z",
                    "name": "Sample Text Data",
                    "lastStatusChanged": "2021-04-26T15:25:27.587Z",
                    "effective": "2021-04-26T15:25:27.587Z",
                    "updated": "2021-04-26T15:25:27.587Z",
                    "effectiveCancel": "2021-04-26T15:25:27.587Z",
                    "packageFrequencyId": 4,
                    "packageFrequencyName": "Sample Text Data",
                    "termId": 24,
                    "termName": "Sample Text Data",
                    "createdByUserId": 2,
                    "createdByUserName": "Sample Text Data",
                    "billDay": 7,
                    "updatedByUserId": 20,
                    "updatedByUserName": "Sample Text Data",
                    "usageBillDay": 7,
                    "activation": "2021-04-26T15:25:27.587Z",
                    "finalBill": "2021-04-26T15:25:27.587Z",
                    "lastBilled": "2021-04-26T15:25:27.587Z",
                    "accountSharePlanId": 12,
                    "accountSharePlanName": "Sample Text Data",
                    "lastUsageBilled": "2021-04-26T15:25:27.587Z",
                    "accountProductCodeId": 13,
                    "accountProductCodeName": "Sample Text Data",
                    "packageCategoryId": 1,
                    "packageCategoryName": "Sample Text Data",
                    "chargeRecurringIfUsage": true,
                    "updatedByPortalUserId": 19,
                    "updatedByPortalUserName": "Sample Text Data",
                    "id": "Sample Text Data"
                }
            }
        ]
    }
}
POSTapi/v2/Account/Package/
Create a new instance of the AccountPackage object.
Create a new instance of the AccountPackage object.
POST api/v2/Account/Package/

{
    "accountId": 14,
    "name": "Sample Text Data",
    "lastStatusChanged": "2021-04-26T15:25:27.587Z",
    "effective": "2021-04-26T15:25:27.587Z",
    "updated": "2021-04-26T15:25:27.587Z",
    "effectiveCancel": "2021-04-26T15:25:27.587Z",
    "packageFrequencyId": 3,
    "termId": 24,
    "billDay": 7,
    "usageBillDay": 7,
    "activation": "2021-04-26T15:25:27.587Z",
    "accountSharePlanId": 15,
    "accountProductCodeId": 25,
    "packageCategoryId": 11,
    "id": "Sample Text Data"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountId": 23,
                "accountName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "nextBill": "2021-04-26T15:25:27.587Z",
                "name": "Sample Text Data",
                "lastStatusChanged": "2021-04-26T15:25:27.587Z",
                "effective": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z",
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "packageFrequencyId": 20,
                "packageFrequencyName": "Sample Text Data",
                "termId": 21,
                "termName": "Sample Text Data",
                "createdByUserId": 9,
                "createdByUserName": "Sample Text Data",
                "billDay": 7,
                "updatedByUserId": 27,
                "updatedByUserName": "Sample Text Data",
                "usageBillDay": 7,
                "activation": "2021-04-26T15:25:27.587Z",
                "finalBill": "2021-04-26T15:25:27.587Z",
                "lastBilled": "2021-04-26T15:25:27.587Z",
                "accountSharePlanId": 21,
                "accountSharePlanName": "Sample Text Data",
                "lastUsageBilled": "2021-04-26T15:25:27.587Z",
                "accountProductCodeId": 0,
                "accountProductCodeName": "Sample Text Data",
                "packageCategoryId": 15,
                "packageCategoryName": "Sample Text Data",
                "chargeRecurringIfUsage": true,
                "updatedByPortalUserId": 10,
                "updatedByPortalUserName": "Sample Text Data",
                "id": "Sample Text Data"
            }
        ]
    }
}
POSTapi/v2/Account/Package/FromCatalog
Adds an AccountPackage to the Account and inherits all of the Package properties from the product catalog.
PUTapi/v2/Account/Package/{id}
Update an existing instance of the AccountPackage object.
Update an existing instance of the AccountPackage object.
PUT api/v2/Account/Package/{id}

{
    "identity": 1,
    "accountId": 0,
    "name": "Sample Text Data",
    "lastStatusChanged": "2021-04-26T15:25:27.587Z",
    "effective": "2021-04-26T15:25:27.587Z",
    "updated": "2021-04-26T15:25:27.587Z",
    "effectiveCancel": "2021-04-26T15:25:27.587Z",
    "packageFrequencyId": 16,
    "termId": 21,
    "billDay": 7,
    "usageBillDay": 7,
    "activation": "2021-04-26T15:25:27.587Z",
    "accountSharePlanId": 20,
    "accountProductCodeId": 15,
    "packageCategoryId": 3,
    "id": "Sample Text Data"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountId": 20,
                "accountName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "nextBill": "2021-04-26T15:25:27.587Z",
                "name": "Sample Text Data",
                "lastStatusChanged": "2021-04-26T15:25:27.587Z",
                "effective": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z",
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "packageFrequencyId": 7,
                "packageFrequencyName": "Sample Text Data",
                "termId": 25,
                "termName": "Sample Text Data",
                "createdByUserId": 7,
                "createdByUserName": "Sample Text Data",
                "billDay": 7,
                "updatedByUserId": 2,
                "updatedByUserName": "Sample Text Data",
                "usageBillDay": 7,
                "activation": "2021-04-26T15:25:27.587Z",
                "finalBill": "2021-04-26T15:25:27.587Z",
                "lastBilled": "2021-04-26T15:25:27.587Z",
                "accountSharePlanId": 0,
                "accountSharePlanName": "Sample Text Data",
                "lastUsageBilled": "2021-04-26T15:25:27.587Z",
                "accountProductCodeId": 18,
                "accountProductCodeName": "Sample Text Data",
                "packageCategoryId": 17,
                "packageCategoryName": "Sample Text Data",
                "chargeRecurringIfUsage": true,
                "updatedByPortalUserId": 13,
                "updatedByPortalUserName": "Sample Text Data",
                "id": "Sample Text Data"
            }
        ]
    }
}