REST Resource: subscriptions

संग्रह की मदद से व्यवस्थित रहें अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.

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

सदस्यता के लिए 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 का रीड-ओनली बाहरी डिसप्ले नाम. SKU के नाम, Google के विवेक के हिसाब से बदले जा सकते हैं. एपीआई के इस वर्शन में उपलब्ध प्रॉडक्ट और 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)

साल भर के प्लान और #39;s के अंतराल को startTime मिलीसेकंड में. UNIX Epoch फ़ॉर्मैट का इस्तेमाल करके. Epoch कन्वर्टर का उदाहरण देखें.

plan.commitmentInterval.endTime

string (int64 format)

UNIX Epoch फ़ॉर्मैट का इस्तेमाल करके, सालाना तय किए गए सालाना प्लान's इंटरवल और#39; का 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 टेंप्लेट.

जेएसओएन के काेड में दिखाना
{
  "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 में बताए गए प्रॉडक्ट के लिए लाइसेंस असाइन किए गए उपयोगकर्ताओं की मौजूदा संख्या होती है. इस फ़ील्ड की वैल्यू, एंटरप्राइज़ लाइसेंस मैनेजर एपीआई के तरीके से मिले उपयोगकर्ताओं की संख्या के बराबर है: listForProductAndSku.

kind

string

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

रिन्यूअल सेटिंग

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

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

string

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

kind

string

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

तरीके

activate

रीसेलर के ज़रिए पहले से निलंबित की गई सदस्यता चालू करता है.

changePlan

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

changeRenewalSettings

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

changeSeats

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

delete

किसी सदस्यता को सीधे तौर पर रद्द करने, निलंबित करने या ट्रांसफ़र करने के लिए.

get

एक खास सदस्यता हासिल करता है.

insert

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

list

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

startPaidService

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

suspend

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