deactivate method

Future<SubscriptionOffer> deactivate(DeactivateSubscriptionOfferRequest request, String packageName, String productId, String basePlanId, String offerId, { String? $fields, })

Deactivates a subscription offer.

Once deactivated, existing subscribers will maintain their subscription, but the offer will become unavailable to new subscribers.

request - The metadata request object.

Request parameters:

packageName - Required. The parent app (package name) of the offer to deactivate.

productId - Required. The parent subscription (ID) of the offer to deactivate.

basePlanId - Required. The parent base plan (ID) of the offer to deactivate.

offerId - Required. The unique offer ID of the offer to deactivate.

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

Completes with a SubscriptionOffer.

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<SubscriptionOffer> deactivate(
  DeactivateSubscriptionOfferRequest request,
  core.String packageName,
  core.String productId,
  core.String basePlanId,
  core.String offerId, {
  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_ = 'androidpublisher/v3/applications/' +
      commons.escapeVariable('$packageName') +
      '/subscriptions/' +
      commons.escapeVariable('$productId') +
      '/basePlans/' +
      commons.escapeVariable('$basePlanId') +
      '/offers/' +
      commons.escapeVariable('$offerId') +
      ':deactivate';

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