cancel method

Future<void> cancel(
  1. String packageName,
  2. String subscriptionId,
  3. String token, {
  4. String? $fields,
})

Cancels a user's subscription purchase.

The subscription remains valid until its expiration time.

Request parameters:

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

subscriptionId - The purchased subscription ID (for example, 'monthly001').

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

$fields - Selector specifying which fields to include in a partial response.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<void> cancel(
  core.String packageName,
  core.String subscriptionId,
  core.String token, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'androidpublisher/v3/applications/' +
      commons.escapeVariable('$packageName') +
      '/purchases/subscriptions/' +
      commons.escapeVariable('$subscriptionId') +
      '/tokens/' +
      commons.escapeVariable('$token') +
      ':cancel';

  await _requester.request(
    url_,
    'POST',
    queryParams: queryParams_,
    downloadOptions: null,
  );
}