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 از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها |
---|
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 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],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)."]]