| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="paymentsresellersubscription_v1.html">Payments Reseller Subscription API</a> . <a href="paymentsresellersubscription_v1.partners.html">partners</a> . <a href="paymentsresellersubscription_v1.partners.subscriptions.html">subscriptions</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Used by partners to cancel a subscription service by the end of the current billing cycle for their customers. It should be called directly by the partner using service accounts.</p> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, subscriptionId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">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.</p> |
| <p class="toc_element"> |
| <code><a href="#entitle">entitle(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">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.</p> |
| <p class="toc_element"> |
| <code><a href="#extend">extend(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Used by partners to extend a subscription service for their customers. It should be called directly by the partner using service accounts.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Used by partners to get a subscription by id. It should be called directly by the partner using service accounts.</p> |
| <p class="toc_element"> |
| <code><a href="#provision">provision(parent, body=None, subscriptionId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">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.</p> |
| <p class="toc_element"> |
| <code><a href="#undoCancel">undoCancel(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Used by partners to revoke 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.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code> |
| <pre>Used by partners to cancel a subscription service by the end of the current billing cycle for their customers. It should be called directly by the partner using service accounts. |
| |
| Args: |
| name: string, Required. The name of the subscription resource to be cancelled. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "cancelImmediately": True or False, # Optional. If true, the subscription will be cancelled immediately. Otherwise, the subscription will be cancelled at the end of the current cycle, and therefore no prorated refund will be issued for the rest of the cycle. |
| "cancellationReason": "A String", # Specifies the reason for the cancellation. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "subscription": { # A Subscription resource managed by 3P Partners. # The cancelled subscription resource. |
| "cancellationDetails": { # Describes the details of a cancelled subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. |
| "reason": "A String", # The reason of the cancellation. |
| }, |
| "createTime": "A String", # Output only. System generated timestamp when the subscription is created. UTC timezone. |
| "cycleEndTime": "A String", # 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" |
| "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. |
| "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" |
| "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. |
| "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. |
| "A String", |
| ], |
| "promotions": [ # 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}'. |
| "A String", |
| ], |
| "redirectUri": "A String", # 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. |
| "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. |
| "postalCode": "A String", # The postal code this location refers to. Ex. "94043" |
| "regionCode": "A String", # 2-letter ISO region code for current content region. Ex. “US” Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1 |
| }, |
| "state": "A String", # Output only. Descibes the state of the subscription. See more details at [the lifecycle of a subscription](/payments/reseller/subscription/reference/index/Receive.Notifications#payments-subscription-lifecycle). |
| "updateTime": "A String", # Output only. System generated timestamp when the subscription is most recently updated. UTC timezone. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, subscriptionId=None, x__xgafv=None)</code> |
| <pre>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. |
| |
| Args: |
| parent: string, Required. The parent resource name, which is the identifier of the partner. It will have the format of "partners/{partner_id}". (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A Subscription resource managed by 3P Partners. |
| "cancellationDetails": { # Describes the details of a cancelled subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. |
| "reason": "A String", # The reason of the cancellation. |
| }, |
| "createTime": "A String", # Output only. System generated timestamp when the subscription is created. UTC timezone. |
| "cycleEndTime": "A String", # 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" |
| "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. |
| "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" |
| "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. |
| "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. |
| "A String", |
| ], |
| "promotions": [ # 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}'. |
| "A String", |
| ], |
| "redirectUri": "A String", # 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. |
| "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. |
| "postalCode": "A String", # The postal code this location refers to. Ex. "94043" |
| "regionCode": "A String", # 2-letter ISO region code for current content region. Ex. “US” Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1 |
| }, |
| "state": "A String", # Output only. Descibes the state of the subscription. See more details at [the lifecycle of a subscription](/payments/reseller/subscription/reference/index/Receive.Notifications#payments-subscription-lifecycle). |
| "updateTime": "A String", # Output only. System generated timestamp when the subscription is most recently updated. UTC timezone. |
| } |
| |
| subscriptionId: string, 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A Subscription resource managed by 3P Partners. |
| "cancellationDetails": { # Describes the details of a cancelled subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. |
| "reason": "A String", # The reason of the cancellation. |
| }, |
| "createTime": "A String", # Output only. System generated timestamp when the subscription is created. UTC timezone. |
| "cycleEndTime": "A String", # 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" |
| "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. |
| "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" |
| "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. |
| "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. |
| "A String", |
| ], |
| "promotions": [ # 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}'. |
| "A String", |
| ], |
| "redirectUri": "A String", # 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. |
| "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. |
| "postalCode": "A String", # The postal code this location refers to. Ex. "94043" |
| "regionCode": "A String", # 2-letter ISO region code for current content region. Ex. “US” Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1 |
| }, |
| "state": "A String", # Output only. Descibes the state of the subscription. See more details at [the lifecycle of a subscription](/payments/reseller/subscription/reference/index/Receive.Notifications#payments-subscription-lifecycle). |
| "updateTime": "A String", # Output only. System generated timestamp when the subscription is most recently updated. UTC timezone. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="entitle">entitle(name, body=None, x__xgafv=None)</code> |
| <pre>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. |
| |
| Args: |
| name: string, 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}" (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Partner request for entitling the previously provisioned subscription to an end user. The end user identity is inferred from the request OAuth context. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "subscription": { # A Subscription resource managed by 3P Partners. # The subscription that has user linked to it. |
| "cancellationDetails": { # Describes the details of a cancelled subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. |
| "reason": "A String", # The reason of the cancellation. |
| }, |
| "createTime": "A String", # Output only. System generated timestamp when the subscription is created. UTC timezone. |
| "cycleEndTime": "A String", # 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" |
| "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. |
| "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" |
| "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. |
| "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. |
| "A String", |
| ], |
| "promotions": [ # 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}'. |
| "A String", |
| ], |
| "redirectUri": "A String", # 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. |
| "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. |
| "postalCode": "A String", # The postal code this location refers to. Ex. "94043" |
| "regionCode": "A String", # 2-letter ISO region code for current content region. Ex. “US” Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1 |
| }, |
| "state": "A String", # Output only. Descibes the state of the subscription. See more details at [the lifecycle of a subscription](/payments/reseller/subscription/reference/index/Receive.Notifications#payments-subscription-lifecycle). |
| "updateTime": "A String", # Output only. System generated timestamp when the subscription is most recently updated. UTC timezone. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="extend">extend(name, body=None, x__xgafv=None)</code> |
| <pre>Used by partners to extend a subscription service for their customers. 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) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for extending a Subscription resource. A new recurrence will be made based on the subscription schedule defined by the original product. |
| "extension": { # Describes the details of an extension request. # Required. Specifies details of the extension. Currently, the duration of the extension must be exactly one billing cycle of the original subscription. |
| "duration": { # Describes the length of a period of a time. # Specifies the period of access the subscription should grant. |
| "count": 42, # number of duration units to be included. |
| "unit": "A String", # The unit used for the duration |
| }, |
| "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. |
| }, |
| "requestId": "A String", # 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. A random UUID is recommended. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "cycleEndTime": "A String", # 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" |
| "freeTrialEndTime": "A String", # 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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Used by partners to get a subscription by id. It should be called directly by the partner using service accounts. |
| |
| Args: |
| name: string, Required. The name of the subscription resource to retrieve. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A Subscription resource managed by 3P Partners. |
| "cancellationDetails": { # Describes the details of a cancelled subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. |
| "reason": "A String", # The reason of the cancellation. |
| }, |
| "createTime": "A String", # Output only. System generated timestamp when the subscription is created. UTC timezone. |
| "cycleEndTime": "A String", # 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" |
| "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. |
| "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" |
| "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. |
| "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. |
| "A String", |
| ], |
| "promotions": [ # 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}'. |
| "A String", |
| ], |
| "redirectUri": "A String", # 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. |
| "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. |
| "postalCode": "A String", # The postal code this location refers to. Ex. "94043" |
| "regionCode": "A String", # 2-letter ISO region code for current content region. Ex. “US” Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1 |
| }, |
| "state": "A String", # Output only. Descibes the state of the subscription. See more details at [the lifecycle of a subscription](/payments/reseller/subscription/reference/index/Receive.Notifications#payments-subscription-lifecycle). |
| "updateTime": "A String", # Output only. System generated timestamp when the subscription is most recently updated. UTC timezone. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="provision">provision(parent, body=None, subscriptionId=None, x__xgafv=None)</code> |
| <pre>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. |
| |
| Args: |
| parent: string, Required. The parent resource name, which is the identifier of the partner. It will have the format of "partners/{partner_id}". (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A Subscription resource managed by 3P Partners. |
| "cancellationDetails": { # Describes the details of a cancelled subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. |
| "reason": "A String", # The reason of the cancellation. |
| }, |
| "createTime": "A String", # Output only. System generated timestamp when the subscription is created. UTC timezone. |
| "cycleEndTime": "A String", # 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" |
| "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. |
| "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" |
| "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. |
| "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. |
| "A String", |
| ], |
| "promotions": [ # 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}'. |
| "A String", |
| ], |
| "redirectUri": "A String", # 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. |
| "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. |
| "postalCode": "A String", # The postal code this location refers to. Ex. "94043" |
| "regionCode": "A String", # 2-letter ISO region code for current content region. Ex. “US” Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1 |
| }, |
| "state": "A String", # Output only. Descibes the state of the subscription. See more details at [the lifecycle of a subscription](/payments/reseller/subscription/reference/index/Receive.Notifications#payments-subscription-lifecycle). |
| "updateTime": "A String", # Output only. System generated timestamp when the subscription is most recently updated. UTC timezone. |
| } |
| |
| subscriptionId: string, 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A Subscription resource managed by 3P Partners. |
| "cancellationDetails": { # Describes the details of a cancelled subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. |
| "reason": "A String", # The reason of the cancellation. |
| }, |
| "createTime": "A String", # Output only. System generated timestamp when the subscription is created. UTC timezone. |
| "cycleEndTime": "A String", # 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" |
| "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. |
| "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" |
| "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. |
| "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. |
| "A String", |
| ], |
| "promotions": [ # 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}'. |
| "A String", |
| ], |
| "redirectUri": "A String", # 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. |
| "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. |
| "postalCode": "A String", # The postal code this location refers to. Ex. "94043" |
| "regionCode": "A String", # 2-letter ISO region code for current content region. Ex. “US” Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1 |
| }, |
| "state": "A String", # Output only. Descibes the state of the subscription. See more details at [the lifecycle of a subscription](/payments/reseller/subscription/reference/index/Receive.Notifications#payments-subscription-lifecycle). |
| "updateTime": "A String", # Output only. System generated timestamp when the subscription is most recently updated. UTC timezone. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="undoCancel">undoCancel(name, body=None, x__xgafv=None)</code> |
| <pre>Used by partners to revoke 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. |
| |
| Args: |
| name: string, 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}" (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request to revoke a cancellation request. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response that contains the updated subscription resource. |
| "subscription": { # A Subscription resource managed by 3P Partners. # The updated subscription resource. |
| "cancellationDetails": { # Describes the details of a cancelled subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. |
| "reason": "A String", # The reason of the cancellation. |
| }, |
| "createTime": "A String", # Output only. System generated timestamp when the subscription is created. UTC timezone. |
| "cycleEndTime": "A String", # 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" |
| "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. |
| "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" |
| "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. |
| "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. |
| "A String", |
| ], |
| "promotions": [ # 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}'. |
| "A String", |
| ], |
| "redirectUri": "A String", # 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. |
| "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. |
| "postalCode": "A String", # The postal code this location refers to. Ex. "94043" |
| "regionCode": "A String", # 2-letter ISO region code for current content region. Ex. “US” Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1 |
| }, |
| "state": "A String", # Output only. Descibes the state of the subscription. See more details at [the lifecycle of a subscription](/payments/reseller/subscription/reference/index/Receive.Notifications#payments-subscription-lifecycle). |
| "updateTime": "A String", # Output only. System generated timestamp when the subscription is most recently updated. UTC timezone. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |