target.apidocs.com.google.api.services.paymentsresellersubscription.v1.PaymentsResellerSubscription.Partners.Subscriptions.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-paymentsresellersubscription Show documentation

There is a newer version: v1-rev20241211-2.0.0

Show newest version







PaymentsResellerSubscription.Partners.Subscriptions (Payments Reseller Subscription API v1-rev20241105-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.paymentsresellersubscription.v1
Class PaymentsResellerSubscription.Partners.Subscriptions



java.lang.Object


com.google.api.services.paymentsresellersubscription.v1.PaymentsResellerSubscription.Partners.Subscriptions







Enclosing class:
PaymentsResellerSubscription.Partners




public class PaymentsResellerSubscription.Partners.Subscriptions
extends Object
The "subscriptions" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
PaymentsResellerSubscription.Partners.Subscriptions.Cancel 


class 
PaymentsResellerSubscription.Partners.Subscriptions.Create 


class 
PaymentsResellerSubscription.Partners.Subscriptions.Entitle 


class 
PaymentsResellerSubscription.Partners.Subscriptions.Extend 


class 
PaymentsResellerSubscription.Partners.Subscriptions.Get 


class 
PaymentsResellerSubscription.Partners.Subscriptions.Provision 


class 
PaymentsResellerSubscription.Partners.Subscriptions.UndoCancel 









Constructor Summary

Constructors 

Constructor and Description


Subscriptions() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


PaymentsResellerSubscription.Partners.Subscriptions.Cancel
cancel(String name,
      GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest content)
Used by partners to cancel a subscription service either immediately or by the end of the current
 billing cycle for their customers.



PaymentsResellerSubscription.Partners.Subscriptions.Create
create(String parent,
      GoogleCloudPaymentsResellerSubscriptionV1Subscription content)
Used by partners to create a subscription for their customers.



PaymentsResellerSubscription.Partners.Subscriptions.Entitle
entitle(String name,
       GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest content)
Used by partners to entitle a previously provisioned subscription to the current end user.



PaymentsResellerSubscription.Partners.Subscriptions.Extend
extend(String name,
      GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest content)
[Opt-in only] Most partners should be on auto-extend by default.



PaymentsResellerSubscription.Partners.Subscriptions.Get
get(String name)
Used by partners to get a subscription by id.



PaymentsResellerSubscription.Partners.Subscriptions.Provision
provision(String parent,
         GoogleCloudPaymentsResellerSubscriptionV1Subscription content)
Used by partners to provision a subscription for their customers.



PaymentsResellerSubscription.Partners.Subscriptions.UndoCancel
undoCancel(String name,
          GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest content)
Revokes the pending cancellation of a subscription, which is currently in
 `STATE_CANCEL_AT_END_OF_CYCLE` state.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Subscriptions
public Subscriptions()









Method Detail





cancel
public PaymentsResellerSubscription.Partners.Subscriptions.Cancel cancel(String name,
                                                                         GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest content)
                                                                  throws IOException
Used by partners to cancel 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.

 Create a request for the method "subscriptions.cancel".

 This request holds the parameters needed by the paymentsresellersubscription server.  After
 setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
name - Required. The name of the subscription resource to be cancelled. It will have the format of
        "partners/{partner_id}/subscriptions/{subscription_id}"
content - the GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest
Returns:
the request
Throws:
IOException








create
public PaymentsResellerSubscription.Partners.Subscriptions.Create create(String parent,
                                                                         GoogleCloudPaymentsResellerSubscriptionV1Subscription content)
                                                                  throws IOException
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.

 Create a request for the method "subscriptions.create".

 This request holds the parameters needed by the paymentsresellersubscription server.  After
 setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
parent - Required. The parent resource name, which is the identifier of the partner. It will have the format
        of "partners/{partner_id}".
content - the GoogleCloudPaymentsResellerSubscriptionV1Subscription
Returns:
the request
Throws:
IOException








entitle
public PaymentsResellerSubscription.Partners.Subscriptions.Entitle entitle(String name,
                                                                           GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest content)
                                                                    throws IOException
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.

 Create a request for the method "subscriptions.entitle".

 This request holds the parameters needed by the paymentsresellersubscription server.  After
 setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
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}"
content - the GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest
Returns:
the request
Throws:
IOException








extend
public PaymentsResellerSubscription.Partners.Subscriptions.Extend extend(String name,
                                                                         GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest content)
                                                                  throws IOException
[Opt-in only] Most partners should be on auto-extend by default. Used by partners to extend a
 subscription service for their customers on an ongoing basis for the subscription to remain
 active and renewable. It should be called directly by the partner using service accounts.

 Create a request for the method "subscriptions.extend".

 This request holds the parameters needed by the paymentsresellersubscription server.  After
 setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
name - Required. The name of the subscription resource to be extended. It will have the format of
        "partners/{partner_id}/subscriptions/{subscription_id}".
content - the GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest
Returns:
the request
Throws:
IOException








get
public PaymentsResellerSubscription.Partners.Subscriptions.Get get(String name)
                                                            throws IOException
Used by partners to get a subscription by id. It should be called directly by the partner using
 service accounts.

 Create a request for the method "subscriptions.get".

 This request holds the parameters needed by the paymentsresellersubscription server.  After
 setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
name - Required. The name of the subscription resource to retrieve. It will have the format of
        "partners/{partner_id}/subscriptions/{subscription_id}"
Returns:
the request
Throws:
IOException








provision
public PaymentsResellerSubscription.Partners.Subscriptions.Provision provision(String parent,
                                                                               GoogleCloudPaymentsResellerSubscriptionV1Subscription content)
                                                                        throws IOException
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.

 Create a request for the method "subscriptions.provision".

 This request holds the parameters needed by the paymentsresellersubscription server.  After
 setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
parent - Required. The parent resource name, which is the identifier of the partner. It will have the format
        of "partners/{partner_id}".
content - the GoogleCloudPaymentsResellerSubscriptionV1Subscription
Returns:
the request
Throws:
IOException








undoCancel
public PaymentsResellerSubscription.Partners.Subscriptions.UndoCancel undoCancel(String name,
                                                                                 GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest content)
                                                                          throws IOException
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. - **This API doesn't apply to YouTube subscriptions.** It should be called directly by the
 partner using service accounts.

 Create a request for the method "subscriptions.undoCancel".

 This request holds the parameters needed by the paymentsresellersubscription server.  After
 setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the
 remote operation.

Parameters:
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}"
content - the GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`PaymentsResellerSubscription.Partners.Subscriptions.Cancel`
`class`	`PaymentsResellerSubscription.Partners.Subscriptions.Create`
`class`	`PaymentsResellerSubscription.Partners.Subscriptions.Entitle`
`class`	`PaymentsResellerSubscription.Partners.Subscriptions.Extend`
`class`	`PaymentsResellerSubscription.Partners.Subscriptions.Get`
`class`	`PaymentsResellerSubscription.Partners.Subscriptions.Provision`
`class`	`PaymentsResellerSubscription.Partners.Subscriptions.UndoCancel`

Modifier and Type	Method and Description
`PaymentsResellerSubscription.Partners.Subscriptions.Cancel`	`cancel(String name, GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest content)` Used by partners to cancel a subscription service either immediately or by the end of the current billing cycle for their customers.
`PaymentsResellerSubscription.Partners.Subscriptions.Create`	`create(String parent, GoogleCloudPaymentsResellerSubscriptionV1Subscription content)` Used by partners to create a subscription for their customers.
`PaymentsResellerSubscription.Partners.Subscriptions.Entitle`	`entitle(String name, GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest content)` Used by partners to entitle a previously provisioned subscription to the current end user.
`PaymentsResellerSubscription.Partners.Subscriptions.Extend`	`extend(String name, GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest content)` [Opt-in only] Most partners should be on auto-extend by default.
`PaymentsResellerSubscription.Partners.Subscriptions.Get`	`get(String name)` Used by partners to get a subscription by id.
`PaymentsResellerSubscription.Partners.Subscriptions.Provision`	`provision(String parent, GoogleCloudPaymentsResellerSubscriptionV1Subscription content)` Used by partners to provision a subscription for their customers.
`PaymentsResellerSubscription.Partners.Subscriptions.UndoCancel`	`undoCancel(String name, GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest content)` Revokes the pending cancellation of a subscription, which is currently in `STATE_CANCEL_AT_END_OF_CYCLE` state.