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 फ़ॉर्मैट का इस्तेमाल करके, मिलीसेकंड में होता है. 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)

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

string (int64 format)

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

object

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

boolean

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

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

string (int64 format)

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

object

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

string (int64 format)

ट्रांसफ़र टोकन या ट्रांसफ़र के इंटेंट की समयसीमा खत्म होने का समय. समय, UNIX Epoch फ़ॉर्मैट का इस्तेमाल करके मिलीसेकंड में होता है.
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

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