Used by partners to entitle a previously provisioned subscription to the current end user. The end user identity is inferred from the authorized credential of the request. This API must be authorized by the end user using OAuth.
extend(name, body=None, x__xgafv=None)
Used by partners to extend a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts.
+[Deprecated] New partners should be on auto-extend by default. Used by partners to extend a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts.
Used by partners to get a subscription by id. It should be called directly by the partner using service accounts.
@@ -131,7 +131,7 @@extend(name, body=None, x__xgafv=None)
- Used by partners to extend a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts.
+ [Deprecated] New partners should be on auto-extend by default. Used by partners to extend a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts.
Args:
name: string, Required. The name of the subscription resource to be extended. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}". (required)
@@ -597,7 +657,7 @@ Method Details
"endUserEntitled": True or False, # Output only. Indicates if the subscription is entitled to the end user.
"freeTrialEndTime": "A String", # Output only. End of the free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified.
"lineItems": [ # Required. The line items of the subscription.
- { # Individual line item definition of a subscription. Next id: 9
+ { # Individual line item definition of a subscription.
"description": "A String", # Output only. Description of this line item.
"lineItemFreeTrialEndTime": "A String", # Output only. It is set only if the line item has its own free trial applied. End time of the line item free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified.
"lineItemPromotionSpecs": [ # Optional. The promotions applied on the line item. It can be: - a free trial promotion, which overrides the subscription-level free trial promotion. - an introductory pricing promotion. When used as input in Create or Provision API, specify its resource name only.
@@ -630,6 +690,21 @@ Method Details
},
},
"product": "A String", # Required. Product resource name that identifies one the line item The format is 'partners/{partner_id}/products/{product_id}'.
+ "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item.
+ "googleOnePayload": { # Payload specific to Google One products. # Payload specific to Google One products.
+ "campaigns": [ # Campaign attributed to sales of this subscription.
+ "A String",
+ ],
+ "offering": "A String", # The type of offering the subscription was sold by the partner. e.g. VAS.
+ "salesChannel": "A String", # The type of sales channel through which the subscription was sold.
+ "storeId": "A String", # The identifier for the partner store where the subscription was sold.
+ },
+ "youtubePayload": { # Payload specific to Youtube products. # Payload specific to Youtube products.
+ "partnerEligibilityIds": [ # The list of eligibility_ids which are applicable for the line item.
+ "A String",
+ ],
+ },
+ },
"recurrenceType": "A String", # Output only. The recurrence type of the line item.
"state": "A String", # Output only. The state of the line item.
},
@@ -699,7 +774,7 @@ Method Details
"endUserEntitled": True or False, # Output only. Indicates if the subscription is entitled to the end user.
"freeTrialEndTime": "A String", # Output only. End of the free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified.
"lineItems": [ # Required. The line items of the subscription.
- { # Individual line item definition of a subscription. Next id: 9
+ { # Individual line item definition of a subscription.
"description": "A String", # Output only. Description of this line item.
"lineItemFreeTrialEndTime": "A String", # Output only. It is set only if the line item has its own free trial applied. End time of the line item free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified.
"lineItemPromotionSpecs": [ # Optional. The promotions applied on the line item. It can be: - a free trial promotion, which overrides the subscription-level free trial promotion. - an introductory pricing promotion. When used as input in Create or Provision API, specify its resource name only.
@@ -732,6 +807,21 @@ Method Details
},
},
"product": "A String", # Required. Product resource name that identifies one the line item The format is 'partners/{partner_id}/products/{product_id}'.
+ "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item.
+ "googleOnePayload": { # Payload specific to Google One products. # Payload specific to Google One products.
+ "campaigns": [ # Campaign attributed to sales of this subscription.
+ "A String",
+ ],
+ "offering": "A String", # The type of offering the subscription was sold by the partner. e.g. VAS.
+ "salesChannel": "A String", # The type of sales channel through which the subscription was sold.
+ "storeId": "A String", # The identifier for the partner store where the subscription was sold.
+ },
+ "youtubePayload": { # Payload specific to Youtube products. # Payload specific to Youtube products.
+ "partnerEligibilityIds": [ # The list of eligibility_ids which are applicable for the line item.
+ "A String",
+ ],
+ },
+ },
"recurrenceType": "A String", # Output only. The recurrence type of the line item.
"state": "A String", # Output only. The state of the line item.
},
@@ -800,7 +890,7 @@ Method Details
"endUserEntitled": True or False, # Output only. Indicates if the subscription is entitled to the end user.
"freeTrialEndTime": "A String", # Output only. End of the free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified.
"lineItems": [ # Required. The line items of the subscription.
- { # Individual line item definition of a subscription. Next id: 9
+ { # Individual line item definition of a subscription.
"description": "A String", # Output only. Description of this line item.
"lineItemFreeTrialEndTime": "A String", # Output only. It is set only if the line item has its own free trial applied. End time of the line item free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified.
"lineItemPromotionSpecs": [ # Optional. The promotions applied on the line item. It can be: - a free trial promotion, which overrides the subscription-level free trial promotion. - an introductory pricing promotion. When used as input in Create or Provision API, specify its resource name only.
@@ -833,6 +923,21 @@ Method Details
},
},
"product": "A String", # Required. Product resource name that identifies one the line item The format is 'partners/{partner_id}/products/{product_id}'.
+ "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item.
+ "googleOnePayload": { # Payload specific to Google One products. # Payload specific to Google One products.
+ "campaigns": [ # Campaign attributed to sales of this subscription.
+ "A String",
+ ],
+ "offering": "A String", # The type of offering the subscription was sold by the partner. e.g. VAS.
+ "salesChannel": "A String", # The type of sales channel through which the subscription was sold.
+ "storeId": "A String", # The identifier for the partner store where the subscription was sold.
+ },
+ "youtubePayload": { # Payload specific to Youtube products. # Payload specific to Youtube products.
+ "partnerEligibilityIds": [ # The list of eligibility_ids which are applicable for the line item.
+ "A String",
+ ],
+ },
+ },
"recurrenceType": "A String", # Output only. The recurrence type of the line item.
"state": "A String", # Output only. The state of the line item.
},
@@ -914,7 +1019,7 @@ Method Details
"endUserEntitled": True or False, # Output only. Indicates if the subscription is entitled to the end user.
"freeTrialEndTime": "A String", # Output only. End of the free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified.
"lineItems": [ # Required. The line items of the subscription.
- { # Individual line item definition of a subscription. Next id: 9
+ { # Individual line item definition of a subscription.
"description": "A String", # Output only. Description of this line item.
"lineItemFreeTrialEndTime": "A String", # Output only. It is set only if the line item has its own free trial applied. End time of the line item free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified.
"lineItemPromotionSpecs": [ # Optional. The promotions applied on the line item. It can be: - a free trial promotion, which overrides the subscription-level free trial promotion. - an introductory pricing promotion. When used as input in Create or Provision API, specify its resource name only.
@@ -947,6 +1052,21 @@ Method Details
},
},
"product": "A String", # Required. Product resource name that identifies one the line item The format is 'partners/{partner_id}/products/{product_id}'.
+ "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item.
+ "googleOnePayload": { # Payload specific to Google One products. # Payload specific to Google One products.
+ "campaigns": [ # Campaign attributed to sales of this subscription.
+ "A String",
+ ],
+ "offering": "A String", # The type of offering the subscription was sold by the partner. e.g. VAS.
+ "salesChannel": "A String", # The type of sales channel through which the subscription was sold.
+ "storeId": "A String", # The identifier for the partner store where the subscription was sold.
+ },
+ "youtubePayload": { # Payload specific to Youtube products. # Payload specific to Youtube products.
+ "partnerEligibilityIds": [ # The list of eligibility_ids which are applicable for the line item.
+ "A String",
+ ],
+ },
+ },
"recurrenceType": "A String", # Output only. The recurrence type of the line item.
"state": "A String", # Output only. The state of the line item.
},
diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json
index a02e222e043..3a81f7c9a18 100644
--- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json
+++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json
@@ -290,7 +290,7 @@
}
},
"extend": {
- "description": "Used by partners to extend a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts.",
+ "description": "[Deprecated] New partners should be on auto-extend by default. Used by partners to extend a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts.",
"flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:extend",
"httpMethod": "POST",
"id": "paymentsresellersubscription.partners.subscriptions.extend",
@@ -396,7 +396,7 @@
}
}
},
- "revision": "20221115",
+ "revision": "20221204",
"rootUrl": "https://paymentsresellersubscription.googleapis.com/",
"schemas": {
"GoogleCloudPaymentsResellerSubscriptionV1Amount": {
@@ -592,6 +592,60 @@
},
"type": "object"
},
+ "GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload": {
+ "description": "Payload specific to Google One products.",
+ "id": "GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload",
+ "properties": {
+ "campaigns": {
+ "description": "Campaign attributed to sales of this subscription.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "offering": {
+ "description": "The type of offering the subscription was sold by the partner. e.g. VAS.",
+ "enum": [
+ "OFFERING_UNSPECIFIED",
+ "OFFERING_VAS_BUNDLE",
+ "OFFERING_VAS_STANDALONE",
+ "OFFERING_HARD_BUNDLE",
+ "OFFERING_SOFT_BUNDLE"
+ ],
+ "enumDescriptions": [
+ "The type of partner offering is unspecified.",
+ "Google One product purchased as a Value added service in addition to existing partner's products. Customer pays additional amount for Google One product.",
+ "Google One product purchased by itself by customer as a value add service. Customer pays additional amount for Google One product.",
+ "Product purchased as part of a hard bundle where Google One was included with the bundle. Google One pricing is included in the bundle.",
+ "Purchased as part of a bundle where Google One was provided as an option. Google One pricing is included in the bundle."
+ ],
+ "type": "string"
+ },
+ "salesChannel": {
+ "description": "The type of sales channel through which the subscription was sold.",
+ "enum": [
+ "CHANNEL_UNSPECIFIED",
+ "CHANNEL_RETAIL",
+ "CHANNEL_ONLINE_WEB",
+ "CHANNEL_ONLINE_ANDROID_APP",
+ "CHANNEL_ONLINE_IOS_APP"
+ ],
+ "enumDescriptions": [
+ "The channel type is unspecified.",
+ "Sold at store.",
+ "Sold through partner website.",
+ "Sold through partner android app.",
+ "Sold through partner iOS app."
+ ],
+ "type": "string"
+ },
+ "storeId": {
+ "description": "The identifier for the partner store where the subscription was sold.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse": {
"id": "GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse",
"properties": {
@@ -682,6 +736,21 @@
},
"type": "object"
},
+ "GoogleCloudPaymentsResellerSubscriptionV1ProductPayload": {
+ "description": "Specifies product specific payload.",
+ "id": "GoogleCloudPaymentsResellerSubscriptionV1ProductPayload",
+ "properties": {
+ "googleOnePayload": {
+ "$ref": "GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload",
+ "description": "Payload specific to Google One products."
+ },
+ "youtubePayload": {
+ "$ref": "GoogleCloudPaymentsResellerSubscriptionV1YoutubePayload",
+ "description": "Payload specific to Youtube products."
+ }
+ },
+ "type": "object"
+ },
"GoogleCloudPaymentsResellerSubscriptionV1ProductPriceConfig": {
"description": "Configs the prices in an available region.",
"id": "GoogleCloudPaymentsResellerSubscriptionV1ProductPriceConfig",
@@ -996,7 +1065,7 @@
"type": "object"
},
"GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItem": {
- "description": "Individual line item definition of a subscription. Next id: 9",
+ "description": "Individual line item definition of a subscription.",
"id": "GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItem",
"properties": {
"description": {
@@ -1026,6 +1095,10 @@
"description": "Required. Product resource name that identifies one the line item The format is 'partners/{partner_id}/products/{product_id}'.",
"type": "string"
},
+ "productPayload": {
+ "$ref": "GoogleCloudPaymentsResellerSubscriptionV1ProductPayload",
+ "description": "Optional. Product specific payload for this line item."
+ },
"recurrenceType": {
"description": "Output only. The recurrence type of the line item.",
"enum": [
@@ -1154,6 +1227,20 @@
},
"type": "object"
},
+ "GoogleCloudPaymentsResellerSubscriptionV1YoutubePayload": {
+ "description": "Payload specific to Youtube products.",
+ "id": "GoogleCloudPaymentsResellerSubscriptionV1YoutubePayload",
+ "properties": {
+ "partnerEligibilityIds": {
+ "description": "The list of eligibility_ids which are applicable for the line item.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
"GoogleTypeLocalizedText": {
"description": "Localized variant of a text in a particular language.",
"id": "GoogleTypeLocalizedText",