Method: partners.subscriptions.cancel
Stay organized with collections
Save and categorize content based on your preferences.
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.
HTTP request
POST https://paymentsresellersubscription.googleapis.com/v1/{name=partners/*/subscriptions/*}:cancel
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the subscription resource to be cancelled. It will have the format of "partners/{partner_id}/subscriptions/{subscriptionId}"
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"cancellationReason": enum (CancellationReason),
"cancelImmediately": boolean
} |
| Fields |
cancellationReason |
enum (CancellationReason)
Specifies the reason for the cancellation.
|
cancelImmediately |
boolean
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 cancelation at renewalTime, 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.
|
Response body
Response that contains the cancelled subscription resource.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"subscription": {
object (Subscription)
}
} |
| Fields |
subscription |
object (Subscription)
The cancelled subscription resource.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-12 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-12 UTC."],[[["Enables partners to cancel subscriptions for their customers, either immediately or at the end of the current billing cycle."],["Requires the partner to use service accounts for direct cancellation requests."],["Cancellation can be performed immediately or deferred to the renewal time, depending on the `cancelImmediately` parameter."],["Provides a cancellation reason through the `cancellationReason` parameter."],["Returns the cancelled subscription resource upon successful execution."]]],["Partners use a POST request to `https://paymentsresellersubscription.googleapis.com/v1/{name=partners/*/subscriptions/*}:cancel` to cancel a customer's subscription. The `name` parameter is the subscription's resource ID. The request body requires a `cancellationReason` and an optional `cancelImmediately` flag (boolean). If `cancelImmediately` is true, cancellation is immediate. The response body returns the canceled `subscription` resource upon successful completion.\n"]]