You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html
+12-8Lines changed: 12 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -214,6 +214,7 @@ <h3>Method Details</h3>
214
214
The object takes the form of:
215
215
216
216
{ # Request message for CloudChannelService.ChangeOffer.
217
+
"billingAccount": "A String", # Optional. The billing account resource name that is used to pay for this entitlement when setting up billing on a trial subscription. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.
217
218
"offer": "A String", # Required. New Offer. Format: accounts/{account_id}/offers/{offer_id}.
218
219
"parameters": [ # Optional. Parameters needed to purchase the Offer. To view the available Parameters refer to the Offer.parameter_definitions from the desired offer.
219
220
{ # Definition for extended entitlement parameters.
@@ -391,6 +392,7 @@ <h3>Method Details</h3>
391
392
"associationInfo": { # Association links that an entitlement has to other entitlements. # Association information to other entitlements.
392
393
"baseEntitlement": "A String", # The name of the base entitlement, for which this entitlement is an add-on.
393
394
},
395
+
"billingAccount": "A String", # Optional. The billing account resource name that is used to pay for this entitlement.
394
396
"commitmentSettings": { # Commitment settings for commitment-based offers. # Commitment settings for a commitment-based Offer. Required for commitment based offers.
395
397
"endTime": "A String", # Output only. Commitment end timestamp.
396
398
"renewalSettings": { # Renewal settings for renewable Offers. # Optional. Renewal settings applicable for a commitment-based Offer.
@@ -407,7 +409,7 @@ <h3>Method Details</h3>
407
409
"createTime": "A String", # Output only. The time at which the entitlement is created.
408
410
"name": "A String", # Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.
409
411
"offer": "A String", # Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.
410
-
"parameters": [ # 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 GCP billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount.
412
+
"parameters": [ # 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.
411
413
{ # Definition for extended entitlement parameters.
412
414
"editable": True or False, # 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.
413
415
"name": "A String", # Name of the parameter.
@@ -424,7 +426,7 @@ <h3>Method Details</h3>
424
426
],
425
427
"provisionedService": { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement.
426
428
"productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer.
427
-
"provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount."
429
+
"provisioningId": "A 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."
428
430
"skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer.
429
431
},
430
432
"provisioningState": "A String", # Output only. Current provisioning state of the entitlement.
@@ -488,6 +490,7 @@ <h3>Method Details</h3>
488
490
"associationInfo": { # Association links that an entitlement has to other entitlements. # Association information to other entitlements.
489
491
"baseEntitlement": "A String", # The name of the base entitlement, for which this entitlement is an add-on.
490
492
},
493
+
"billingAccount": "A String", # Optional. The billing account resource name that is used to pay for this entitlement.
491
494
"commitmentSettings": { # Commitment settings for commitment-based offers. # Commitment settings for a commitment-based Offer. Required for commitment based offers.
492
495
"endTime": "A String", # Output only. Commitment end timestamp.
493
496
"renewalSettings": { # Renewal settings for renewable Offers. # Optional. Renewal settings applicable for a commitment-based Offer.
@@ -504,7 +507,7 @@ <h3>Method Details</h3>
504
507
"createTime": "A String", # Output only. The time at which the entitlement is created.
505
508
"name": "A String", # Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.
506
509
"offer": "A String", # Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.
507
-
"parameters": [ # 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 GCP billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount.
510
+
"parameters": [ # 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.
508
511
{ # Definition for extended entitlement parameters.
509
512
"editable": True or False, # 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.
510
513
"name": "A String", # Name of the parameter.
@@ -521,7 +524,7 @@ <h3>Method Details</h3>
521
524
],
522
525
"provisionedService": { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement.
523
526
"productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer.
524
-
"provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount."
527
+
"provisioningId": "A 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."
525
528
"skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer.
526
529
},
527
530
"provisioningState": "A String", # Output only. Current provisioning state of the entitlement.
@@ -559,6 +562,7 @@ <h3>Method Details</h3>
559
562
"associationInfo": { # Association links that an entitlement has to other entitlements. # Association information to other entitlements.
560
563
"baseEntitlement": "A String", # The name of the base entitlement, for which this entitlement is an add-on.
561
564
},
565
+
"billingAccount": "A String", # Optional. The billing account resource name that is used to pay for this entitlement.
562
566
"commitmentSettings": { # Commitment settings for commitment-based offers. # Commitment settings for a commitment-based Offer. Required for commitment based offers.
563
567
"endTime": "A String", # Output only. Commitment end timestamp.
564
568
"renewalSettings": { # Renewal settings for renewable Offers. # Optional. Renewal settings applicable for a commitment-based Offer.
@@ -575,7 +579,7 @@ <h3>Method Details</h3>
575
579
"createTime": "A String", # Output only. The time at which the entitlement is created.
576
580
"name": "A String", # Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.
577
581
"offer": "A String", # Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.
578
-
"parameters": [ # 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 GCP billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount.
582
+
"parameters": [ # 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.
579
583
{ # Definition for extended entitlement parameters.
580
584
"editable": True or False, # 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.
581
585
"name": "A String", # Name of the parameter.
@@ -592,7 +596,7 @@ <h3>Method Details</h3>
592
596
],
593
597
"provisionedService": { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement.
594
598
"productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer.
595
-
"provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount."
599
+
"provisioningId": "A 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."
596
600
"skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer.
597
601
},
598
602
"provisioningState": "A String", # Output only. Current provisioning state of the entitlement.
@@ -657,7 +661,7 @@ <h3>Method Details</h3>
657
661
],
658
662
"provisionedService": { # Service provisioned for an entitlement. # Service provisioned for an Entitlement.
659
663
"productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer.
660
-
"provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount."
664
+
"provisioningId": "A 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."
661
665
"skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer.
662
666
},
663
667
"suspensionReason": "A String", # Suspension reason for the Entitlement.
@@ -772,7 +776,7 @@ <h3>Method Details</h3>
772
776
},
773
777
],
774
778
"plan": { # The payment plan for the Offer. Describes how to make a payment. # Describes the payment plan for the Offer.
775
-
"billingAccount": "A String", # Reseller Billing account to charge after an offer transaction. Only present for Google Cloud Platform offers.
779
+
"billingAccount": "A String", # Reseller Billing account to charge after an offer transaction. Only present for Google Cloud offers.
776
780
"paymentCycle": { # Represents period in days/months/years. # Describes how frequently the reseller will be billed, such as once per month.
777
781
"duration": 42, # Total duration of Period Type defined.
778
782
"periodType": "A String", # Period Type.
0 commit comments