Sign in
Commerce

Update an entitlement grant

Updates the dates or quantity of a runtime entitlement grant. Use redate with startDate and/or endDate to change the grant term, or increment and decrement with delta to change the granted quantity. Billable grants may return status: queued with an orderIntentId.

post/commerce/entitlements/{entitlementKey}/modify

Request

  • Base URL: https://rest.test.zuora.com
  • URL: https://rest.test.zuora.com/commerce/entitlements/{entitlementKey}/modify
  • 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'redate' | 'increment' | 'decrement' required

Modification to apply to the grant.

Supported values:

  • redate - Changes startDate and/or endDate.
  • increment - Increases the granted quantity by delta.
  • decrement - Decreases the granted quantity by delta.
deltanumber

Quantity to add or subtract. Required when action is increment or decrement.

startDatestring date

New grant start date, in YYYY-MM-DD format. Used when action is redate.

endDatestring date

New grant end date, in YYYY-MM-DD format. Used when action is redate.

Example request

{
  "action": "increment",
  "delta": 100,
  "startDate": "2026-02-01",
  "endDate": "2026-12-31"
}

Response

OK

status'queued' | 'applied'

Result of the modification.

Supported values:

  • queued - The change is queued, typically because it requires an order intent.
  • applied - The change was applied immediately.
entitlementKeystring

Unique key of the runtime entitlement grant.

orderIntentIdstring

Order intent created when status is queued.

Example response

{
  "status": "queued",
  "entitlementKey": "EG-00000001",
  "orderIntentId": "8ad088009840d1c2019855e15c993f2f"
}

Changes

No operation changes recorded.