partners

POST /v1/partners/{partnersId}/subscriptions/{subscriptionsId}: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.

Request

Base URL
https://paymentsresellersubscription.googleapis.com
Auth
OAuth 2 and OAuth 2
Implicithttps://accounts.google.com/o/oauth2/auth
Scopeshttps://www.googleapis.com/auth/sdm.service
Authorization codehttps://accounts.google.com/o/oauth2/auth
Token URLhttps://accounts.google.com/o/oauth2/token
Scopeshttps://www.googleapis.com/auth/sdm.service
TypeScript
https://skmtc.dev/google/apis/paymentsresellersubscription/docs/v1/partners/:partnersId/subscriptions/:subscriptionsId:suspend/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

partnersIdstring required

subscriptionsIdstring required

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

Changes

No recorded changes to this operation across all 4 revisions of this API.