Method: accounts.customers.listPurchasableOffers

Lists the following:

  • Offers that you can purchase for a customer.
  • Offers that you can change for an entitlement.

Possible error codes:

  • PERMISSION_DENIED: The customer doesn't belong to the reseller
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.

HTTP request

GET https://cloudchannel.googleapis.com/v1alpha1/{customer=accounts/*/customers/*}:listPurchasableOffers

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customer

string

Required. The resource name of the customer to list Offers for. Format: accounts/{account_id}/customers/{customer_id}.

Query parameters

Parameters
pageSize

integer

Optional. 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

Optional. A token for a page of results other than the first page.

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".

Union parameter purchase_option. Defines the intended purchase. purchase_option can be only one of the following:
createEntitlementPurchase

object (CreateEntitlementPurchase)

List Offers for entitlements.create purchase.

changeOfferPurchase

object (ChangeOfferPurchase)

List Offers for entitlements.changeOffer purchase.

Request body

The request body must be empty.

Response body

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

Response message for customers.listPurchasableOffers.

JSON representation
{
  "purchasableOffers": [
    {
      object (PurchasableOffer)
    }
  ],
  "nextPageToken": string
}
Fields
purchasableOffers[]

object (PurchasableOffer)

The list of Offers requested.

nextPageToken

string

A token to retrieve the next page of results.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

CreateEntitlementPurchase

List Offers for entitlements.create purchase.

JSON representation
{
  "sku": string
}
Fields
sku

string

Required. SKU that the result should be restricted to. Format: products/{productId}/skus/{skuId}.

ChangeOfferPurchase

List Offers for entitlements.changeOffer purchase.

JSON representation
{
  "entitlement": string,
  "newSku": string
}
Fields
entitlement

string

Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

newSku

string

Optional. Resource name of the new target SKU. Provide this SKU when upgrading or downgrading an entitlement. Format: products/{productId}/skus/{skuId}

PurchasableOffer

Offer that you can purchase for a customer. This is used in the ListPurchasableOffer API response.

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

object (Offer)

Offer.