Sign in
Commerce

List entitlement audit events

Lists entitlement audit events. Filter results by account, feature, grant, subscription, event type, and date.

get/commerce/entitlements/audit-events

Request

  • Base URL: https://rest.test.zuora.com
  • URL: https://rest.test.zuora.com/commerce/entitlements/audit-events
  • Auth: HTTP bearer

Query parameters

accountIdstring

Account ID used to filter audit events.

accountKeystring

Account number or account ID used to filter audit events.

customerstring

Customer name used to filter audit events.

customerIdstring

Customer ID used to filter audit events.

featureCodestring

Feature code used to filter audit events.

featureKeystring

Feature key used to filter audit events.

occurredFromstring date-time

Return events that occurred at or after this date and time.

occurredTostring date-time

Return events that occurred at or before this date and time.

entitlementKeystring

Unique key of the runtime entitlement grant used to filter audit events.

eventTypestring

Event type used to filter audit events, for example paused or created.

grantIdstring

Grant ID used to filter audit events.

entitlementNumberstring

Entitlement number used to filter audit events.

subscriptionIdstring

Subscription ID used to filter audit events.

subscriptionKeystring

Subscription number or subscription ID used to filter audit events.

sortstring
Example:-occurredAt

Sort order for the results. Prefix a field name with - for descending order. For example, occurredAt or -occurredAt.

limitinteger

Maximum number of audit events returned per page.

pageTokenstring

Token of the page to retrieve. Use the nextPageToken value from the previous response.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

nextPageTokenstring nullable

Token used to retrieve the next page of results. Omitted when there are no more pages.

Example response

{
  "events": [
    {
      "eventId": "8ad088009840d1c2019855e15c993f2f",
      "event_id": "8ad088009840d1c2019855e15c993f2f",
      "eventType": "paused",
      "event_type": "paused",
      "grantId": "EG-00000001",
      "grant_id": "EG-00000001",
      "accountId": "2c92c0f86a7e7a40016a7ec3c1f01c1a",
      "account_id": "2c92c0f86a7e7a40016a7ec3c1f01c1a",
      "featureCode": "api_calls",
      "subscriptionId": "8a8081ae547aac1e01547efb61f20140",
      "occurredAt": "2026-03-15T10:30:00Z",
      "actorKind": "user",
      "actorId": "53c162482f054f3ca08e1ec82dccfec9",
      "updatedOn": "2026-03-15T10:30:00Z",
      "updatedBy": "53c162482f054f3ca08e1ec82dccfec9",
      "updatedByUsername": "admin@example.com"
    }
  ],
  "items": [
    {
      "eventId": "8ad088009840d1c2019855e15c993f2f",
      "event_id": "8ad088009840d1c2019855e15c993f2f",
      "eventType": "paused",
      "event_type": "paused",
      "grantId": "EG-00000001",
      "grant_id": "EG-00000001",
      "accountId": "2c92c0f86a7e7a40016a7ec3c1f01c1a",
      "account_id": "2c92c0f86a7e7a40016a7ec3c1f01c1a",
      "featureCode": "api_calls",
      "subscriptionId": "8a8081ae547aac1e01547efb61f20140",
      "occurredAt": "2026-03-15T10:30:00Z",
      "actorKind": "user",
      "actorId": "53c162482f054f3ca08e1ec82dccfec9",
      "updatedOn": "2026-03-15T10:30:00Z",
      "updatedBy": "53c162482f054f3ca08e1ec82dccfec9",
      "updatedByUsername": "admin@example.com"
    }
  ],
  "nextPageToken": "8ad088009840d1c2019855e15c993f2f"
}

Changes

No operation changes recorded.