Method: partners.subscriptions.suspend

Suspends a subscription. Contract terms may dictate if a prorated refund will be issued upon suspension. It should be called directly by the partner using service accounts.

HTTP request

POST https://paymentsresellersubscription.googleapis.com/v1/{name=partners/*/subscriptions/*}:suspend

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the subscription resource to be suspended. It will have the format of "partners/{partner_id}/subscriptions/{subscriptionId}"

Request body

The request body must be empty.

Response body

Response that contains the suspended subscription.

If successful, the response body contains data with the following structure:

JSON representation
{
  "subscription": {
    object (Subscription)
  }
}
Fields
subscription

object (Subscription)

The suspended subscription resource.