---
title: "POST /v1/{+name}:suspend"
method: POST
path: "/v1/{+name}:suspend"
tags: ["partners"]
---

# POST /v1/{+name}:suspend

`POST /v1/{+name}: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.

## Path parameters

- `name` string, required

## Request body

- SuspendSubscriptionRequest — Request to suspend a subscription.
  - `suspendMode` 'SUSPEND_MODE_UNSPECIFIED' | 'SUSPEND_MODE_CANCEL_AFTER_GRACE_PERIOD' | 'SUSPEND_MODE_CANCEL_AFTER_RETENTION_PERIOD' — Optional. The mode to suspend the subscription. It's required for partners to specify the suspend mode, whether suspend immediately and indefinitely, or cancel the subscription after grace_period_millis or auto_cancel_duration_millis if it's not resumed.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/paymentsresellersubscription.md) · [All operations](https://skmtc.net/google/apis/paymentsresellersubscription/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/paymentsresellersubscription/revisions/c3d2f15ca50d/schema)