- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- CreateEntitlementPurchase
- ChangeOfferPurchase
- PurchasableOffer
- Try it!
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
- 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.
HTTP request
GET https://cloudchannel.googleapis.com/v1/{customer=accounts/*/customers/*}:listPurchasableOffers
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
customer
|
Required. The resource name of the customer to list Offers for. Format: accounts/{account_id}/customers/{customer_id}. |
Query 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".
purchase_option
. Defines the intended purchase. purchase_option
can be only one of the following:createEntitlementPurchase
object (
CreateEntitlementPurchase
)
List Offers for CreateEntitlement purchase.
changeOfferPurchase
object (
ChangeOfferPurchase
)
List Offers for ChangeOffer purchase.
Request body
The request body must be empty.
Response body
Response message for customers.listPurchasableOffers.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"purchasableOffers"
:
[
{
object (
|
| Fields | |
|---|---|
purchasableOffers[]
|
The list of Offers requested. |
nextPageToken
|
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 CreateEntitlement purchase.
| JSON representation |
|---|
{ "sku" : string , "billingAccount" : string } |
| Fields | |
|---|---|
sku
|
Required. SKU that the result should be restricted to. Format: products/{productId}/skus/{skuId}. |
billingAccount
|
Optional. Billing account that the result should be restricted to. Format: accounts/{account_id}/billingAccounts/{billing_account_id}. |
ChangeOfferPurchase
List Offers for ChangeOffer purchase.
| JSON representation |
|---|
{ "entitlement" : string , "newSku" : string , "billingAccount" : string } |
| Fields | |
|---|---|
entitlement
|
Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
newSku
|
Optional. Resource name of the new target SKU. Provide this SKU when upgrading or downgrading an entitlement. Format: products/{productId}/skus/{skuId} |
billingAccount
|
Optional. Resource name of the new target Billing Account. Provide this Billing Account when setting up billing for a trial subscription. 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. |
PurchasableOffer
Offer that you can purchase for a customer. This is used in the ListPurchasableOffer API response.
| JSON representation |
|---|
{
"offer"
:
{
object (
|
| Fields | |
|---|---|
offer
|
Offer. |
priceReferenceId
|
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. |
