Sign in
Orders

Rescan a commitment's account associations

Re-evaluates a commitment's account eligibility condition against current account data and activates (inserts or reactivates) any newly-eligible accounts.

This operation is additive only: it never deactivates an account, even one that no longer satisfies the eligibility condition. It never evaluates, activates, or deactivates any associated charge/item — only account associations are affected. Running this operation twice in a row with no intervening data change performs no write on the second call.

Ensure that the the Commitment Management feature is enabled.

post/v1/orders/commitments/{commitmentNumber}/associations/rescan

Request

  • Base URL: https://rest.test.zuora.com
  • URL: https://rest.test.zuora.com/v1/orders/commitments/{commitmentNumber}/associations/rescan
  • Auth: HTTP bearer

Path parameters

commitmentNumberstring string required

The commitment number to rescan.

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.

Authorizationstring

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

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

The minor API version.

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

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.

Response

OK

processIdstring

The ID of the process that handles the operation.

requestIdstring uuid

Unique identifier of the request.

successboolean

Indicates whether the call succeeded.

commitmentNumberstring

The commitment number that was rescanned.

accountsActivatedinteger

The number of accounts newly activated (inserted or reactivated) by this rescan.

accountsUnchangedinteger

The number of accounts that were already active and eligible, left untouched.

activatedAccountNumbersstring[]

Account numbers activated by this rescan.

Changes

No operation changes recorded.