cancel method

Future<GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionResponse> cancel(
  1. GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest request,
  2. String name, {
  3. String? $fields,
})

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.

request - The metadata request object.

Request parameters:

name - Required. The name of the subscription resource to be cancelled. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" Value must have pattern ^partners/\[^/\]+/subscriptions/\[^/\]+$.

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

Completes with a GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionResponse.

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<
        GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionResponse>
    cancel(
  GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':cancel';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionResponse
      .fromJson(response_ as core.Map<core.String, core.dynamic>);
}