Method: subscriptions.delete

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

एचटीटीपी अनुरोध

DELETE https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

पाथ पैरामीटर

पैरामीटर
customerId

string

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

subscriptionId

string

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

क्वेरी पैरामीटर

पैरामीटर
deletionType

enum (DeletionType)

deletionType क्वेरी स्ट्रिंग की मदद से, सदस्यता को रद्द किया जा सकता है, डाउनग्रेड किया जा सकता है या निलंबित किया जा सकता है.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

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

इस मैसेज का इस्तेमाल अनुरोध और जवाब में एपीआई के स्ट्रीमिंग और बिना स्ट्रीमिंग वाले दाेनाें तरीकों में किया जा सकता है.

इसका इस्तेमाल टॉप-लेवल के अनुरोध फ़ील्ड के रूप में किया जा सकता है. अगर कोई व्यक्ति यूआरएल या एचटीटीपी टेम्प्लेट से पैरामीटर को अनुरोध फ़ील्ड में लाना और मूल एचटीटीपी के मुख्य भाग का इस्तेमाल करना चाहता है, ताे इसके लिए भी यह अच्छा विकल्प है.

उदाहरण:

message GetResourceRequest {
  // A unique request id.
  string requestId = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc GetResource(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

स्ट्रीमिंग के तरीकाें के साथ उदाहरण:

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

स्ट्रीमिंग के इस प्रकार का इस्तेमाल सिर्फ़ तब बदलता है जब अनुरोध और जवाब के मुख्य में बदलाव हाेता है. बाकी सभी सुविधाएं वैसे ही काम करती हैं.

अगर अनुरोध पूरा हो जाता है, तो रिस्पॉन्स एक सामान्य एचटीटीपी रिस्पॉन्स होता है. इसका फ़ॉर्मैट, तरीके के हिसाब से तय होता है.

JSON के काेड में दिखाना
{
  "contentType": string,
  "data": string,
  "extensions": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
फ़ील्ड
contentType

string

एचटीटीपी Content-Type हेडर की वैल्यू, जो बॉडी के कॉन्टेंट टाइप के बारे में बताती है.

data

string (bytes format)

एचटीटीपी अनुरोध/जवाब का मुख्य हिस्सा, रॉ बाइनरी के तौर पर.

base64 कोड में बदली गई स्ट्रिंग.

extensions[]

object

ऐप्लिकेशन के जवाब का खास मेटाडेटा. स्ट्रीमिंग एपीआई के लिए पहले जवाब में सेट किया जाना चाहिए.

ऐसा ऑब्जेक्ट जिसमें किसी भी तरह के फ़ील्ड शामिल हो सकते हैं. एक अन्य फ़ील्ड "@type" में, टाइप की पहचान करने वाला यूआरआई होता है. उदाहरण: { "id": 1234, "@type": "types.example.com/standard/id" }.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/apps.order

ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.

DeletionType

Enums
deletion_type_undefined
cancel सदस्यता तुरंत रद्द कर देता है. यह G Suite की सदस्यता पर लागू नहीं होता.
transfer_to_direct

सदस्यता को सीधे Google पर ट्रांसफ़र करता है.  ग्राहक को तुरंत Google के साथ सीधे बिलिंग रिलेशनशिप में ट्रांसफ़र कर दिया जाता है. साथ ही, उसे कुछ समय के लिए सेवा में कोई रुकावट नहीं आती. इसके बाद, ग्राहक क्रेडिट कार्ड का इस्तेमाल करके, सीधे Google के साथ बिलिंग सेट अप कर सकता है. इसके अलावा, वह किसी दूसरे रीसेलर के पास भी अपना खाता ट्रांसफ़र कर सकता है.