Class PartnersResource.SubscriptionsResource
The "subscriptions" collection of methods.
Inherited Members
Namespace: Google.Apis.PaymentsResellerSubscription.v1
Assembly: Google.Apis.PaymentsResellerSubscription.v1.dll
Syntax
public class PartnersResource.SubscriptionsResource
Constructors
SubscriptionsResource(IClientService)
Constructs a new resource.
Declaration
public SubscriptionsResource(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service |
Methods
Cancel(GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest, string)
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.
Declaration
public virtual PartnersResource.SubscriptionsResource.CancelRequest Cancel(GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest | body | The body of the request. |
string | name | Required. The name of the subscription resource to be cancelled. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" |
Returns
Type | Description |
---|---|
PartnersResource.SubscriptionsResource.CancelRequest |
Create(GoogleCloudPaymentsResellerSubscriptionV1Subscription, string)
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.
Declaration
public virtual PartnersResource.SubscriptionsResource.CreateRequest Create(GoogleCloudPaymentsResellerSubscriptionV1Subscription body, string parent)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudPaymentsResellerSubscriptionV1Subscription | body | The body of the request. |
string | parent | Required. The parent resource name, which is the identifier of the partner. It will have the format of "partners/{partner_id}". |
Returns
Type | Description |
---|---|
PartnersResource.SubscriptionsResource.CreateRequest |
Entitle(GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest, string)
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.
Declaration
public virtual PartnersResource.SubscriptionsResource.EntitleRequest Entitle(GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest | body | The body of the request. |
string | name | 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}" |
Returns
Type | Description |
---|---|
PartnersResource.SubscriptionsResource.EntitleRequest |
Extend(GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest, string)
[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.
Declaration
public virtual PartnersResource.SubscriptionsResource.ExtendRequest Extend(GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest | body | The body of the request. |
string | name | Required. The name of the subscription resource to be extended. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}". |
Returns
Type | Description |
---|---|
PartnersResource.SubscriptionsResource.ExtendRequest |
Get(string)
Gets a subscription by id. It should be called directly by the partner using service accounts.
Declaration
public virtual PartnersResource.SubscriptionsResource.GetRequest Get(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The name of the subscription resource to retrieve. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" |
Returns
Type | Description |
---|---|
PartnersResource.SubscriptionsResource.GetRequest |
Provision(GoogleCloudPaymentsResellerSubscriptionV1Subscription, string)
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.
Declaration
public virtual PartnersResource.SubscriptionsResource.ProvisionRequest Provision(GoogleCloudPaymentsResellerSubscriptionV1Subscription body, string parent)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudPaymentsResellerSubscriptionV1Subscription | body | The body of the request. |
string | parent | Required. The parent resource name, which is the identifier of the partner. It will have the format of "partners/{partner_id}". |
Returns
Type | Description |
---|---|
PartnersResource.SubscriptionsResource.ProvisionRequest |
Resume(GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionRequest, string)
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.
Declaration
public virtual PartnersResource.SubscriptionsResource.ResumeRequest Resume(GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionRequest | body | The body of the request. |
string | name | Required. The name of the subscription resource to be resumed. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" |
Returns
Type | Description |
---|---|
PartnersResource.SubscriptionsResource.ResumeRequest |
Suspend(GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionRequest, string)
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.
Declaration
public virtual PartnersResource.SubscriptionsResource.SuspendRequest Suspend(GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionRequest | body | The body of the request. |
string | name | Required. The name of the subscription resource to be suspended. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" |
Returns
Type | Description |
---|---|
PartnersResource.SubscriptionsResource.SuspendRequest |
UndoCancel(GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest, string)
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.
Declaration
public virtual PartnersResource.SubscriptionsResource.UndoCancelRequest UndoCancel(GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest | body | The body of the request. |
string | name | 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}" |
Returns
Type | Description |
---|---|
PartnersResource.SubscriptionsResource.UndoCancelRequest |