--- title: "POST /v1/{+parent}:transferEntitlements" method: POST path: "/v1/{+parent}:transferEntitlements" tags: ["accounts"] --- # POST /v1/{+parent}:transferEntitlements `POST /v1/{+parent}:transferEntitlements` Transfers customer entitlements to new reseller. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: The SKU was already transferred for the customer. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * Specify all transferring entitlements. * 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 GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. ## Path parameters - `parent` string, required ## Request body - GoogleCloudChannelV1TransferEntitlementsRequest — Request message for CloudChannelService.TransferEntitlements. - `entitlements` GoogleCloudChannelV1Entitlement[] — Required. The new entitlements to create or transfer. - `parameters` GoogleCloudChannelV1Parameter[] — Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For Google Cloud billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount. - `name` string — Name of the parameter. - `value` GoogleCloudChannelV1Value — Data type and value of a parameter. - `stringValue` string — Represents a string value. - `doubleValue` number, double — Represents a double value. - `protoValue` object — Represents an 'Any' proto value. - `int64Value` string, int64 — Represents an int64 value. - `boolValue` boolean — Represents a boolean value. - `editable` boolean — Output only. Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active. - `name` string — Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}. - `provisionedService` GoogleCloudChannelV1ProvisionedService — Service provisioned for an entitlement. - `skuId` string — Output only. The SKU pertaining to the provisioning resource as specified in the Offer. - `productId` string — Output only. The product pertaining to the provisioning resource as specified in the Offer. - `provisioningId` string — Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount. - `purchaseOrderId` string — Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. This is only supported for Google Workspace entitlements. - `provisioningState` 'PROVISIONING_STATE_UNSPECIFIED' | 'ACTIVE' | 'SUSPENDED' — Output only. Current provisioning state of the entitlement. - `priceReferenceId` string — Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. - `updateTime` string, google-datetime — Output only. The time at which the entitlement is updated. - `offer` string — Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}. - `suspensionReasons` string[] — Output only. Enumerable of all current suspension reasons for an entitlement. - `associationInfo` GoogleCloudChannelV1AssociationInfo — Association links that an entitlement has to other entitlements. - `baseEntitlement` string — The name of the base entitlement, for which this entitlement is an add-on. - `trialSettings` GoogleCloudChannelV1TrialSettings — Settings for trial offers. - `trial` boolean — Determines if the entitlement is in a trial or not: * `true` - The entitlement is in trial. * `false` - The entitlement is not in trial. - `endTime` string, google-datetime — Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example [Epoch converter](https://www.epochconverter.com). - `commitmentSettings` GoogleCloudChannelV1CommitmentSettings — Commitment settings for commitment-based offers. - `startTime` string, google-datetime — Output only. Commitment start timestamp. - `endTime` string, google-datetime — Output only. Commitment end timestamp. - `renewalSettings` GoogleCloudChannelV1RenewalSettings — Renewal settings for renewable Offers. - `enableRenewal` boolean — If false, the plan will be completed at the end date. - `paymentPlan` 'PAYMENT_PLAN_UNSPECIFIED' | 'COMMITMENT' | 'FLEXIBLE' | 'FREE' | 'TRIAL' | 'OFFLINE' — Describes how a reseller will be billed. - `resizeUnitCount` boolean — If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time. - `paymentCycle` GoogleCloudChannelV1Period — Represents period in days/months/years. - `duration` integer — Total duration of Period Type defined. - `periodType` 'PERIOD_TYPE_UNSPECIFIED' | 'DAY' | 'MONTH' | 'YEAR' — Period Type. - `createTime` string, google-datetime — Output only. The time at which the entitlement is created. - `billingAccount` string — Optional. The billing account resource name that is used to pay for this entitlement. - `authToken` string — The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details. - `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](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`). ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/cloudchannel.md) · [All operations](https://skmtc.net/google/apis/cloudchannel/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/cloudchannel/versions/7477d1d5f236/schema)