استرداد & تحديث اشتراك

بعد استرداد قيمة الاشتراك، يمكنك استخدام المعلومات الواردة في الرد الناجح لتغيير حالة الاشتراك أو لتعديله. تركّز هذه الصفحة على الطرق المختلفة التي يمكنك من خلالها استرداد الاشتراك وتعديله.

استرداد اشتراك

لاسترداد اشتراك تم طلبه أو نقله بنجاح، استخدم طلب GETHTTP التالي.

GET https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID

استبدل ما يلي:

لا تحتوي هذه العملية على معلمات في نص الطلب.

تعرض الاستجابة الناجحة رمز حالة HTTP 200 وإعدادات الاشتراك. في المثال التالي على الرد، نجد أنّ السمة isInTrial هي false ولكن لا تتوفّر سمة trialEndTime، ما يعني أنّ هذا العميل لم يسبق له بدء فترة تجريبية مجانية لمدة 30 يومًا باستخدام هذه الخطة.

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "billingMethod": "ONLINE",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "RENEW_CURRENT_USERS_MONTHLY_PAY"
  },
  "purchaseOrderId": "example.com_annual_1",
  "status": "ACTIVE",
  "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
  "skuName": "Google Workspace Business Standard"
}

استرداد جميع الاشتراكات لعميل

لاسترداد جميع اشتراكات عميل مورّد محدّد والتي تمت طلبها أو نقلها بنجاح، استخدِم طلب HTTP GET التالي وضمِّن الرمز المميز للتفويض:

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID value&pageToken=START_DATE&maxResults=MAX_NUMBER

استبدل ما يلي:

  • CUSTOMER_ID: إما اسم النطاق الأساسي للعميل أو المعرّف الفريد للعميل
  • START_DATE: تاريخ البدء بالتنسيق YYYY-MM-DD.
  • MAX_NUMBER: الحد الأقصى لعدد النتائج التي يتم عرضها في صفحة الردّ

لا تحتوي هذه العملية على معلمات في نص الطلب.

تعرض الاستجابة الناجحة رمز حالة HTTP 200 وقائمة باشتراكات العميل وإعداداته. قد تتضمن قائمة الاشتراكات منتجات لا تتم إدارتها في هذا الإصدار من واجهة برمجة تطبيقات المورّد.

إذا لم تكن تدير هذا العميل وكان غير مُدار، فسيتم عرض خطأ 403 "Forbidden".

استرداد جميع الاشتراكات القابلة للتحويل للعميل

لاسترداد جميع اشتراكات العميل التي يُحتمل نقلها إلى إدارة المورِّد، استخدِم طلب HTTP GET التالي وضمِّن الرمز المميز للتفويض. يجب توفير customerId، وهو المعرّف الفريد للعميل الذي يتم عرضه عند استرداد حساب عميل التوريد. customerAuthToken هو رمز مميّز للنقل يوفّره العميل وخاصًّا بمعرّف المورّد. بعد أن ينشئها العميل، تكون صالحة لمدة 30 يومًا. لمزيد من المعلومات حول كيفية إنشاء العملاء للرمز المميّز، يُرجى الاطّلاع على نقل حسابك على Google Workspace إلى أحد المورِّدين.

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID&customerAuthToken=AUTH_TOKEN&pageToken=START_DATE&maxResults=MAX_NUMBER

استبدل ما يلي:

  • CUSTOMER_ID: إما اسم النطاق الأساسي للعميل أو المعرّف الفريد للعميل
  • AUTH_TOKEN: رمز مميز للنقل يوفّره العميل وخاص بمعرّف المورّد. بعد أن ينشئه العميل، يكون صالحًا لمدة 30 يومًا. لمزيد من المعلومات حول كيفية إنشاء العملاء للرمز المميّز، يُرجى الاطّلاع على المقالة نقل حسابك على Google Workspace إلى أحد المورِّدين. إذا كانت هذه القيمة غير صالحة أو انتهت صلاحيتها، ستعرض استجابة واجهة برمجة التطبيقات خطأ 403 "Forbidden".
  • START_DATE: تاريخ البدء بالتنسيق YYYY-MM-DD.
  • MAX_NUMBER: الحد الأقصى لعدد النتائج التي يتم عرضها في صفحة الردّ

لا تحتوي هذه العملية على معلمات في نص الطلب.

تعرض الاستجابة الناجحة رمز حالة HTTP 200 وقائمة باشتراكات العميل القابلة للتحويل مع تاريخ انتهاء صلاحية الرمز المميّز للنقل والحد الأدنى لعدد تراخيص المستخدمين اللازمة في طلب النقل. قد يمتلك العميل اشتراكات إضافية غير قابلة للنقل.

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "432",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1331647980142",
      "plan": {
        "planName": "ANNUAL",
        "isCommitmentPlan": true,
        "commitmentInterval": {
          "startTime": "1331647980142",
          "endTime": "1363183980142"
        }
      },
      "seats": {
        "kind": "subscriptions#seats",
        "numberOfSeats": 10,
        "maximumNumberOfSeats": 500,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183980142",
        "minimumTransferableSeats": "20"
      },
      "purchaseOrderId": "PO_890",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "140",
      "skuId": "1010020028",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183780159",
        "minimumTransferableSeats": "10"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

إذا كنت تخطط لنقل هذه الاشتراكات باستخدام العملية المجمّعة، عليك نقل جميع الاشتراكات. يؤدي نقل كل اشتراك واحدًا تلو الآخر إلى حدوث خطأ. بالإضافة إلى ذلك، لا تنقل العملية المجمّعة سوى الاشتراكات التي تحمل الحالة ACTIVE. لمزيد من المعلومات، يمكنك الاطّلاع على نقل اشتراك.

استرداد جميع اشتراكات المورّدين

لاسترداد جميع الاشتراكات التي طلبها أو نقلها المورّد بنجاح، استخدِم طلب HTTP GET التالي وضمِّن الرمز المميّز للتفويض.

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=PREFIX &pageToken=TOKEN&maxResults=MAX_NUMBER

استبدل ما يلي:

  • PREFIX: بداية اسم العميل الذي تبحث عن اشتراكاته.
  • TOKEN: رمز مميز يحدد صفحة معينة من النتائج التي يجب أن يعرضها الخادم.
  • MAX_NUMBER: الحد الأقصى لعدد النتائج التي يتم عرضها في صفحة الردّ

يمكن أن تستخدم هذه العملية نطاق وصول OAuth للقراءة فقط. تُعد customerNamePrefix وpageToken وmaxResults سلاسل طلبات بحث اختيارية.

يسترد المثال التالي جميع اشتراكات المورد التي تنتمي إلى العملاء الذين يبدأ أسماؤهم بـ "الاختبار":

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=exam

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "C0123456",
      "subscriptionId": "123",
      "skuId": "1010020028",
      "creationTime": "1331647980142",
      "billingMethod": "ONLINE",
      "plan": {
        "planName": "ANNUAL",
        "isCommitmentPlan": true,
        "commitmentInterval": {
          "startTime": "1331647980142",
          "endTime": "1363183980142"
        }
      },
      "seats": {
        "kind": "subscriptions#seats",
        "numberOfSeats": 10,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "purchaseOrderId": "PO_135",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-5678",
      "subscriptionId": "1404686",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "AUTO_RENEW"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

تعديل خطة اشتراك

يختلف تعديل خطط Google Workspace حسب الخطة. قبل تحديث الخطة، ضع في اعتبارك ما يلي:

  • عندما تنشئ اشتراكًا ويكون العميل مؤهلاً، يمكن أن تكون خطة الاشتراك تجريبية لمدة 30 يومًا. يمكن أن تكون كل من خطط الدفع بنظام الاشتراك المرن والسنوي عبارة عن فترات تجريبية مجانية لمدة 30 يومًا. أثناء الفترة التجريبية، يمكنك تغيير خطة دفع الاشتراك إلى خطط اشتراك مرنة أو سنوية حسب الحاجة. وبعد انتهاء الفترة التجريبية وتفعيل الخطة، يطبّق تعديل الخطة القواعد نفسها المتّبعة في خطط الاشتراكات الأخرى النشطة. ولنقل الاشتراك التجريبي على الفور إلى خطة نشطة، يمكنك بدء خدمة مدفوعة من اشتراك يتضمّن فترة تجريبية مجانية لمدة 30 يومًا. لمزيد من المعلومات عن الفترة التجريبية لمدة 30 يومًا وقواعد تأهيل العملاء، راجع مركز مساعدة الإدارة.

  • يمكنك تعديل خطة مرنة إلى خطة اشتراك سنوي.

  • لا يمكنك تعديل خطة اشتراك سنوي.

  • لا تتوافق بعض الخطط مع بعض المنتجات. لمزيد من المعلومات حول المنتجات التي تستخدمها هذه الخطط، يمكنك مراجعة المنتجات ورموز التخزين التعريفية.

لتعديل خطة من أجل فترة تجريبية مدتها 30 يومًا أو اشتراك في خطة مرنة إلى خطة اشتراك سنوي، استخدِم طلب HTTP POST التالي:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changePlan

استبدل ما يلي:

في المثال التالي، يتم تعديل الاشتراك باستخدام السمة subscriptionId بالقيمة 123. العنوان customerId هو C0123456.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changePlan

يحتوي نص الطلب على ما يلي:

{
  "kind": "reseller#changePlanRequest",
  "planName": "ANNUAL_MONTHLY_PAY",
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10
  },
  "purchaseOrderId": "123_March2012"
}

تعرض الاستجابة الناجحة رمز حالة HTTP 201 وتعرض الإعدادات المعدَّلة لخطة الاشتراك:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "purchaseOrderId": "123_March2012",
  "status": "ACTIVE",
  "skuName": "Google Workspace Business Standard"
}

تعديل مقاعد أحد الاشتراكات

يستخدم تحديث اشتراك خطة الاشتراك السنوي خصائص اشتراك مختلفة عن تحديث اشتراك خطة Google Workspace المرنة.

تعديل المقاعد في اشتراك الخطة السنوية

لتعديل إعدادات ترخيص المستخدم لاشتراك خطة سنوية، استخدِم طلب HTTP POST التالي:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeSeats

استبدل ما يلي:

في المثال التالي، يتم تعديل الاشتراك باستخدام subscriptionId123. العنوان customerId هو C0123456. يختلف نص الطلب حسب نوع الخطة:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats

يستخدم اشتراك خطة الاشتراك السنوي في Google Workspace نص الطلب هذا لتعديل عدد تراخيص المستخدمين. وتُعدّ القيمة numberOfSeats مجموعًا. على سبيل المثال، إذا كان لديك في السابق 10 تراخيص مستخدمين وكان لديك طلب من عميل للحصول على 5 تراخيص جديدة، سيكون الإجمالي في نص الطلب numberOfSeats هو 15، كما هو موضّح في المثال التالي:

{
    "kind": "subscriptions#seats",
    "numberOfSeats": 15
}

تعديل تراخيص المستخدمين للاشتراك في الخطة المرنة

يستخدم اشتراك الخطة المرنة في Google Workspace نص الطلب لتعديل تراخيص المستخدمين. تشير قيمة maximumNumberOfSeats إلى إجمالي التراخيص الحالية والتراخيص الجديدة. هذا هو الحد الأقصى لعدد تراخيص المستخدم التي يمكن للحساب توفيرها.

{
  "kind": "subscriptions#seats",
  "maximumNumberOfSeats": 15
}

تعرض الاستجابة الناجحة رمز حالة HTTP 201 وإعدادات ترخيص الاشتراك المعدَّلة:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "FLEXIBLE",
    "isCommitmentPlan": false
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 15,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "skuName": "Google Workspace Business Standard"
}

تعديل إعدادات تجديد اشتراك

لتعديل إعدادات تجديد اشتراك سنوي، استخدِم طلب HTTP POST التالي:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeRenewalSettings

استبدل ما يلي:

في ما يلي مثال على نص الطلب:

{
  "kind": "subscriptions#renewalSettings",
  "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}

يمكن أن تكون قيمة السمة renewalType أيًا مما يلي:

  • AUTO_RENEW_YEARLY_PAY: في نهاية المدة الزمنية لخطة الاشتراك السنوي، يمكنك تجديد خطة الاشتراك تلقائيًا باسم ANNUAL_YEARLY_PAY باستخدام numberOfSeats.
  • AUTO_RENEW_MONTHLY_PAY: في نهاية الفاصل الزمني لخطة الاشتراك السنوي، يمكنك تجديد خطة الاشتراك تلقائيًا باسم ANNUAL_MONTHLY_PAY باستخدام numberOfSeats نفسه.
  • RENEW_CURRENT_USERS_YEARLY_PAY: في نهاية الفاصل الزمني لخطة الاشتراك السنوي، يمكنك تجديد خطة الاشتراك باستخدام ANNUAL_YEARLY_PAY مع استخدام إجمالي عدد تراخيص المستخدمين النشطة الحالية. هذا هو الإعداد الافتراضي لخطط الاشتراك السنوية النشطة (التي يتم دفع رسومها سنويًا).
  • RENEW_CURRENT_USERS_MONTHLY_PAY: في نهاية الفاصل الزمني لخطة الاشتراك السنوي، يمكنك تجديد خطة الاشتراك باستخدام ANNUAL_MONTHLY_PAY مع استخدام إجمالي عدد تراخيص المستخدمين النشطة الحالية. هذا هو الإعداد التلقائي لخطط الاشتراك السنوية النشطة (التي تُدفع شهريًا).
  • RENEW_ON_PROPOSED_OFFER: في نهاية الفاصل الزمني لخطة الاشتراك الحالية، يمكنك التجديد بناءً على آخر اقتراح تجديد يتضمّن عدد تراخيص المستخدمين النشطين الحالية أو عدد تراخيص الاشتراك المقترَح، أيهما أكبر.
  • SWITCH_TO_PAY_AS_YOU_GO: في نهاية الفاصل الزمني لخطة الاشتراك السنوي، يمكنك تغيير خطة الاشتراك السنوي إلى خطة مرنة.
  • CANCEL: في نهاية الفترة الزمنية لخطة الاشتراك السنوي، يتم تعليق الاشتراك. لفهم كيفية رفع التعليق، راجع مركز مساعدة الإدارة.

تعرض الاستجابة الناجحة رمز حالة HTTP 201 وإعدادات تجديد الاشتراك المعدَّلة:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

بدء خدمة مدفوعة من اشتراك يتضمّن فترة تجريبية مجانية

لنقل اشتراك الفترة التجريبية المجانية لمدة 30 يومًا على الفور إلى اشتراك خدمة مدفوعة، إذا تم إعداد خطة دفع بالفعل للاشتراك في الفترة التجريبية، استخدم طلب HTTP POST التالي.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/startPaidService

استبدل ما يلي:

يحتوي المثال التالي على C0123456 باعتباره customerId وقيمة subscriptionId التي تبلغ 123:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/startPaidService

لا تحتوي هذه العملية على معلمات في نص الطلب.

تعرض الاستجابة الناجحة رمز حالة HTTP 201 وإعدادات الاشتراك المعدَّلة:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

ترقية الاشتراك أو الرجوع إلى إصدار سابق منه

لا يمكنك الرجوع إلى إصدار سابق من الخطط السنوية في منتصف المدة، أو تحديد موعد الاشتراك في خطة أقلّ كلفة باستخدام إعدادات التجديد. ننصحك بضبط إعدادات التجديد للتبديل إلى "FLEXIBLE" ثم الرجوع إلى إصدار سابق بعد وقت التجديد.

لترقية الاشتراك أو الرجوع إلى إصدار سابق منه، يمكنك إنشاء اشتراك جديد من خلال skuId الذي تريد الترقية إليه أو الرجوع إلى إصدار سابق منه.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions

استبدل ما يلي:

  • CUSTOMER_ID: إما اسم النطاق الأساسي للعميل أو المعرّف الفريد للعميل

تؤدي هذه المكالمة إلى إنهاء الاشتراك السابق وإنشاء اشتراك جديد.

يمكنك العثور على مزيد من المعلومات حول عمليات الترقية والرجوع إلى إصدار سابق في صفحة "المنتجات ورموز التخزين التعريفية".