Sign in
Commerce

Update entitlement grant state

Updates the state of a runtime entitlement grant. Supported action values are pause, resume, activate, deactivate, and revoke.

post/commerce/entitlements/{entitlementKey}/state

Request

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

Path parameters

entitlementKeystring required

Unique key of the runtime entitlement grant.

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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-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-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-Versionstring

The minor API version.

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

Request body

action'pause' | 'resume' | 'activate' | 'deactivate' | 'revoke' required

State change to apply to the grant.

Supported values:

  • pause - Pauses an active grant.
  • resume - Resumes a paused grant.
  • activate - Activates a pending grant.
  • deactivate - Deactivates an active grant.
  • revoke - Revokes the grant. Include revokedDate when applicable.
reasonstring

Reason for the state change.

revokedDatestring date

Date the grant is revoked, in YYYY-MM-DD format. Required when action is revoke.

orderNumberstring

Order number associated with this state change, when applicable.

orderActionNumberstring

Order action number associated with this state change, when applicable.

Example request

{
  "action": "pause",
  "reason": "Customer requested pause",
  "revokedDate": "2026-06-01",
  "orderNumber": "O-00000002",
  "orderActionNumber": "OA-00000002"
}

Response

OK

entitlementKeystring

Unique key of the runtime entitlement grant.

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

State of the grant after the action is applied.

actionstring

State-change action that was applied.

isRevokedboolean

Indicates whether the grant is revoked after the action.

Example response

{
  "entitlementKey": "EG-00000001",
  "newState": "paused",
  "action": "pause"
}

Changes

No operation changes recorded.