Post v1+name:suspend — paymentsresellersubscription

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13145259.5 KB

partners

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.

post/v1/{+name}:suspend

Path parameters

namestring required

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

Request body

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

Successful response