يمكن أن يكون هذا اسم النطاق الأساسي للعميل أو المعرّف الفريد للعميل. في حال تغيير اسم نطاق العميل، لا يمكن استخدام اسم النطاق القديم للوصول إلى العميل، ولكن يمكن استخدام المعرّف الفريد للعميل (كما تعرضه واجهة برمجة التطبيقات) في أي وقت. ننصحك بتخزين المعرّف الفريد في أنظمتك كلما أمكن ذلك.
subscriptionId
string
هذه سمة مطلوبة. subscriptionId هو معرّف الاشتراك وهو فريد لكل عميل. بما أنّ القيمة subscriptionId تتغيّر عند تعديل اشتراك، ننصحك بعدم استخدام هذا المعرّف كمفتاح للبيانات الثابتة. ويمكن العثور على subscriptionId باستخدام طريقة استرداد جميع اشتراكات المورّدين.
لتحديد المورد كطلب تغيير خطة الاشتراك القيمة: subscriptions#changePlanRequest
planName
string
يجب إدراج السمة planName. هذا هو اسم خطة الدفع الخاصة بالاشتراك. لمزيد من المعلومات عن خطط الدفع من Google، يُرجى الاطّلاع على مفاهيم واجهة برمجة التطبيقات.
في ما يلي القيم المحتمَلة:
ANNUAL_MONTHLY_PAY: خطة الاشتراك السنوي مع الدفعات الشهرية
ANNUAL_YEARLY_PAY - خطة الالتزام السنوية بنظام الدفعات السنوية
FLEXIBLE - الخطة المرنة
TRIAL - خطة الفترة التجريبية المجانية التي تبلغ مدتها 30 يومًا
هذه سمة مطلوبة. سمة "المقاعد" هي عدد تراخيص مقاعد المستخدمين.
purchaseOrderId
string
هذا حقل اختياري. إنّ معلومات طلب الشراء هذه مخصّصة لبائعي التجزئة لاستخدامها في تتبُّع استخدام شركتهم. في حال تقديم قيمة purchaseOrderId، ستظهر في ردود واجهة برمجة التطبيقات وفي الفاتورة. يقبل الحقل ما يصل إلى 80 حرفًا من النص العادي.
dealCode
string
رمز صادر عن Google (100 حرف كحد أقصى) لأسعار مخفَّضة على خطط الاشتراك. يجب تضمين رمز الصفقة في طلب changePlan للحصول على السعر المخفَّض. هذه السمة اختيارية. إذا سبق أن تمت إضافة رمز صفقة إلى اشتراك، يمكن ترك هذا الحقل فارغًا وسيظل السعر المخفَّض الحالي ساريًا (إذا لم يكن فارغًا، يجب تقديم رمز الصفقة المتوفّر حاليًا في الاشتراك فقط). إذا لم تتم إضافة رمز صفقة إلى اشتراك وتركت هذا الحقل فارغًا، سيتم تطبيق الأسعار العادية.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],null,["# Method: subscriptions.changePlan\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- [ChangePlanRequest](#ChangePlanRequest)\n - [JSON representation](#ChangePlanRequest.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nUpdates a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments.\n\nHow a plan is updated differs depending on the plan and the products. For more information, see the description in [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#update_subscription_plan).\n\n### HTTP request\n\n`POST https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changePlan`\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 contains an instance of [ChangePlanRequest](/workspace/admin/reseller/reference/rest/v1/subscriptions/changePlan#ChangePlanRequest).\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).\n\nChangePlanRequest\n-----------------\n\nJSON template for the subscriptions.changePlan rpc request.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"planName\": string, \"seats\": { object (/workspace/admin/reseller/reference/rest/v1/subscriptions#Seats) }, \"purchaseOrderId\": string, \"dealCode\": string } ``` |\n\n| Fields ||\n|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the resource as a subscription change plan request. Value: `subscriptions#changePlanRequest` |\n| `planName` | `string` The `planName` property is required. This is the name of the subscription's payment plan. For more information about the Google payment plans, see [API concepts](https://developers.google.com/workspace/admin/reseller/v1/how-tos/concepts.html). Possible values are: - `ANNUAL_MONTHLY_PAY` - The annual commitment plan with monthly payments **Caution:** `ANNUAL_MONTHLY_PAY` is returned as `ANNUAL` in all API responses. - `ANNUAL_YEARLY_PAY` - The annual commitment plan with yearly payments - `FLEXIBLE` - The flexible plan - `TRIAL` - The 30-day free trial plan \u003cbr /\u003e |\n| `seats` | `object (`[Seats](/workspace/admin/reseller/reference/rest/v1/subscriptions#Seats)`)` This is a required property. The seats property is the number of user seat licenses. |\n| `purchaseOrderId` | `string` This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a `purchaseOrderId` value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. |\n| `dealCode` | `string` Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in `changePlan` request in order to receive discounted rate. This property is optional. If a deal code has already been added to a subscription, this property may be left empty and the existing discounted rate will still apply (if not empty, only provide the deal code that is already present on the subscription). If a deal code has never been added to a subscription and this property is left blank, regular pricing will apply. |"]]
