Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method.
An entitlement activation is a long-running operation and it updates the state of the customer entitlement.
Possible error codes:
PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Entitlement resource not found.
SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS.
NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the operations.get method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.
HTTP request
POST https://cloudchannel.googleapis.com/v1/{name=accounts/*/customers/*/entitlements/*}:activate
Required. The resource name of the entitlement to activate. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
Request body
The request body contains data with the following structure:
JSON representation
{"requestId": string}
Fields
requestId
string
Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete.
For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Response body
If successful, the response body contains an instance of Operation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-19 UTC."],[[["\u003cp\u003eThis API method activates a previously suspended entitlement, excluding those suspended for pending Terms of Service (ToS) acceptance.\u003c/p\u003e\n"],["\u003cp\u003eActivating an entitlement is a long-running operation that will update the customer entitlement's state and return the ID of the operation.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request utilizes a \u003ccode\u003ePOST\u003c/code\u003e method to a specific endpoint, requiring the entitlement's resource name formatted as \u003ccode\u003eaccounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body can optionally include a unique \u003ccode\u003erequestId\u003c/code\u003e to ensure idempotent retries, preventing duplicate actions.\u003c/p\u003e\n"],["\u003cp\u003eThe API call requires the \u003ccode\u003ehttps://www.googleapis.com/auth/apps.order\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.customers.entitlements.activate\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nActivates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method.\n\nAn entitlement activation is a long-running operation and it updates the state of the customer entitlement.\n\nPossible error codes:\n\n- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.\n- INVALID_ARGUMENT: Required request parameters are missing or invalid.\n- NOT_FOUND: Entitlement resource not found.\n- SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS.\n- NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state.\n- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.\n- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.\n\nReturn value: The ID of a long-running operation.\n\nTo get the results of the operation, call the operations.get method of CloudChannelOperationsService. The Operation metadata will contain an instance of `OperationMetadata`.\n\n### HTTP request\n\n`POST https://cloudchannel.googleapis.com/v1/{name=accounts/*/customers/*/entitlements/*}:activate`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/channel/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/apps.order`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]