com.google.api.services.androidpublisher

Class AndroidPublisher.Purchases.Subscriptions.Cancel

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.androidpublisher.AndroidPublisherRequest<Void>

com.google.api.services.androidpublisher.AndroidPublisher.Purchases.Subscriptions.Cancel

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

AndroidPublisher.Purchases.Subscriptions

public class AndroidPublisher.Purchases.Subscriptions.Cancel
extends AndroidPublisherRequest<Void>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Cancel(String packageName, String subscriptionId, String token) Cancels a user's subscription purchase.

Method Summary

Modifier and Type	Method and Description
String	getPackageName() The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
String	getSubscriptionId() Note: Since May 21, 2025, subscription_id is not required, and not recommended for subscription with add-ons.
String	getToken() The token provided to the user's device when the subscription was purchased.
AndroidPublisher.Purchases.Subscriptions.Cancel	set(String parameterName, Object value)
AndroidPublisher.Purchases.Subscriptions.Cancel	set$Xgafv(String $Xgafv) V1 error format.
AndroidPublisher.Purchases.Subscriptions.Cancel	setAccessToken(String accessToken) OAuth access token.
AndroidPublisher.Purchases.Subscriptions.Cancel	setAlt(String alt) Data format for response.
AndroidPublisher.Purchases.Subscriptions.Cancel	setCallback(String callback) JSONP
AndroidPublisher.Purchases.Subscriptions.Cancel	setFields(String fields) Selector specifying which fields to include in a partial response.
AndroidPublisher.Purchases.Subscriptions.Cancel	setKey(String key) API key.
AndroidPublisher.Purchases.Subscriptions.Cancel	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
AndroidPublisher.Purchases.Subscriptions.Cancel	setPackageName(String packageName) The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
AndroidPublisher.Purchases.Subscriptions.Cancel	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
AndroidPublisher.Purchases.Subscriptions.Cancel	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
AndroidPublisher.Purchases.Subscriptions.Cancel	setSubscriptionId(String subscriptionId) Note: Since May 21, 2025, subscription_id is not required, and not recommended for subscription with add-ons.
AndroidPublisher.Purchases.Subscriptions.Cancel	setToken(String token) The token provided to the user's device when the subscription was purchased.
AndroidPublisher.Purchases.Subscriptions.Cancel	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
AndroidPublisher.Purchases.Subscriptions.Cancel	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.androidpublisher.AndroidPublisherRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Cancel

protected Cancel(String packageName,
                 String subscriptionId,
                 String token)

Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support. Create a request for the method "subscriptions.cancel". This request holds the parameters needed by the the androidpublisher server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

AndroidPublisher.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

packageName - The package name of the application for which this subscription was purchased (for example, 'com.some.thing').

subscriptionId - Note: Since May 21, 2025, subscription_id is not required, and not recommended for subscription with add-ons. The purchased subscription ID (for example, 'monthly001').

token - The token provided to the user's device when the subscription was purchased.

Since:

1.13

Method Detail

set$Xgafv

public AndroidPublisher.Purchases.Subscriptions.Cancel set$Xgafv(String $Xgafv)

Description copied from class: AndroidPublisherRequest

V1 error format.

Overrides:

set$Xgafv in class AndroidPublisherRequest<Void>

setAccessToken

public AndroidPublisher.Purchases.Subscriptions.Cancel setAccessToken(String accessToken)

Description copied from class: AndroidPublisherRequest

OAuth access token.

Overrides:

setAccessToken in class AndroidPublisherRequest<Void>

setAlt

public AndroidPublisher.Purchases.Subscriptions.Cancel setAlt(String alt)

Description copied from class: AndroidPublisherRequest

Data format for response.

Overrides:

setAlt in class AndroidPublisherRequest<Void>

setCallback

public AndroidPublisher.Purchases.Subscriptions.Cancel setCallback(String callback)

Description copied from class: AndroidPublisherRequest

JSONP

Overrides:

setCallback in class AndroidPublisherRequest<Void>

setFields

public AndroidPublisher.Purchases.Subscriptions.Cancel setFields(String fields)

Description copied from class: AndroidPublisherRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AndroidPublisherRequest<Void>

setKey

public AndroidPublisher.Purchases.Subscriptions.Cancel setKey(String key)

Description copied from class: AndroidPublisherRequest

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.

Overrides:

setKey in class AndroidPublisherRequest<Void>

setOauthToken

public AndroidPublisher.Purchases.Subscriptions.Cancel setOauthToken(String oauthToken)

Description copied from class: AndroidPublisherRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AndroidPublisherRequest<Void>

setPrettyPrint

public AndroidPublisher.Purchases.Subscriptions.Cancel setPrettyPrint(Boolean prettyPrint)

Description copied from class: AndroidPublisherRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AndroidPublisherRequest<Void>

setQuotaUser

public AndroidPublisher.Purchases.Subscriptions.Cancel setQuotaUser(String quotaUser)

Description copied from class: AndroidPublisherRequest

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.

Overrides:

setQuotaUser in class AndroidPublisherRequest<Void>

setUploadType

public AndroidPublisher.Purchases.Subscriptions.Cancel setUploadType(String uploadType)

Description copied from class: AndroidPublisherRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class AndroidPublisherRequest<Void>

setUploadProtocol

public AndroidPublisher.Purchases.Subscriptions.Cancel setUploadProtocol(String uploadProtocol)

Description copied from class: AndroidPublisherRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class AndroidPublisherRequest<Void>

getPackageName

public String getPackageName()

The package name of the application for which this subscription was purchased (for example, 'com.some.thing').

setPackageName

public AndroidPublisher.Purchases.Subscriptions.Cancel setPackageName(String packageName)

The package name of the application for which this subscription was purchased (for example, 'com.some.thing').

getSubscriptionId

public String getSubscriptionId()

Note: Since May 21, 2025, subscription_id is not required, and not recommended for subscription with add-ons. The purchased subscription ID (for example, 'monthly001').

setSubscriptionId

public AndroidPublisher.Purchases.Subscriptions.Cancel setSubscriptionId(String subscriptionId)

Note: Since May 21, 2025, subscription_id is not required, and not recommended for subscription with add-ons. The purchased subscription ID (for example, 'monthly001').

getToken

public String getToken()

The token provided to the user's device when the subscription was purchased.

setToken

public AndroidPublisher.Purchases.Subscriptions.Cancel setToken(String token)

The token provided to the user's device when the subscription was purchased.

set

public AndroidPublisher.Purchases.Subscriptions.Cancel set(String parameterName,
                                                           Object value)

Overrides:

set in class AndroidPublisherRequest<Void>