Method: subscriptions.suspend
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ein aktives Abo wird pausiert.
Mit dieser Methode kannst du ein kostenpflichtiges Abo pausieren, das sich derzeit im Status ACTIVE befindet.
- Bei
FLEXIBLE-Abos wird die Abrechnung pausiert.
- Für
ANNUAL_MONTHLY_PAY- oder ANNUAL_YEARLY_PAY-Abos:
- Durch die Sperrung des Abos ändert sich das ursprünglich vereinbarte Verlängerungsdatum nicht.
- Ein gesperrtes Abo wird nicht verlängert. Wenn Sie das Abo nach dem ursprünglichen Verlängerungsdatum aktivieren, wird ein neues Jahresabo erstellt, das ab dem Tag der Aktivierung gilt.
Wir empfehlen Ihnen dringend, Abos nur für kurze Zeiträume zu pausieren, da eine Sperrung von mehr als 60 Tagen zur Kündigung des Abos führen kann.
HTTP-Anfrage
POST https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/suspend
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
| Parameter |
customerId |
string
Dies kann entweder der primäre Domainname des Kunden oder seine eindeutige Kennung sein. Wenn sich der Domainname eines Kunden ändert, kann der alte Domainname nicht mehr zum Zugriff auf den Kunden verwendet werden. Die eindeutige Kennung des Kunden (wie von der API zurückgegeben) kann jedoch immer verwendet werden. Wir empfehlen, die eindeutige Kennung gegebenenfalls in Ihren Systemen zu speichern.
|
subscriptionId |
string
Dieses Attribut ist erforderlich. Die subscriptionId ist die Abo-ID und ist für jeden Kunden eindeutig. Da sich eine subscriptionId ändert, wenn ein Abo aktualisiert wird, empfehlen wir, diese ID nicht als Schlüssel für persistente Daten zu verwenden. Die subscriptionId kannst du mit der Methode Alle Reseller-Abos abrufen ermitteln.
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Subscription.
Autorisierungsbereiche
Erfordert den folgenden OAuth-Bereich:
https://www.googleapis.com/auth/apps.order
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-25 (UTC)."],[],[],null,["# Method: subscriptions.suspend\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nSuspends an active subscription.\n\nYou can use this method to suspend a paid subscription that is currently in the `ACTIVE` state.\n\n- For `FLEXIBLE` subscriptions, billing is paused.\n- For `ANNUAL_MONTHLY_PAY` or `ANNUAL_YEARLY_PAY` subscriptions:\n - Suspending the subscription does not change the renewal date that was originally committed to.\n - A suspended subscription does not renew. If you activate the subscription after the original renewal date, a new annual subscription will be created, starting on the day of activation.\n\nWe strongly encourage you to suspend subscriptions only for short periods of time as suspensions over 60 days may result in the subscription being cancelled.\n\n### HTTP request\n\n`POST https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/suspend`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customerId` | `string` This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable. |\n| `subscriptionId` | `string` This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the [retrieve all reseller subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#get_all_subscriptions) method. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Subscription](/workspace/admin/reseller/reference/rest/v1/subscriptions#Subscription).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/apps.order`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
