Method: accounts.listTransferableOffers

List TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request.

Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible error codes:

  • PERMISSION_DENIED:
    • The customer doesn't belong to the reseller and has no auth token.
    • The customer provided incorrect reseller information when generating auth token.
    • The reseller account making the request is different from the reseller account in the query.
    • 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.

Return value: List of TransferableOffer for the given customer and SKU.

HTTP request

POST https://cloudchannel.googleapis.com/v1alpha1/{parent=accounts/*}:listTransferableOffers

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the reseller's account.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "pageSize": integer,
  "pageToken": string,
  "sku": string,
  "languageCode": string,
  "billingAccount": string,

  // Union field transferred_customer_identity can be only one of the following:
  "cloudIdentityId": string,
  "customerName": string
  // End of list of possible types for union field transferred_customer_identity.
}
Fields
pageSize

integer

Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 offers. The maximum value is 1000; the server will coerce values above 1000.
pageToken

string

A token for a page of results other than the first page. Obtained using ListTransferableOffersResponse.next_page_token of the previous CloudChannelService.ListTransferableOffers call.
sku

string

Required. The SKU to look up Offers for.
languageCode

string

Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".
billingAccount

string

Optional. The Billing Account to look up Offers for. Format: accounts/{account_id}/billingAccounts/{billing_account_id}.

This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.
Union field transferred_customer_identity. Specifies the identity of transferred customer. Either a cloud_identity_id of the customer or the customer name is required to look up transferrable Offers. transferred_customer_identity can be only one of the following:
cloudIdentityId

string

Customer's Cloud Identity ID
customerName

string

A reseller should create a customer and use the resource name of that customer here.

Response body

Response message for CloudChannelService.ListTransferableOffers.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "transferableOffers": [
    {
      object (TransferableOffer)
    }
  ],
  "nextPageToken": string
}
Fields
transferableOffers[]

object (TransferableOffer)

Information about Offers for a customer that can be used for transfer.
nextPageToken

string

A token to retrieve the next page of results. Pass to ListTransferableOffersRequest.page_token to obtain that page.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview.

TransferableOffer

TransferableOffer represents an Offer that can be used in Transfer. Read-only.

JSON representation 
{
  "offer": {
    object (Offer)
  },
  "priceReferenceId": string
}
Fields
offer

object (Offer)

Offer with parameter constraints updated to allow the Transfer.
priceReferenceId

string

Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.