REST Resource: subscriptions

संसाधन: सदस्यता

सदस्यता के लिए JSON टेंप्लेट.

JSON के काेड में दिखाना 
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer,
    "currentLegacySkuId": string
  }
}
फ़ील्ड
customerId

string

यह प्रॉपर्टी, Google से जनरेट किए गए यूनीक आइडेंटिफ़ायर के तौर पर, रिस्पॉन्स में हमेशा दिखेगी. अनुरोध में, यह प्रॉपर्टी प्राइमरी डोमेन या Google से जनरेट किया गया यूनीक आइडेंटिफ़ायर हो सकती है.
subscriptionId

string

subscriptionId, सदस्यता का आइडेंटिफ़ायर है और यह हर ग्राहक के लिए यूनीक होता है. यह एक ज़रूरी प्रॉपर्टी है. सदस्यता अपडेट होने पर subscriptionId बदल जाता है. इसलिए, हमारा सुझाव है कि इस आईडी को, हमेशा सेव रहने वाले डेटा के लिए कुंजी के तौर पर इस्तेमाल न करें. subscriptionId का इस्तेमाल, रीसेलर की सभी सदस्यताएं वापस पाना में बताए गए तरीके से करें.
skuId

string

यह एक ज़रूरी प्रॉपर्टी है. skuId, सदस्यता में किसी ग्राहक को असाइन किए गए प्रॉडक्ट के SKU के लिए एक यूनीक सिस्टम आइडेंटिफ़ायर है. एपीआई के इस वर्शन में उपलब्ध प्रॉडक्ट और SKU के बारे में जानने के लिए, प्रॉडक्ट और SKU आईडी देखें.
creationTime

string (int64 format)

creationTime प्रॉपर्टी, सदस्यता बनाने की तारीख होती है. यह Epoch फ़ॉर्मैट में मिलीसेकंड में होता है. एपॉच कन्वर्टर का उदाहरण देखें.
kind

string

संसाधन को सदस्यता के तौर पर पहचानता है. मान: reseller#subscription
seats

object (Seats)

यह एक ज़रूरी प्रॉपर्टी है. प्लान में उपयोगकर्ता सीट के लाइसेंस की संख्या और सीमा.
renewalSettings

object (RenewalSettings)

सालाना प्लान के लिए रिन्यूअल की सेटिंग. ज़्यादा जानकारी के लिए, एडमिन सहायता केंद्र में रिन्यूअल के विकल्प देखें.
purchaseOrderId

string

यह प्रॉपर्टी ज़रूरी नहीं है. खरीदारी के ऑर्डर (पीओ) की यह जानकारी, रीसेलर के लिए है. वे इसका इस्तेमाल अपनी कंपनी के ट्रैकिंग इस्तेमाल के लिए कर सकते हैं. अगर purchaseOrderId वैल्यू दी जाती है, तो वह एपीआई के जवाबों में दिखती है और इनवॉइस में दिखती है. इस प्रॉपर्टी में ज़्यादा से ज़्यादा 80 सादे टेक्स्ट वर्ण डाले जा सकते हैं.
status

string

यह प्रॉपर्टी ज़रूरी नहीं है.
resourceUiUrl

string

Admin console में, ग्राहक के सदस्यता पेज का यूआरएल. रीड-ओनली यूआरएल, एपीआई सेवा से जनरेट होता है. इसका इस्तेमाल तब किया जाता है, जब आपके क्लाइंट ऐप्लिकेशन में खरीदार को Admin console के सदस्यता पेज का इस्तेमाल करके कोई टास्क पूरा करना हो.
billingMethod

string

सिर्फ़ पढ़ने के लिए उपलब्ध फ़ील्ड, जो किसी सदस्यता के लिए बिलिंग का मौजूदा तरीका दिखाता है.
suspensionReasons[]

string

सिर्फ़ पढ़ने के लिए उपलब्ध फ़ील्ड, जिसमें सदस्यता के निलंबन की सभी मौजूदा वजहों की सूची होती है. किसी सदस्यता को निलंबित करने की कई वजहें हो सकती हैं. जब तक निलंबन की सभी प्रक्रियाएं पूरी नहीं हो जातीं, तब तक सदस्यता का STATUS SUSPENDED रहेगा.

संभावित विकल्पों में ये शामिल हैं:

  • PENDING_TOS_ACCEPTANCE - ग्राहक ने लॉग इन नहीं किया है और G Suite की फिर से बेची जाने वाली सदस्यता की सेवा की शर्तें स्वीकार नहीं की हैं.
  • RENEWAL_WITH_TYPE_CANCEL - ग्राहक की जवाबदेही खत्म हो गई और उसकी सेवा की अवधि खत्म होने पर उसे रद्द कर दिया गया.
  • RESELLER_INITIATED - रीसेलर ने मैन्युअल तरीके से निलंबन किया है.
  • TRIAL_ENDED - ग्राहक ने कोई प्लान नहीं चुना और ट्रायल की अवधि खत्म हो गई.
  • OTHER - Google की किसी अंदरूनी वजह (जैसे, गलत इस्तेमाल या अन्य) से ग्राहक का खाता निलंबित किया गया है.

customerDomain

string

ग्राहक का प्राइमरी डोमेन नेम
dealCode

string

सदस्यता प्लान पर छूट वाली कीमत के लिए, Google से मिला कोड (ज़्यादा से ज़्यादा 100 वर्ण). छूट वाली कीमत पाने के लिए, insert अनुरोधों में डील कोड शामिल करना ज़रूरी है. इस प्रॉपर्टी को सबमिट करना ज़रूरी नहीं है. अगर इसे खाली छोड़ा जाता है, तो सामान्य कीमत लागू होती है.
skuName

string

सदस्यता में किसी ग्राहक को असाइन किए गए प्रॉडक्ट के SKU के लिए, बाहरी डिसप्ले का नाम. यह नाम सिर्फ़ पढ़ने के लिए होता है. Google अपनी समझदारी, सूझ-बूझ या विवेक से, SKU के नामों में बदलाव कर सकता है. एपीआई के इस वर्शन में उपलब्ध प्रॉडक्ट और SKU के बारे में जानने के लिए, प्रॉडक्ट और SKU आईडी देखें.
plan

object

plan प्रॉपर्टी ज़रूरी है. एपीआई के इस वर्शन में, G Suite के प्लान में फ़्लेक्सिबल प्लान, सालाना प्लान, और 30 दिनों के लिए मुफ़्त में आज़माने का प्लान शामिल है. एपीआई के पेमेंट प्लान के बारे में ज़्यादा जानकारी के लिए, एपीआई के कॉन्सेप्ट देखें.
plan.planName

string

planName प्रॉपर्टी ज़रूरी है. यह सदस्यता के प्लान का नाम है. Google के पेमेंट प्लान के बारे में ज़्यादा जानने के लिए, एपीआई के कॉन्सेप्ट देखें.

इनमें से कोई वैल्यू इस्तेमाल की जा सकती है:

  • ANNUAL_MONTHLY_PAY — सालाना प्लान, जिसके लिए हर महीने पैसे चुकाने होते हैं.
  • ANNUAL_YEARLY_PAY — सालाना शुल्क चुकाकर ली जाने वाली सदस्यता का प्लान
  • FLEXIBLE — ज़रूरत के हिसाब से प्लान
  • TRIAL — 30 दिनों तक मुफ़्त में आज़माने की सुविधा वाला प्लान. अगर पेमेंट का कोई प्लान असाइन नहीं किया जाता है, तो बिना किसी शुल्क के आज़माने की सुविधा वाले 30 दिनों के बाद, सदस्यता निलंबित कर दी जाएगी. changePlan को कॉल करने पर, मुफ़्त में आज़माने के लिए पेमेंट प्लान असाइन हो जाएगा. हालांकि, प्लान चालू नहीं होगा. बिना किसी शुल्क के आज़माने की अवधि के 30वें दिन या startPaidService को कॉल करने के तुरंत बाद, सदस्यता के लिए चुना गया पेमेंट प्लान अपने-आप शुरू हो जाएगा.
  • FREE — मुफ़्त प्लान, सिर्फ़ Cloud Identity SKU के लिए उपलब्ध है. इसके लिए, कोई शुल्क नहीं लिया जाता.

plan.isCommitmentPlan

boolean

isCommitmentPlan प्रॉपर्टी की बूलियन वैल्यू से पता चलता है कि प्लान, सालाना प्लान है:

  • true — सदस्यता का प्लान, सालाना प्लान है.
  • false — यह प्लान, सालाना प्लान नहीं है.
plan.commitmentInterval

object

एपीआई के इस वर्शन में, सालाना प्लान के लिए एक साल का इंटरवल है.

plan.commitmentInterval.startTime

string (int64 format)

यूनिक्स एपिक फ़ॉर्मैट का इस्तेमाल करके, सालाना कमिटमेंट प्लान के इंटरवल का startTime मिलीसेकंड में. एपॉच कन्वर्टर का उदाहरण देखें.
plan.commitmentInterval.endTime

string (int64 format)

सालाना कमिटमेंट प्लान का इंटरवल endTime, जो यूनिक्स इकोपॉइंट फ़ॉर्मैट में मिलीसेकंड में होता है. एपॉच कन्वर्टर का उदाहरण देखें.
trialSettings

object

G Suite के सालाना प्लान और ज़रूरत के हिसाब से चुने जा सकने वाले पेमेंट प्लान को 30 दिनों के लिए मुफ़्त में आज़माया जा सकता है. ज़्यादा जानकारी के लिए, एपीआई के कॉन्सेप्ट देखें.
trialSettings.isInTrial

boolean

यह तय करता है कि सदस्यता के प्लान को 30 दिनों के लिए मुफ़्त में आज़माया जा सकता है या नहीं:

  • true — प्लान को मुफ़्त में आज़माया जा रहा है.
  • false — प्लान को मुफ़्त में आज़माने की सुविधा उपलब्ध नहीं है.
trialSettings.trialEndTime

string (int64 format)

मुफ़्त में आज़माने की अवधि खत्म होने की तारीख. वैल्यू, UNIX Epoch फ़ॉर्मैट में मिलीसेकंड में होती है. एपॉच कन्वर्टर का उदाहरण देखें.
transferInfo

object

सदस्यता के लिए, ट्रांसफ़र से जुड़ी जानकारी, जिसे सिर्फ़ पढ़ा जा सकता है. ज़्यादा जानकारी के लिए, किसी ग्राहक की ट्रांसफ़र की जा सकने वाली सदस्यताएं वापस पाना लेख पढ़ें.
transferInfo.transferabilityExpirationTime

string (int64 format)

ट्रांसफ़र टोकन या ट्रांसफ़र करने के इंटेंट की समयसीमा खत्म होने का समय. समय, यूनिक्स इकोपॉइंट फ़ॉर्मैट में मिलीसेकंड में होता है.
transferInfo.minimumTransferableSeats

integer

सदस्यता डालते समय, इस प्रॉडक्ट के लिए ट्रांसफ़र ऑर्डर में दी गई सीटों की कम से कम संख्या यह होती है. उदाहरण के लिए, अगर ग्राहक के पास 20 उपयोगकर्ता हैं, तो रीसेलर 15 सीटों का ट्रांसफ़र ऑर्डर नहीं दे सकता. कम से कम 20 सीटें होनी चाहिए.
transferInfo.currentLegacySkuId

string

फिर से बेची गई मौजूदा सदस्यता का skuId. यह सिर्फ़ तब पॉप्युलेट होता है, जब ग्राहक के पास लेगसी SKU वाली सदस्यता हो और सदस्यता के संसाधन में, ट्रांसफ़र के लिए सुझाए गए SKU का skuId शामिल हो.

सीटें

सदस्यता की सीटों के लिए JSON टेंप्लेट.

JSON के काेड में दिखाना 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
फ़ील्ड
numberOfSeats

integer

यह ज़रूरी प्रॉपर्टी है. यह सिर्फ़ ANNUAL_MONTHLY_PAY और ANNUAL_YEARLY_PAY प्लान वाली सदस्यताओं के लिए है. इस प्रॉपर्टी से, यह तय होता है कि किसी सदस्यता के लिए उपयोगकर्ताओं को ज़्यादा से ज़्यादा कितने लाइसेंस असाइन किए जा सकते हैं. रीसेलर ज़्यादा लाइसेंस जोड़ सकता है. हालांकि, लाइसेंस की संख्या सेट करने के बाद, उसे रिन्यूअल होने तक कम नहीं किया जा सकता.numberOfSeats numberOfSeats वैल्यू के आधार पर, रीसेलर को इनवॉइस भेजा जाता है. भले ही, इनमें से कितने उपयोगकर्ता लाइसेंस असाइन किए गए हों.

maximumNumberOfSeats

integer

यह ज़रूरी प्रॉपर्टी है. यह सिर्फ़ FLEXIBLE या TRIAL प्लान वाली सदस्यताओं के लिए है. इस प्रॉपर्टी से, किसी सदस्यता के लिए लाइसेंस वाले उपयोगकर्ताओं की ज़्यादा से ज़्यादा संख्या तय होती है. इस संख्या को रीसेलर के अनुबंध में तय की गई ज़्यादा से ज़्यादा सीमा तक बढ़ाया जा सकता है. कम से कम संख्या, ग्राहक खाते में मौजूद उपयोगकर्ताओं की मौजूदा संख्या है.

licensedNumberOfSeats

integer

रीड-ओनली फ़ील्ड, जिसमें उन उपयोगकर्ताओं की मौजूदा संख्या होती है जिन्हें skuId में बताए गए प्रॉडक्ट का लाइसेंस असाइन किया गया है. इस फ़ील्ड की वैल्यू, Enterprise License Manager API के तरीके से मिले उपयोगकर्ताओं की संख्या के बराबर होती है: listForProductAndSku.
kind

string

इस एट्रिब्यूट की मदद से, संसाधन को सदस्यता की सीट की सेटिंग के तौर पर पहचाना जाता है. मान: subscriptions#seats

RenewalSettings

सदस्यता के रिन्यूअल की सेटिंग के लिए JSON टेंप्लेट.

JSON के काेड में दिखाना 
{
  "renewalType": string,
  "kind": string
}
फ़ील्ड
renewalType

string

सालाना प्लान के लिए रिन्यूअल की सेटिंग. ज़्यादा जानकारी के लिए, एडमिन सहायता केंद्र में रिन्यूअल के विकल्प देखें. सदस्यता रिन्यू करते समय, renewalType प्रॉपर्टी की वैल्यू देना ज़रूरी है.
kind

string

इससे संसाधन की पहचान, सदस्यता रिन्यूअल सेटिंग के तौर पर होती है. मान: subscriptions#renewalSettings

तरीके

activate

 रीसेलर ने जिस सदस्यता को निलंबित किया था उसे चालू करता है.

changePlan

 सदस्यता प्लान को अपडेट करता है.

changeRenewalSettings

 उपयोगकर्ता के लाइसेंस के रिन्यूअल की सेटिंग अपडेट करता है.

changeSeats

 सदस्यता के उपयोगकर्ता लाइसेंस की सेटिंग अपडेट करता है.

delete

 सदस्यता को रद्द करता है, निलंबित करता है या डायरेक्ट में ट्रांसफ़र करता है.

get

 किसी खास सदस्यता को पाने पर.

insert

 सदस्यता बनाता है या ट्रांसफ़र करता है.

list

 रीसेलर के ज़रिए मैनेज की जाने वाली सदस्यताओं की सूचियां.

startPaidService

 30 दिनों के मुफ़्त ट्रायल की सदस्यता को, पैसे चुकाकर ली जाने वाली सदस्यता में तुरंत बदलें.

suspend

 किसी चालू सदस्यता को निलंबित करता है.