partners

POST /v1/partners/{partnersId}/subscriptions/{subscriptionsId}:cancel

Cancels a subscription service either immediately or by the end of the current billing cycle for their customers. 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:cancel/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

partnersIdstring required

subscriptionsIdstring required

Request body

cancelImmediatelyboolean

Optional. If true, Google will cancel the subscription immediately, and may or may not (based on the contract) issue a prorated refund for the remainder of the billing cycle. Otherwise, Google defers the cancellation at renewal_time, and will not issue a refund. - YouTube subscriptions must use this option currently. However, the user will still have access to the subscription until the end of the billing cycle.

Specifies the reason for the cancellation.

Response

Successful response

Changes

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