Sign in
Commerce

Retrieve an entitlement grant

Retrieves one runtime entitlement grant by its entitlement key.

get/commerce/entitlements/grants/{entitlementKey}

Request

  • Base URL: https://rest.test.zuora.com
  • URL: https://rest.test.zuora.com/commerce/entitlements/grants/{entitlementKey}
  • Auth: HTTP bearer

Path parameters

entitlementKeystring required

Unique key of the runtime entitlement grant.

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

idstring

Unique identifier of the runtime entitlement grant.

entitlementKeystring

Unique key of the runtime entitlement grant.

entitlement_keystring

Snake-case form of entitlementKey.

entitlementNumberstring

System-generated number that uniquely identifies the grant.

accountKeystring

Account number or account ID that owns the grant.

subscriptionKeystring nullable

Subscription number or subscription ID associated with the grant.

planKeystring nullable

Product rate plan ID or product rate plan number associated with the grant, for example PRP-00000001.

plan_keystring nullable

Snake-case form of planKey.

featureKeystring

Unique key of the granted catalog feature.

featureCodestring

Feature code of the granted catalog feature.

quantitynumber nullable

Granted quantity for a numbered feature.

startDatestring date

Date the grant became effective, in YYYY-MM-DD format.

endDatestring date nullable

Date the grant ends, in YYYY-MM-DD format.

revokedDatestring date nullable

Date the grant was revoked, in YYYY-MM-DD format.

state'pending' | 'active' | 'paused' | 'inactive' | 'expired' | 'revoked'

Current state of the grant.

Supported values:

  • pending - The grant requires activation or has a future start date.
  • active - The grant is in effect.
  • paused - The grant is temporarily paused.
  • inactive - The grant is deactivated.
  • expired - The grant end date has passed.
  • revoked - The grant is revoked.
unitstring nullable

Unit of measure for a numbered feature grant.

isDisabledboolean

Indicates whether the grant is disabled.

Example response

{
  "id": "8ad088009840d1c2019855e15c993f2f",
  "entitlementKey": "EG-00000001",
  "entitlement_key": "EG-00000001",
  "entitlementNumber": "EG-00000001",
  "accountKey": "A00000001",
  "subscriptionKey": "A-S00000001",
  "planKey": "PRP-00000001",
  "plan_key": "PRP-00000001",
  "featureKey": "api_calls",
  "featureCode": "api_calls",
  "quantity": 10000,
  "startDate": "2026-01-01",
  "endDate": "2026-12-31",
  "revokedDate": "2026-06-01",
  "state": "active",
  "unit": "API Calls"
}

Changes

No operation changes recorded.