An entitlement suspension is a long-running operation.
Possible error codes:
PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Entitlement resource not found.
NOT_ACTIVE: Entitlement is not active.
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/v1alpha1/{name=accounts/*/customers/*/entitlements/*}:suspend
Required. The resource name of the entitlement to suspend. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
Request body
The request body contains data with the following structure:
Optional. An optional identifier in the external system that partners can use to correlate a Channel Services purchase transaction for the entitlement.
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 operation suspends a previously fulfilled entitlement, which is a long-running operation.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request method is \u003ccode\u003ePOST\u003c/code\u003e to the URL \u003ccode\u003ehttps://cloudchannel.googleapis.com/v1alpha1/{name=accounts/*/customers/*/entitlements/*}:suspend\u003c/code\u003e, requiring a resource name in the format of \u003ccode\u003eaccounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body accepts optional fields \u003ccode\u003eexternalCorrelationId\u003c/code\u003e and \u003ccode\u003erequestId\u003c/code\u003e, where \u003ccode\u003erequestId\u003c/code\u003e allows for request idempotency using a valid UUID.\u003c/p\u003e\n"],["\u003cp\u003ePossible errors include \u003ccode\u003ePERMISSION_DENIED\u003c/code\u003e, \u003ccode\u003eINVALID_ARGUMENT\u003c/code\u003e, \u003ccode\u003eNOT_FOUND\u003c/code\u003e, \u003ccode\u003eNOT_ACTIVE\u003c/code\u003e, \u003ccode\u003eINTERNAL\u003c/code\u003e, and \u003ccode\u003eUNKNOWN\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eUpon success the response body returns an \u003ccode\u003eOperation\u003c/code\u003e instance, and requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/apps.order\u003c/code\u003e for authorization.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.customers.entitlements.suspend\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\nSuspends a previously fulfilled entitlement.\n\nAn entitlement suspension is a long-running operation.\n\nPossible error codes:\n\n- PERMISSION_DENIED: The customer doesn't belong to the reseller.\n- INVALID_ARGUMENT: Required request parameters are missing or invalid.\n- NOT_FOUND: Entitlement resource not found.\n- NOT_ACTIVE: Entitlement is not active.\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/v1alpha1/{name=accounts/*/customers/*/entitlements/*}:suspend`\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)."]]
