{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/sdm.service": {
"description": "See and/or control the devices that you selected"
}
}
}
},
"basePath": "",
"baseUrl": "https://paymentsresellersubscription.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Payments Reseller Subscription",
"description": "",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/payments/reseller/subscription/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "paymentsresellersubscription:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://paymentsresellersubscription.mtls.googleapis.com/",
"name": "paymentsresellersubscription",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"partners": {
"resources": {
"products": {
"methods": {
"list": {
"description": "Currently, it doesn't support **YouTube** products. Retrieves the products that can be resold by the partner. It should be authenticated with a service account.",
"flatPath": "v1/partners/{partnersId}/products",
"httpMethod": "GET",
"id": "paymentsresellersubscription.partners.products.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Specifies the filters for the product results. The syntax is defined in https://google.aip.dev/160 with the following caveats: 1. Only the following features are supported: - Logical operator `AND` - Comparison operator `=` (no wildcards `*`) - Traversal operator `.` - Has operator `:` (no wildcards `*`) 2. Only the following fields are supported: - `regionCodes` - `youtubePayload.partnerEligibilityId` - `youtubePayload.postalCode` 3. Unless explicitly mentioned above, other features are not supported. Example: `regionCodes:US AND youtubePayload.postalCode=94043 AND youtubePayload.partnerEligibilityId=eligibility-id`",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of products to return. The service may return fewer than this value. If unspecified, at most 50 products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `ListProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProducts` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent, the partner that can resell. Format: partners/{partner}",
"location": "path",
"pattern": "^partners/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/products",
"response": {
"$ref": "ListProductsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/sdm.service"
]
}
}
},
"promotions": {
"methods": {
"findEligible": {
"description": "Currently, it is only enabled for **YouTube**. Finds eligible promotions for the current user. The API requires user authorization via OAuth. The bare minimum oauth scope `openid` is sufficient, which will skip the consent screen.",
"flatPath": "v1/partners/{partnersId}/promotions:findEligible",
"httpMethod": "POST",
"id": "paymentsresellersubscription.partners.promotions.findEligible",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent, the partner that can resell. Format: partners/{partner}",
"location": "path",
"pattern": "^partners/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/promotions:findEligible",
"request": {
"$ref": "FindEligiblePromotionsRequest"
},
"response": {
"$ref": "FindEligiblePromotionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/sdm.service"
]
},
"list": {
"description": "Currently, it doesn't support **YouTube** promotions. Retrieves the promotions, such as free trial, that can be used by the partner. It should be authenticated with a service account.",
"flatPath": "v1/partners/{partnersId}/promotions",
"httpMethod": "GET",
"id": "paymentsresellersubscription.partners.promotions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Specifies the filters for the promotion results. The syntax is defined in https://google.aip.dev/160 with the following caveats: 1. Only the following features are supported: - Logical operator `AND` - Comparison operator `=` (no wildcards `*`) - Traversal operator `.` - Has operator `:` (no wildcards `*`) 2. Only the following fields are supported: - `applicableProducts` - `regionCodes` - `youtubePayload.partnerEligibilityId` - `youtubePayload.postalCode` 3. Unless explicitly mentioned above, other features are not supported. Example: `applicableProducts:partners/partner1/products/product1 AND regionCodes:US AND youtubePayload.postalCode=94043 AND youtubePayload.partnerEligibilityId=eligibility-id`",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 promotions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `ListPromotions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPromotions` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent, the partner that can resell. Format: partners/{partner}",
"location": "path",
"pattern": "^partners/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/promotions",
"response": {
"$ref": "ListPromotionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/sdm.service"
]
}
}
},
"subscriptions": {
"methods": {
"cancel": {
"description": "Cancels a subscription service either immediately or by the end of the current billing cycle for their customers. It should be called directly by the partner using service accounts.",
"flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:cancel",
"httpMethod": "POST",
"id": "paymentsresellersubscription.partners.subscriptions.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the subscription resource to be cancelled. It will have the format of \"partners/{partner_id}/subscriptions/{subscription_id}\"",
"location": "path",
"pattern": "^partners/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "CancelSubscriptionRequest"
},
"response": {
"$ref": "CancelSubscriptionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/sdm.service"
]
},
"create": {
"description": "Used by partners to create a subscription for their customers. The created subscription is associated with the end user inferred from the end user credentials. This API must be authorized by the end user using OAuth.",
"flatPath": "v1/partners/{partnersId}/subscriptions",
"httpMethod": "POST",
"id": "paymentsresellersubscription.partners.subscriptions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource name, which is the identifier of the partner. It will have the format of \"partners/{partner_id}\".",
"location": "path",
"pattern": "^partners/[^/]+$",
"required": true,
"type": "string"
},
"subscriptionId": {
"description": "Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription with the same ID already exists, the creation fails with an `ALREADY_EXISTS` error.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/subscriptions",
"request": {
"$ref": "Subscription"
},
"response": {
"$ref": "Subscription"
},
"scopes": [
"https://www.googleapis.com/auth/sdm.service"
]
},
"entitle": {
"description": "Entitles 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.",
"flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:entitle",
"httpMethod": "POST",
"id": "paymentsresellersubscription.partners.subscriptions.entitle",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the subscription resource that is entitled to the current end user. It will have the format of \"partners/{partner_id}/subscriptions/{subscription_id}\"",
"location": "path",
"pattern": "^partners/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:entitle",
"request": {
"$ref": "EntitleSubscriptionRequest"
},
"response": {
"$ref": "EntitleSubscriptionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/sdm.service"
]
},
"extend": {
"description": "[Opt-in only] Most partners should be on auto-extend by default. Extends 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",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the subscription resource to be extended. It will have the format of \"partners/{partner_id}/subscriptions/{subscription_id}\".",
"location": "path",
"pattern": "^partners/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:extend",
"request": {
"$ref": "ExtendSubscriptionRequest"
},
"response": {
"$ref": "ExtendSubscriptionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/sdm.service"
]
},
"get": {
"description": "Gets a subscription by id. It should be called directly by the partner using service accounts.",
"flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}",
"httpMethod": "GET",
"id": "paymentsresellersubscription.partners.subscriptions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the subscription resource to retrieve. It will have the format of \"partners/{partner_id}/subscriptions/{subscription_id}\"",
"location": "path",
"pattern": "^partners/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Subscription"
},
"scopes": [
"https://www.googleapis.com/auth/sdm.service"
]
},
"provision": {
"description": "Used by partners to provision a subscription for their customers. This creates a subscription without associating it with the end user account. EntitleSubscription must be called separately using OAuth in order for the end user account to be associated with the subscription. It should be called directly by the partner using service accounts.",
"flatPath": "v1/partners/{partnersId}/subscriptions:provision",
"httpMethod": "POST",
"id": "paymentsresellersubscription.partners.subscriptions.provision",
"parameterOrder": [
"parent"
],
"parameters": {
"cycleOptions.initialCycleDuration.count": {
"description": "number of duration units to be included.",
"format": "int32",
"location": "query",
"type": "integer"
},
"cycleOptions.initialCycleDuration.unit": {
"description": "The unit used for the duration",
"enum": [
"UNIT_UNSPECIFIED",
"MONTH",
"DAY",
"HOUR"
],
"enumDescriptions": [
"Default value, reserved as an invalid or an unexpected value.",
"Unit of a calendar month.",
"Unit of a day.",
"Unit of an hour. It is used for testing."
],
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name, which is the identifier of the partner. It will have the format of \"partners/{partner_id}\".",
"location": "path",
"pattern": "^partners/[^/]+$",
"required": true,
"type": "string"
},
"subscriptionId": {
"description": "Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription with the same ID already exists, the creation fails with an `ALREADY_EXISTS` error.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/subscriptions:provision",
"request": {
"$ref": "Subscription"
},
"response": {
"$ref": "Subscription"
},
"scopes": [
"https://www.googleapis.com/auth/sdm.service"
]
},
"resume": {
"description": "Resumes a suspended subscription. The new billing cycle will start at the time of the request. It should be called directly by the partner using service accounts.",
"flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:resume",
"httpMethod": "POST",
"id": "paymentsresellersubscription.partners.subscriptions.resume",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the subscription resource to be resumed. It will have the format of \"partners/{partner_id}/subscriptions/{subscription_id}\"",
"location": "path",
"pattern": "^partners/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:resume",
"request": {
"$ref": "ResumeSubscriptionRequest"
},
"response": {
"$ref": "ResumeSubscriptionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/sdm.service"
]
},
"suspend": {
"description": "Suspends a subscription. Contract terms may dictate if a prorated refund will be issued upon suspension. It should be called directly by the partner using service accounts.",
"flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:suspend",
"httpMethod": "POST",
"id": "paymentsresellersubscription.partners.subscriptions.suspend",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the subscription resource to be suspended. It will have the format of \"partners/{partner_id}/subscriptions/{subscription_id}\"",
"location": "path",
"pattern": "^partners/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:suspend",
"request": {
"$ref": "SuspendSubscriptionRequest"
},
"response": {
"$ref": "SuspendSubscriptionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/sdm.service"
]
},
"undoCancel": {
"description": "Currently, it is used by **Google One, Play Pass** partners. Revokes the pending cancellation of a subscription, which is currently in `STATE_CANCEL_AT_END_OF_CYCLE` state. If the subscription is already cancelled, the request will fail. It should be called directly by the partner using service accounts.",
"flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:undoCancel",
"httpMethod": "POST",
"id": "paymentsresellersubscription.partners.subscriptions.undoCancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the subscription resource whose pending cancellation needs to be undone. It will have the format of \"partners/{partner_id}/subscriptions/{subscription_id}\"",
"location": "path",
"pattern": "^partners/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:undoCancel",
"request": {
"$ref": "UndoCancelSubscriptionRequest"
},
"response": {
"$ref": "UndoCancelSubscriptionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/sdm.service"
]
}
},
"resources": {
"lineItems": {
"methods": {
"patch": {
"description": "Updates a line item of a subscription. It should be authenticated with a service account.",
"flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}/lineItems/{lineItemsId}",
"httpMethod": "PATCH",
"id": "paymentsresellersubscription.partners.subscriptions.lineItems.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. Resource name of the line item. Format: partners/{partner}/subscriptions/{subscription}/lineItems/{lineItem}",
"location": "path",
"pattern": "^partners/[^/]+/subscriptions/[^/]+/lineItems/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The list of fields to update. Only a limited set of fields can be updated. The allowed fields are the following: - `product_payload.googleHomePayload.googleStructureId`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "SubscriptionLineItem"
},
"response": {
"$ref": "SubscriptionLineItem"
},
"scopes": [
"https://www.googleapis.com/auth/sdm.service"
]
}
}
}
}
},
"userSessions": {
"methods": {
"generate": {
"description": "This API replaces user authorized OAuth consent based APIs (Create, Entitle). Issues a timed session token for the given user intent. You can use the session token to redirect the user to Google to finish the signup flow. You can re-generate new session token repeatedly for the same request if necessary, regardless of the previous tokens being expired or not. By default, the session token is valid for 1 hour.",
"flatPath": "v1/partners/{partnersId}/userSessions:generate",
"httpMethod": "POST",
"id": "paymentsresellersubscription.partners.userSessions.generate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent, the partner that can resell. Format: partners/{partner}",
"location": "path",
"pattern": "^partners/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/userSessions:generate",
"request": {
"$ref": "GenerateUserSessionRequest"
},
"response": {
"$ref": "GenerateUserSessionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/sdm.service"
]
}
}
}
}
}
},
"revision": "20260430",
"rootUrl": "https://paymentsresellersubscription.googleapis.com/",
"schemas": {
"Amount": {
"description": "Describes the amount unit including the currency code.",
"id": "Amount",
"properties": {
"amountMicros": {
"description": "Required. Amount in micros (1_000_000 micros = 1 currency unit)",
"format": "int64",
"type": "string"
},
"currencyCode": {
"description": "Required. Currency codes in accordance with [ISO-4217 Currency Codes] (https://en.wikipedia.org/wiki/ISO_4217). For example, USD.",
"type": "string"
}
},
"type": "object"
},
"CancelSubscriptionRequest": {
"description": "Request to cancel a subscription.",
"id": "CancelSubscriptionRequest",
"properties": {
"cancelImmediately": {
"description": "Optional. If true, Google will cancel the subscription immediately, and may or may not (based on the contract) issue a prorated refund for the remainder of the billing cycle. Otherwise, Google defers the cancellation at renewal_time, and will not issue a refund. - YouTube subscriptions must use this option currently. However, the user will still have access to the subscription until the end of the billing cycle.",
"type": "boolean"
},
"cancellationReason": {
"description": "Specifies the reason for the cancellation.",
"enum": [
"CANCELLATION_REASON_UNSPECIFIED",
"CANCELLATION_REASON_FRAUD",
"CANCELLATION_REASON_REMORSE",
"CANCELLATION_REASON_ACCIDENTAL_PURCHASE",
"CANCELLATION_REASON_PAST_DUE",
"CANCELLATION_REASON_ACCOUNT_CLOSED",
"CANCELLATION_REASON_UPGRADE_DOWNGRADE",
"CANCELLATION_REASON_USER_DELINQUENCY",
"CANCELLATION_REASON_SYSTEM_ERROR",
"CANCELLATION_REASON_SYSTEM_CANCEL",
"CANCELLATION_REASON_BILLING_SYSTEM_SWITCH",
"CANCELLATION_REASON_OTHER"
],
"enumDescriptions": [
"Reason is unspecified. Should not be used.",
"Fraudulent transaction.",
"Buyer's remorse.",
"Accidental purchase.",
"Payment is past due.",
"Used for notification only, do not use in Cancel API. User account closed.",
"Used for notification only, do not use in Cancel API. Cancellation due to upgrade or downgrade.",
"Cancellation due to user delinquency",
"Used for notification only, do not use in Cancel API. Cancellation due to an unrecoverable system error.",
"Used for notification only, do not use in Cancel API. The subscription is cancelled by Google automatically since it is no longer valid.",
"Cancellation due to a billing system switch.",
"Other reason."
],
"type": "string"
}
},
"type": "object"
},
"CancelSubscriptionResponse": {
"description": "Response that contains the cancelled subscription resource.",
"id": "CancelSubscriptionResponse",
"properties": {
"subscription": {
"$ref": "Subscription",
"description": "The cancelled subscription resource."
}
},
"type": "object"
},
"CreateSubscriptionIntent": {
"description": "Intent message for creating a Subscription resource.",
"id": "CreateSubscriptionIntent",
"properties": {
"cycleOptions": {
"$ref": "CycleOptions",
"description": "Optional. The cycle options for the subscription."
},
"parent": {
"description": "Required. The parent resource name, which is the identifier of the partner.",
"type": "string"
},
"subscription": {
"$ref": "Subscription",
"description": "Required. The Subscription to be created."
},
"subscriptionId": {
"description": "Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription was previously created with the same subscription_id, we will directly return that one.",
"type": "string"
}
},
"type": "object"
},
"CycleOptions": {
"description": "The cycle options when starting and resuming a subscription.",
"id": "CycleOptions",
"properties": {
"initialCycleDuration": {
"$ref": "Duration",
"description": "Optional. The duration of the initial cycle. Only `DAY` is supported. If set, Google will start the subscription with this initial cycle duration starting at the request time (see available methods below). A prorated charge will be applied. This option is available to the following methods: - partners.subscriptions.provision - partners.subscriptions.resume - partners.userSessions.generate "
}
},
"type": "object"
},
"Duration": {
"description": "Describes the length of a period of a time.",
"id": "Duration",
"properties": {
"count": {
"description": "number of duration units to be included.",
"format": "int32",
"type": "integer"
},
"unit": {
"description": "The unit used for the duration",
"enum": [
"UNIT_UNSPECIFIED",
"MONTH",
"DAY",
"HOUR"
],
"enumDescriptions": [
"Default value, reserved as an invalid or an unexpected value.",
"Unit of a calendar month.",
"Unit of a day.",
"Unit of an hour. It is used for testing."
],
"type": "string"
}
},
"type": "object"
},
"EntitleSubscriptionIntent": {
"description": "Intent for entitling the previously provisioned subscription to an end user.",
"id": "EntitleSubscriptionIntent",
"properties": {
"name": {
"description": "Required. The name of the subscription resource that is entitled to the current end user. It is in the format of \"partners/{partner_id}/subscriptions/{subscriptionId}\".",
"type": "string"
}
},
"type": "object"
},
"EntitleSubscriptionRequest": {
"description": "Partner request for entitling the previously provisioned subscription to an end user. The end user identity is inferred from the request OAuth context.",
"id": "EntitleSubscriptionRequest",
"properties": {
"lineItemEntitlementDetails": {
"description": "Optional. The line items to be entitled. If unspecified, all line items will be entitled.",
"items": {
"$ref": "EntitleSubscriptionRequestLineItemEntitlementDetails"
},
"type": "array"
}
},
"type": "object"
},
"EntitleSubscriptionRequestLineItemEntitlementDetails": {
"description": "The details of the line item to be entitled.",
"id": "EntitleSubscriptionRequestLineItemEntitlementDetails",
"properties": {
"lineItemIndex": {
"description": "Required. The index of the line item to be entitled.",
"format": "int32",
"type": "integer"
},
"products": {
"description": "Optional. Only applicable if the line item corresponds to a hard bundle. Product resource names that identify the bundle elements to be entitled in the line item. If unspecified, all bundle elements will be entitled. The format is 'partners/{partner_id}/products/{product_id}'.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"EntitleSubscriptionResponse": {
"description": "Response that contains the entitled subscription resource.",
"id": "EntitleSubscriptionResponse",
"properties": {
"subscription": {
"$ref": "Subscription",
"description": "The subscription that has user linked to it."
}
},
"type": "object"
},
"ExtendSubscriptionRequest": {
"description": "Request message for extending a Subscription resource. A new recurrence will be made based on the subscription schedule defined by the original product.",
"id": "ExtendSubscriptionRequest",
"properties": {
"extension": {
"$ref": "Extension",
"description": "Required. Specifies details of the extension. Currently, the duration of the extension must be exactly one billing cycle of the original subscription."
},
"requestId": {
"description": "Required. Restricted to 36 ASCII characters. A random UUID is recommended. The idempotency key for the request. The ID generation logic is controlled by the partner. request_id should be the same as on retries of the same request. A different request_id must be used for a extension of a different cycle.",
"type": "string"
}
},
"type": "object"
},
"ExtendSubscriptionResponse": {
"description": "Response that contains the timestamps after the extension.",
"id": "ExtendSubscriptionResponse",
"properties": {
"cycleEndTime": {
"description": "The time at which the subscription is expected to be extended, in ISO 8061 format. UTC timezone. Example, \"cycleEndTime\":\"2019-08-31T17:28:54.564Z\"",
"format": "google-datetime",
"type": "string"
},
"freeTrialEndTime": {
"description": "End of the free trial period, in ISO 8061 format. UTC timezone. Example, \"freeTrialEndTime\":\"2019-08-31T17:28:54.564Z\" This time will be set the same as initial subscription creation time if no free trial period is offered to the partner.",
"format": "google-datetime",
"type": "string"
},
"renewalTime": {
"description": "Output only. The time at which the subscription is expected to be renewed by Google - a new charge will be incurred and the service entitlement will be renewed. A non-immediate cancellation will take place at this time too, before which, the service entitlement for the end user will remain valid. UTC timezone in ISO 8061 format. For example: \"2019-08-31T17:28:54.564Z\"",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Extension": {
"description": "Describes the details of an extension request.",
"id": "Extension",
"properties": {
"duration": {
"$ref": "Duration",
"description": "Required. Specifies the period of access the subscription should grant."
},
"partnerUserToken": {
"description": "Required. Identifier of the end-user in partner\u2019s system.",
"type": "string"
}
},
"type": "object"
},
"FindEligiblePromotionsRequest": {
"description": "Request to find eligible promotions for the current user.",
"id": "FindEligiblePromotionsRequest",
"properties": {
"filter": {
"description": "Optional. Specifies the filters for the promotion results. The syntax is defined in https://google.aip.dev/160 with the following caveats: 1. Only the following features are supported: - Logical operator `AND` - Comparison operator `=` (no wildcards `*`) - Traversal operator `.` - Has operator `:` (no wildcards `*`) 2. Only the following fields are supported: - `applicableProducts` - `regionCodes` - `youtubePayload.partnerEligibilityId` - `youtubePayload.postalCode` 3. Unless explicitly mentioned above, other features are not supported. Example: `applicableProducts:partners/partner1/products/product1 AND regionCodes:US AND youtubePayload.postalCode=94043 AND youtubePayload.partnerEligibilityId=eligibility-id`",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 promotions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `FindEligiblePromotions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FindEligiblePromotions` must match the call that provided the page token.",
"type": "string"
}
},
"type": "object"
},
"FindEligiblePromotionsResponse": {
"description": "Response containing the found promotions for the current user.",
"id": "FindEligiblePromotionsResponse",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.",
"type": "string"
},
"promotions": {
"description": "The promotions for the current user.",
"items": {
"$ref": "Promotion"
},
"type": "array"
}
},
"type": "object"
},
"FiniteBillingCycleDetails": {
"description": "Details for a subscription line item with finite billing cycles.",
"id": "FiniteBillingCycleDetails",
"properties": {
"billingCycleCountLimit": {
"description": "The number of a subscription line item billing cycles after which billing will stop automatically.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GenerateUserSessionRequest": {
"description": "Request to generate a user session.",
"id": "GenerateUserSessionRequest",
"properties": {
"intentPayload": {
"$ref": "IntentPayload",
"description": "The user intent to generate the user session."
}
},
"type": "object"
},
"GenerateUserSessionResponse": {
"description": "Response that contains the details for generated user session.",
"id": "GenerateUserSessionResponse",
"properties": {
"userSession": {
"$ref": "UserSession",
"description": "The generated user session. The token size is proportional to the size of the intent payload."
}
},
"type": "object"
},
"GoogleHomePayload": {
"description": "Payload specific for Google Home products.",
"id": "GoogleHomePayload",
"properties": {
"attachedToGoogleStructure": {
"description": "Output only. This identifies whether the subscription is attached to a Google Home structure.",
"readOnly": true,
"type": "boolean"
},
"googleStructureId": {
"description": "Optional. Structure identifier on Google side.",
"type": "string"
},
"partnerStructureId": {
"description": "Optional. This identifies the structure ID on partner side that the subscription should be applied to. Only required when the partner requires structure mapping.",
"type": "string"
}
},
"type": "object"
},
"GoogleOnePayload": {
"description": "Payload specific to Google One products.",
"id": "GoogleOnePayload",
"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"
},
"GoogleTypeLocalizedText": {
"description": "Localized variant of a text in a particular language.",
"id": "GoogleTypeLocalizedText",
"properties": {
"languageCode": {
"description": "The text's BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
"type": "string"
},
"text": {
"description": "Localized string in the language corresponding to language_code below.",
"type": "string"
}
},
"type": "object"
},
"IntentPayload": {
"description": "The payload that describes the user intent.",
"id": "IntentPayload",
"properties": {
"createIntent": {
"$ref": "CreateSubscriptionIntent",
"description": "The request to create a subscription."
},
"entitleIntent": {
"$ref": "EntitleSubscriptionIntent",
"description": "The request to entitle a subscription."
},
"intentOptions": {
"$ref": "IntentPayloadIntentOptions",
"description": "Optional. The additional features for the intent."
}
},
"type": "object"
},
"IntentPayloadIntentOptions": {
"description": "The options for the intent.",
"id": "IntentPayloadIntentOptions",
"properties": {
"enableOfferOverride": {
"description": "Optional. If true, Google may use a different product and promotion id from the ones in the `create_intent` based on the user's eligibility. Only applicable for certain YouTube free trial offers.",
"type": "boolean"
}
},
"type": "object"
},
"ListProductsResponse": {
"description": "Response that contains the products.",
"id": "ListProductsResponse",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.",
"type": "string"
},
"products": {
"description": "The products for the specified partner.",
"items": {
"$ref": "Product"
},
"type": "array"
}
},
"type": "object"
},
"ListPromotionsResponse": {
"description": "Response that contains the promotions.",
"id": "ListPromotionsResponse",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.",
"type": "string"
},
"promotions": {
"description": "The promotions for the specified partner.",
"items": {
"$ref": "Promotion"
},
"type": "array"
}
},
"type": "object"
},
"Location": {
"description": "Describes a location of an end user.",
"id": "Location",
"properties": {
"postalCode": {
"description": "The postal code this location refers to. Ex. \"94043\"",
"type": "string"
},
"regionCode": {
"description": "2-letter ISO region code for current content region. Ex. \u201cUS\u201d Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1",
"type": "string"
}
},
"type": "object"
},
"Product": {
"description": "A Product resource that defines a subscription service that can be resold.",
"id": "Product",
"properties": {
"bundleDetails": {
"$ref": "ProductBundleDetails",
"description": "Output only. Specifies the details for a bundle product.",
"readOnly": true
},
"finiteBillingCycleDetails": {
"$ref": "FiniteBillingCycleDetails",
"description": "Optional. Details for a subscription line item with finite billing cycles. If unset, the line item will be charged indefinitely."
},
"name": {
"description": "Identifier. Response only. Resource name of the product. It will have the format of \"partners/{partner_id}/products/{product_id}\"",
"type": "string"
},
"priceConfigs": {
"description": "Output only. Price configs for the product in the available regions.",
"items": {
"$ref": "ProductPriceConfig"
},
"readOnly": true,
"type": "array"
},
"productType": {
"description": "Output only. Specifies the type of the product.",
"enum": [
"PRODUCT_TYPE_UNSPECIFIED",
"PRODUCT_TYPE_SUBSCRIPTION",
"PRODUCT_TYPE_BUNDLE_SUBSCRIPTION"
],
"enumDescriptions": [
"Unspecified. It's reserved as an unexpected value, should not be used.",
"The product is a subscription.",
"The product is a bundled subscription plan, which includes multiple subscription elements."
],
"readOnly": true,
"type": "string"
},
"regionCodes": {
"description": "Output only. 2-letter ISO region code where the product is available in. Ex. \"US\" Please refer to: https://en.wikipedia.org/wiki/ISO_3166-1",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"subscriptionBillingCycleDuration": {
"$ref": "Duration",
"description": "Output only. Specifies the length of the billing cycle of the subscription.",
"readOnly": true
},
"titles": {
"description": "Output only. Localized human readable name of the product.",
"items": {
"$ref": "GoogleTypeLocalizedText"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"ProductBundleDetails": {
"description": "Details for a bundle product.",
"id": "ProductBundleDetails",
"properties": {
"bundleElements": {
"description": "The individual products that are included in the bundle.",
"items": {
"$ref": "ProductBundleDetailsBundleElement"
},
"type": "array"
},
"entitlementMode": {
"description": "The entitlement mode of the bundle product.",
"enum": [
"ENTITLEMENT_MODE_UNSPECIFIED",
"ENTITLEMENT_MODE_FULL",
"ENTITLEMENT_MODE_INCREMENTAL"
],
"enumDescriptions": [
"Unspecified. It's reserved as an unexpected value, should not be used.",
"All the bundle elements must be fully activated in a single request.",
"The bundle elements could be incrementally activated."
],
"type": "string"
}
},
"type": "object"
},
"ProductBundleDetailsBundleElement": {
"description": "The individual product that is included in the bundle.",
"id": "ProductBundleDetailsBundleElement",
"properties": {
"product": {
"description": "Required. Output only. Product resource name that identifies the bundle element. The format is 'partners/{partner_id}/products/{product_id}'.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ProductPayload": {
"description": "Specifies product specific payload.",
"id": "ProductPayload",
"properties": {
"googleHomePayload": {
"$ref": "GoogleHomePayload",
"description": "Payload specific to Google Home products."
},
"googleOnePayload": {
"$ref": "GoogleOnePayload",
"description": "Product-specific payloads. Payload specific to Google One products."
},
"youtubePayload": {
"$ref": "YoutubePayload",
"description": "Payload specific to Youtube products."
}
},
"type": "object"
},
"ProductPriceConfig": {
"description": "Configs the prices in an available region.",
"id": "ProductPriceConfig",
"properties": {
"amount": {
"$ref": "Amount",
"description": "Output only. The price in the region.",
"readOnly": true
},
"regionCode": {
"description": "Output only. 2-letter ISO region code where the product is available in. Ex. \"US\".",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Promotion": {
"description": "A Promotion resource that defines a promotion for a subscription that can be resold.",
"id": "Promotion",
"properties": {
"applicableProducts": {
"description": "Output only. The product ids this promotion can be applied to.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"endTime": {
"description": "Optional. Specifies the end time (exclusive) of the period that the promotion is available in. If unset, the promotion is available indefinitely.",
"format": "google-datetime",
"type": "string"
},
"freeTrialDuration": {
"$ref": "Duration",
"description": "Optional. Specifies the duration of the free trial of the subscription when promotion_type is PROMOTION_TYPE_FREE_TRIAL"
},
"introductoryPricingDetails": {
"$ref": "PromotionIntroductoryPricingDetails",
"description": "Optional. Specifies the introductory pricing details when the promotion_type is PROMOTION_TYPE_INTRODUCTORY_PRICING."
},
"name": {
"description": "Identifier. Response only. Resource name of the subscription promotion. It will have the format of \"partners/{partner_id}/promotion/{promotion_id}\"",
"type": "string"
},
"promotionType": {
"description": "Output only. Specifies the type of the promotion.",
"enum": [
"PROMOTION_TYPE_UNSPECIFIED",
"PROMOTION_TYPE_FREE_TRIAL",
"PROMOTION_TYPE_INTRODUCTORY_PRICING"
],
"enumDescriptions": [
"The promotion type is unspecified.",
"The promotion is a free trial.",
"The promotion is a reduced introductory pricing."
],
"readOnly": true,
"type": "string"
},
"regionCodes": {
"description": "Output only. 2-letter ISO region code where the promotion is available in. Ex. \"US\" Please refer to: https://en.wikipedia.org/wiki/ISO_3166-1",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"startTime": {
"description": "Optional. Specifies the start time (inclusive) of the period that the promotion is available in.",
"format": "google-datetime",
"type": "string"
},
"titles": {
"description": "Output only. Localized human readable name of the promotion.",
"items": {
"$ref": "GoogleTypeLocalizedText"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"PromotionIntroductoryPricingDetails": {
"description": "The details of a introductory pricing promotion.",
"id": "PromotionIntroductoryPricingDetails",
"properties": {
"introductoryPricingSpecs": {
"description": "Output only. Specifies the introductory pricing periods.",
"items": {
"$ref": "PromotionIntroductoryPricingDetailsIntroductoryPricingSpec"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"PromotionIntroductoryPricingDetailsIntroductoryPricingSpec": {
"description": "The duration of an introductory pricing promotion.",
"id": "PromotionIntroductoryPricingDetailsIntroductoryPricingSpec",
"properties": {
"discountAmount": {
"$ref": "Amount",
"description": "Output only. The discount amount. The value is positive.",
"readOnly": true
},
"discountRatioMicros": {
"description": "Output only. The discount percentage in micros. For example, 50,000 represents 5%.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"recurrenceCount": {
"description": "Output only. The duration of an introductory offer in billing cycles.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"regionCode": {
"description": "Output only. 2-letter ISO region code where the product is available in. Ex. \"US\".",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ResumeSubscriptionRequest": {
"description": "Request to resume a suspended subscription.",
"id": "ResumeSubscriptionRequest",
"properties": {
"cycleOptions": {
"$ref": "CycleOptions",
"description": "Optional. The cycle options for the subscription."
},
"resumeMode": {
"description": "Required. The mode to resume the subscription.",
"enum": [
"RESUME_MODE_UNSPECIFIED",
"RESUME_MODE_CYCLE_OPTIONS",
"RESUME_MODE_RESTORE_EXISTING_BILLING_SCHEDULE",
"RESUME_MODE_IMMEDIATE_NEW_CYCLE"
],
"enumDescriptions": [
"Reserved for invalid or unexpected value. Do not use.",
"Resume the subscription using the input from `cycle_options`.",
"Resume the subscription with the existing billing schedule. The subscription's next renewal time must still be in the future for this mode to be applicable.",
"Resume the subscription and start a new billing cycle immediately, resulting in a new charge."
],
"type": "string"
}
},
"type": "object"
},
"ResumeSubscriptionResponse": {
"description": "Response that contains the resumed subscription.",
"id": "ResumeSubscriptionResponse",
"properties": {
"subscription": {
"$ref": "Subscription",
"description": "The resumed subscription resource."
}
},
"type": "object"
},
"ServicePeriod": {
"description": "A description of what time period or moment in time the product or service is being delivered over.",
"id": "ServicePeriod",
"properties": {
"endTime": {
"description": "Optional. The end time of the service period. Time is exclusive.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "Required. The start time of the service period. Time is inclusive.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Subscription": {
"description": "Acts as a central billing entity between an external partner and Google. Google services use the subscription state to grant or revoke the user's service entitlement. Note: The subscription state might not perfectly align with the user's service entitlement. Some services might continue providing access until the current cycle ends, even if the subscription is immediately canceled. Consult the relevant contract or product policy for specific details.",
"id": "Subscription",
"properties": {
"cancellationDetails": {
"$ref": "SubscriptionCancellationDetails",
"description": "Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`.",
"readOnly": true
},
"createTime": {
"description": "Output only. System generated timestamp when the subscription is created. UTC timezone.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"cycleEndTime": {
"description": "Output only. The time at which the subscription is expected to be extended, in ISO 8061 format. UTC timezone. For example: \"2019-08-31T17:28:54.564Z\"",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endUserEntitled": {
"description": "Output only. Indicates if the subscription is entitled to the end user.",
"readOnly": true,
"type": "boolean"
},
"freeTrialEndTime": {
"description": "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.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"lineItems": {
"description": "Required. The line items of the subscription.",
"items": {
"$ref": "SubscriptionLineItem"
},
"type": "array"
},
"migrationDetails": {
"$ref": "SubscriptionMigrationDetails",
"description": "Output only. Describes the details of the migrated subscription. Only populated if this subscription is migrated from another system.",
"readOnly": true
},
"name": {
"description": "Identifier. Resource name of the subscription. It will have the format of \"partners/{partner_id}/subscriptions/{subscription_id}\". This is available for authorizeAddon, but otherwise is response only.",
"type": "string"
},
"partnerUserToken": {
"description": "Required. Identifier of the end-user in partner\u2019s system. The value is restricted to 63 ASCII characters at the maximum.",
"type": "string"
},
"processingState": {
"description": "Output only. Describes the processing state of the subscription. See more details at [the lifecycle of a subscription](/payments/reseller/subscription/reference/index/Receive.Notifications#payments-subscription-lifecycle).",
"enum": [
"PROCESSING_STATE_UNSPECIFIED",
"PROCESSING_STATE_CANCELLING",
"PROCESSING_STATE_RECURRING",
"PROCESSING_STATE_RESUMING"
],
"enumDescriptions": [
"The processing state is unspecified.",
"The subscription is being cancelled.",
"The subscription is recurring.",
"The subscription is being resumed."
],
"readOnly": true,
"type": "string"
},
"products": {
"description": "Optional. Deprecated: consider using `line_items` as the input. Required. Resource name that identifies the purchased products. The format will be 'partners/{partner_id}/products/{product_id}'.",
"items": {
"type": "string"
},
"type": "array"
},
"promotionSpecs": {
"description": "Optional. Subscription-level promotions. Only free trial is supported on this level. It determines the first renewal time of the subscription to be the end of the free trial period. Specify the promotion resource name only when used as input.",
"items": {
"$ref": "SubscriptionPromotionSpec"
},
"type": "array"
},
"promotions": {
"description": "Optional. Deprecated: consider using the top-level `promotion_specs` as the input. Optional. Resource name that identifies one or more promotions that can be applied on the product. A typical promotion for a subscription is Free trial. The format will be 'partners/{partner_id}/promotions/{promotion_id}'.",
"items": {
"type": "string"
},
"type": "array"
},
"purchaseTime": {
"description": "Optional. The timestamp when the user transaction was made with the Partner. Specify for the case of \"bundle with choice\", and it must be before the provision_time (when the user makes a selection).",
"format": "google-datetime",
"type": "string"
},
"redirectUri": {
"description": "Output only. The place where partners should redirect the end-user to after creation. This field might also be populated when creation failed. However, Partners should always prepare a default URL to redirect the user in case this field is empty.",
"readOnly": true,
"type": "string"
},
"renewalTime": {
"description": "Output only. The time at which the subscription is expected to be renewed by Google - a new charge will be incurred and the service entitlement will be renewed. A non-immediate cancellation will take place at this time too, before which, the service entitlement for the end user will remain valid. UTC timezone in ISO 8061 format. For example: \"2019-08-31T17:28:54.564Z\"",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"serviceLocation": {
"$ref": "Location",
"description": "Required. The location that the service is provided as indicated by the partner."
},
"state": {
"description": "Output only. Describes the state of the subscription. See more details at [the lifecycle of a subscription](/payments/reseller/subscription/reference/index/Receive.Notifications#payments-subscription-lifecycle).",
"enum": [
"STATE_UNSPECIFIED",
"STATE_CREATED",
"STATE_ACTIVE",
"STATE_CANCELLED",
"STATE_IN_GRACE_PERIOD",
"STATE_CANCEL_AT_END_OF_CYCLE",
"STATE_SUSPENDED"
],
"enumDescriptions": [
"The state is unspecified.",
"The subscription is created, a state before it is moved to STATE_ACTIVE.",
"The subscription is active.",
"The subscription is cancelled. This is the final state of the subscription, as it can no longer be modified or reactivated.",
"The subscription is in grace period. It can happen: 1) in manual extend mode, the subscription is not extended by the partner at the end of current cycle. 2) for outbound authorization enabled partners, a renewal purchase order is rejected.",
"The subscription is waiting to be cancelled by the next recurrence cycle.",
"The subscription is suspended."
],
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. System generated timestamp when the subscription is most recently updated. UTC timezone.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"upgradeDowngradeDetails": {
"$ref": "SubscriptionUpgradeDowngradeDetails",
"description": "Optional. Details about the previous subscription that this new subscription upgrades/downgrades from. Only populated if this subscription is an upgrade/downgrade from another subscription."
}
},
"type": "object"
},
"SubscriptionCancellationDetails": {
"description": "Describes the details of a cancelled or cancelling subscription.",
"id": "SubscriptionCancellationDetails",
"properties": {
"reason": {
"description": "Output only. The reason of the cancellation.",
"enum": [
"CANCELLATION_REASON_UNSPECIFIED",
"CANCELLATION_REASON_FRAUD",
"CANCELLATION_REASON_REMORSE",
"CANCELLATION_REASON_ACCIDENTAL_PURCHASE",
"CANCELLATION_REASON_PAST_DUE",
"CANCELLATION_REASON_ACCOUNT_CLOSED",
"CANCELLATION_REASON_UPGRADE_DOWNGRADE",
"CANCELLATION_REASON_USER_DELINQUENCY",
"CANCELLATION_REASON_SYSTEM_ERROR",
"CANCELLATION_REASON_SYSTEM_CANCEL",
"CANCELLATION_REASON_BILLING_SYSTEM_SWITCH",
"CANCELLATION_REASON_OTHER"
],
"enumDescriptions": [
"Reason is unspecified. Should not be used.",
"Fraudulent transaction.",
"Buyer's remorse.",
"Accidental purchase.",
"Payment is past due.",
"Used for notification only, do not use in Cancel API. User account closed.",
"Used for notification only, do not use in Cancel API. Cancellation due to upgrade or downgrade.",
"Cancellation due to user delinquency",
"Used for notification only, do not use in Cancel API. Cancellation due to an unrecoverable system error.",
"Used for notification only, do not use in Cancel API. The subscription is cancelled by Google automatically since it is no longer valid.",
"Cancellation due to a billing system switch.",
"Other reason."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"SubscriptionLineItem": {
"description": "Individual line item definition of a subscription.",
"id": "SubscriptionLineItem",
"properties": {
"amount": {
"$ref": "Amount",
"description": "Output only. The price of the product/service in this line item. The amount could be the wholesale price, or it can include a cost of sale based on the contract.",
"readOnly": true
},
"bundleDetails": {
"$ref": "SubscriptionLineItemBundleDetails",
"description": "Output only. The bundle details for the line item. Only populated if the line item corresponds to a hard bundle.",
"readOnly": true
},
"description": {
"description": "Output only. Description of this line item.",
"readOnly": true,
"type": "string"
},
"finiteBillingCycleDetails": {
"$ref": "FiniteBillingCycleDetails",
"description": "Optional. Details for a subscription line item with finite billing cycles. If unset, the line item will be charged indefinitely. Used only with LINE_ITEM_RECURRENCE_TYPE_PERIODIC."
},
"lineItemFreeTrialEndTime": {
"description": "Output only. The free trial end time will be populated after the line item is successfully processed. 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.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"lineItemIndex": {
"description": "Output only. A unique index of the subscription line item.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"lineItemPromotionSpecs": {
"description": "Optional. The promotions applied on the line item. It can be: - an introductory pricing promotion. - a free trial promotion. This feature is not enabled. If used, the request will be rejected. When used as input in Create or Provision API, specify its resource name only.",
"items": {
"$ref": "SubscriptionPromotionSpec"
},
"type": "array"
},
"name": {
"description": "Identifier. Resource name of the line item. Format: partners/{partner}/subscriptions/{subscription}/lineItems/{lineItem}",
"type": "string"
},
"oneTimeRecurrenceDetails": {
"$ref": "SubscriptionLineItemOneTimeRecurrenceDetails",
"description": "Output only. Details only set for a ONE_TIME recurrence line item.",
"readOnly": true
},
"product": {
"description": "Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'.",
"type": "string"
},
"productPayload": {
"$ref": "ProductPayload",
"description": "Optional. Product specific payload for this line item."
},
"recurrenceType": {
"description": "Output only. The recurrence type of the line item.",
"enum": [
"LINE_ITEM_RECURRENCE_TYPE_UNSPECIFIED",
"LINE_ITEM_RECURRENCE_TYPE_PERIODIC",
"LINE_ITEM_RECURRENCE_TYPE_ONE_TIME"
],
"enumDescriptions": [
"The line item recurrence type is unspecified.",
"The line item recurs periodically.",
"The line item does not recur in the future."
],
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The state of the line item.",
"enum": [
"LINE_ITEM_STATE_UNSPECIFIED",
"LINE_ITEM_STATE_ACTIVE",
"LINE_ITEM_STATE_INACTIVE",
"LINE_ITEM_STATE_NEW",
"LINE_ITEM_STATE_ACTIVATING",
"LINE_ITEM_STATE_DEACTIVATING",
"LINE_ITEM_STATE_WAITING_TO_DEACTIVATE",
"LINE_ITEM_STATE_OFF_CYCLE_CHARGING"
],
"enumDescriptions": [
"Unspecified state.",
"The line item is in ACTIVE state. If the subscription is cancelled or suspended, the line item will not be charged even if the line item is active.",
"The line item is in INACTIVE state.",
"The line item is new, and is not activated or charged yet.",
"The line item is being activated in order to be charged. If a free trial applies to the line item, the line item is pending a prorated charge at the end of the free trial period, as indicated by `line_item_free_trial_end_time`.",
"The line item is being deactivated, and a prorated refund in being processed.",
"The line item is scheduled to be deactivated at the end of the current cycle.",
"Line item is being charged off-cycle."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"SubscriptionLineItemBundleDetails": {
"description": "The bundle details for a line item corresponding to a hard bundle.",
"id": "SubscriptionLineItemBundleDetails",
"properties": {
"bundleElementDetails": {
"description": "Output only. The details for each element in the hard bundle.",
"items": {
"$ref": "SubscriptionLineItemBundleDetailsBundleElementDetails"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"SubscriptionLineItemBundleDetailsBundleElementDetails": {
"description": "The details for an element in the hard bundle.",
"id": "SubscriptionLineItemBundleDetailsBundleElementDetails",
"properties": {
"product": {
"description": "Output only. Product resource name that identifies the bundle element. The format is 'partners/{partner_id}/products/{product_id}'.",
"readOnly": true,
"type": "string"
},
"userAccountLinkedTime": {
"description": "Output only. The time when this product is linked to an end user.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"SubscriptionLineItemOneTimeRecurrenceDetails": {
"description": "Details for a ONE_TIME recurrence line item.",
"id": "SubscriptionLineItemOneTimeRecurrenceDetails",
"properties": {
"servicePeriod": {
"$ref": "ServicePeriod",
"description": "Output only. The service period of the ONE_TIME line item.",
"readOnly": true
}
},
"type": "object"
},
"SubscriptionMigrationDetails": {
"description": "Describes the details of the migrated subscription.",
"id": "SubscriptionMigrationDetails",
"properties": {
"migratedSubscriptionId": {
"description": "Output only. The migrated subscription id in the legacy system.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"SubscriptionPromotionSpec": {
"description": "Describes the spec for one promotion.",
"id": "SubscriptionPromotionSpec",
"properties": {
"freeTrialDuration": {
"$ref": "Duration",
"description": "Output only. The duration of the free trial if the promotion is of type FREE_TRIAL.",
"readOnly": true
},
"introductoryPricingDetails": {
"$ref": "PromotionIntroductoryPricingDetails",
"description": "Output only. The details of the introductory pricing spec if the promotion is of type INTRODUCTORY_PRICING.",
"readOnly": true
},
"promotion": {
"description": "Required. Promotion resource name that identifies a promotion. The format is 'partners/{partner_id}/promotions/{promotion_id}'.",
"type": "string"
},
"type": {
"description": "Output only. The type of the promotion for the spec.",
"enum": [
"PROMOTION_TYPE_UNSPECIFIED",
"PROMOTION_TYPE_FREE_TRIAL",
"PROMOTION_TYPE_INTRODUCTORY_PRICING"
],
"enumDescriptions": [
"The promotion type is unspecified.",
"The promotion is a free trial.",
"The promotion is a reduced introductory pricing."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"SubscriptionUpgradeDowngradeDetails": {
"description": "Details about the previous subscription that this new subscription upgrades/downgrades from.",
"id": "SubscriptionUpgradeDowngradeDetails",
"properties": {
"billingCycleSpec": {
"description": "Required. Specifies the billing cycle spec for the new upgraded/downgraded subscription.",
"enum": [
"BILLING_CYCLE_SPEC_UNSPECIFIED",
"BILLING_CYCLE_SPEC_ALIGN_WITH_PREVIOUS_SUBSCRIPTION",
"BILLING_CYCLE_SPEC_START_IMMEDIATELY",
"BILLING_CYCLE_SPEC_DEFERRED_TO_NEXT_RECURRENCE"
],
"enumDescriptions": [
"Billing cycle spec is not specified.",
"The billing cycle of the new subscription starts immediately but aligns with the previous subscription it upgrades or downgrades from. First cycle of the new subscription will be prorated.",
"The billing cycle of the new subscription starts immediately.",
"The new subscription will have the same `renewalTime` as the previous subscription, while the previous subscription is scheduled for cancellation at that same time."
],
"type": "string"
},
"previousSubscriptionId": {
"description": "Required. The previous subscription id to be replaced. The format can be one of the following: 1. `subscription_id`: the old subscription id under the same partner_id. 2. `partners/{partner_id}/subscriptions/{subscription_id}`. A different partner_id is allowed. But they must be under the same partner group.",
"type": "string"
}
},
"type": "object"
},
"SuspendSubscriptionRequest": {
"description": "Request to suspend a subscription.",
"id": "SuspendSubscriptionRequest",
"properties": {
"suspendMode": {
"description": "Optional. The mode to suspend the subscription. It's required for partners to specify the suspend mode, whether suspend immediately and indefinitely, or cancel the subscription after grace_period_millis or auto_cancel_duration_millis if it's not resumed.",
"enum": [
"SUSPEND_MODE_UNSPECIFIED",
"SUSPEND_MODE_CANCEL_AFTER_GRACE_PERIOD",
"SUSPEND_MODE_CANCEL_AFTER_RETENTION_PERIOD"
],
"enumDescriptions": [
"The default value. Suspend the subscription, and the subscription will stay suspended indefinitely.",
"Suspend the subscription, and the subscription will be auto cancelled after the grace period. Contract terms dictate how long the grace period is.",
"Suspend the subscription, and the subscription will be auto cancelled after the retention period. Contract terms dictate how long the retention period is."
],
"type": "string"
}
},
"type": "object"
},
"SuspendSubscriptionResponse": {
"description": "Response that contains the suspended subscription.",
"id": "SuspendSubscriptionResponse",
"properties": {
"subscription": {
"$ref": "Subscription",
"description": "The suspended subscription resource."
}
},
"type": "object"
},
"UndoCancelSubscriptionRequest": {
"description": "Request to revoke a cancellation request.",
"id": "UndoCancelSubscriptionRequest",
"properties": {},
"type": "object"
},
"UndoCancelSubscriptionResponse": {
"description": "Response that contains the updated subscription resource.",
"id": "UndoCancelSubscriptionResponse",
"properties": {
"subscription": {
"$ref": "Subscription",
"description": "The updated subscription resource."
}
},
"type": "object"
},
"UserSession": {
"description": "Contains a short-lived token containing information required to interact with the Google Payments Reseller Platform via web endpoints. - Generate a user session token dynamically for an authenticated user. Do not share a token directly with a user in an unauthenticated context, such as SMS or email. - You can regenerate new session tokens repeatedly for the same `generate` request if necessary, regardless of whether previous tokens have expired. Multiple sessions will not result in duplicate fulfillments because the `subscription ID` guarantees uniqueness. For more integration details, see the [Google Managed Signup](/payments/reseller/subscription/reference/index/User.Signup.Integration/Google.Managed.Signup) documentation.",
"id": "UserSession",
"properties": {
"expireTime": {
"description": "Output only. The time at which the user session expires.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"token": {
"description": "Output only. The encrypted token of the user session, including the information of the user's intent and request. This token should be provided when redirecting the user to Google.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"YoutubePayload": {
"description": "Payload specific to Youtube products.",
"id": "YoutubePayload",
"properties": {
"accessEndTime": {
"description": "Output only. The access expiration time for this line item.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"partnerEligibilityIds": {
"description": "The list of eligibility_ids which are applicable for the line item.",
"items": {
"type": "string"
},
"type": "array"
},
"partnerPlanType": {
"description": "Optional. Specifies the plan type offered to the end user by the partner.",
"enum": [
"PARTNER_PLAN_TYPE_UNSPECIFIED",
"PARTNER_PLAN_TYPE_STANDALONE",
"PARTNER_PLAN_TYPE_HARD_BUNDLE",
"PARTNER_PLAN_TYPE_SOFT_BUNDLE"
],
"enumDescriptions": [
"Unspecified. Should not use, reserved as an invalid value.",
"This item is offered as a standalone product to the user.",
"This item is bundled with another partner offering, the item is provisioned at purchase time.",
"This item is bundled with another partner offering, the item is provisioned after puchase, when the user opts in this Google service."
],
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Payments Reseller Subscription API",
"version": "v1",
"version_module": true
}