Sign in
Commerce

Create entitlement grants in bulk

Creates runtime entitlement grants for multiple accounts or subscriptions in a single call. Each item uses the same shape as POST /commerce/entitlements/grant, but this operation reports each item's outcome independently instead of failing the whole batch on the first bad item.

Use skipExisting to make batch re-submission idempotent, and continueOnError to keep processing remaining items after a failure. The request is rejected if grantEntitlementRequest is empty or contains more than 500 items.

Processing is synchronous and not transactional across items. Each item's rows are written independently, so a partially applied item is safe to resubmit when skipExisting is true.

post/commerce/entitlements/bulk-grant

Request

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

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

skipExistingboolean

When true, if a grant for the same account/feature (or account/subscription/feature for subscription-scoped grants) already exists, mark that item as bulk_item_skipped instead of returning an error. This makes batch re-submission idempotent.

The default is true.

continueOnErrorboolean

When true, continue processing remaining items after one fails. When false, items after the first failure are omitted from results.

The default is true.

Example request

{
  "grantEntitlementRequest": [
    {
      "accountKey": "A00000001",
      "subscriptionKey": "A-S00000001",
      "planKey": "PRP-00000001",
      "startDate": "2026-01-01",
      "endDate": "2026-12-31",
      "featureEntitlementPolicy": [
        {
          "featureKey": "api_calls",
          "quantity": 10000
        }
      ],
      "overagePolicy": {
        "onBalanceExhaust": "hard_block"
      },
      "number": "EG-00000001",
      "orderNumber": "O-00000001",
      "orderActionNumber": "OA-00000001",
      "unit": "API Calls"
    }
  ],
  "skipExisting": true,
  "continueOnError": true
}

Response

OK

requestedinteger

Number of items submitted in grantEntitlementRequest.

succeededinteger

Number of items with status bulk_item_succeeded.

skippedinteger

Number of items with status bulk_item_skipped.

failedinteger

Number of items with status bulk_item_failed.

entitlementsGrantedinteger

Total number of entitlement grants created across all succeeded items.

Example response

{
  "requested": 1,
  "succeeded": 1,
  "entitlementsGranted": 1,
  "results": [
    {
      "accountKey": "A00000001",
      "subscriptionKey": "A-S00000001",
      "planKey": "38660706ef2f48cfb5222f7dde491895",
      "status": "bulk_item_succeeded",
      "entitlement": [
        {
          "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"
        }
      ],
      "skippedEntitlement": [
        {
          "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"
        }
      ],
      "error": {
        "type": "not_found",
        "errors": [
          {
            "code": "resource_not_found",
            "message": "Entitlement with key 'ent_bad_key' was not found",
            "locale": "en-US",
            "localizedMessage": "Entitlement with key 'ent_bad_key' was not found",
            "parameter": "entitlementKey"
          }
        ]
      }
    }
  ]
}

Changes

No operation changes recorded.