Method: subscriptions.suspend
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
השעיית מינוי פעיל.
אפשר להשתמש בשיטה הזו כדי להשעות מינוי בתשלום שנמצא כרגע במצב ACTIVE
.
- בחיוב של מינויים ל-
FLEXIBLE
, החיוב מושהה.
- למינויים מסוג
ANNUAL_MONTHLY_PAY
או ANNUAL_YEARLY_PAY
:
- השעיית המינוי לא משנה את תאריך החידוש שהתחייבתם אליו במקור.
- מינוי שהושעה לא מתחדש. אם תפעילו את המינוי אחרי תאריך החידוש המקורי, ייוצר מינוי שנתי חדש שיתחיל לפעול מהיום שבו תפעילו אותו.
מומלץ מאוד להשעות מינויים רק לפרקי זמן קצרים, כי השעיות של יותר מ-60 יום עלולות לגרום לביטול המינוי.
בקשת HTTP
POST https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/suspend
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
פרמטרים |
customerId |
string
זה יכול להיות שם הדומיין הראשי של הלקוח או המזהה הייחודי של הלקוח. אם שם הדומיין של לקוח ישתנה, לא תוכלו להשתמש בשם הדומיין הישן כדי לגשת ללקוח, אבל תמיד תוכלו להשתמש במזהה הייחודי של הלקוח (כפי שהוא מוחזר על ידי ה-API). מומלץ לאחסן את המזהה הייחודי במערכות שלכם במקרים הרלוונטיים.
|
subscriptionId |
string
זהו מאפיין חובה. השדה subscriptionId הוא מזהה המינוי והוא ייחודי לכל לקוח. מכיוון שהערך של subscriptionId משתנה כשמינוי מתעדכן, מומלץ לא להשתמש במזהה הזה כמפתח לנתונים קבועים. אפשר למצוא את subscriptionId באמצעות השיטה retrieve all reseller subscriptions.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה מצליחה, גוף התגובה מכיל מופע של Subscription
.
היקפי הרשאה
נדרש היקף הרשאות OAuth הבא:
https://www.googleapis.com/auth/apps.order
מידע נוסף זמין במדריך ההרשאות.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 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)."]]