Method: purchases.subscriptionsv2.revoke

subscriptionsv2.revoke, उपयोगकर्ता की सदस्यता की खरीदारी रद्द करता है.

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

POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:revoke

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

पाथ पैरामीटर

पैरामीटर
packageName

string

ज़रूरी है. उस ऐप्लिकेशन का पैकेज जिसके लिए यह सदस्यता खरीदी गई थी (उदाहरण के लिए, 'com.some.thing').

token

string

ज़रूरी है. सदस्यता खरीदने पर, उपयोगकर्ता के डिवाइस को दिया गया टोकन.

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

अनुरोध के मुख्य भाग में, नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:

JSON के काेड में दिखाना
{
  "revocationContext": {
    object (RevocationContext)
  }
}
फ़ील्ड
revocationContext

object (RevocationContext)

ज़रूरी है. सदस्यता रद्द करने के बारे में ज़्यादा जानकारी.

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

अगर एपीआई सही से जुड़ जाता है, तो जवाब का मुख्य हिस्सा खाली होता है.

नमूना

अनुरोध का सैंपल यहां दिया गया है:

curl -X POST \
  'https://androidpublisher.googleapis.com/androidpublisher/v3/applications/com.example.myapp/purchases/subscriptionsv2/tokens/sample_purchase_token:revoke' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "revocationContext": {
      "proratedRefund": {}
    }
  }'

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

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

  • https://www.googleapis.com/auth/androidpublisher

RevocationContext

purchases.subscriptionsv2.revoke API का रद्द करने का कॉन्टेक्स्ट.

JSON के काेड में दिखाना
{

  // Union field RefundType can be only one of the following:
  "fullRefund": {
    object (FullRefund)
  },
  "proratedRefund": {
    object (ProratedRefund)
  },
  "itemBasedRefund": {
    object (ItemBasedRefund)
  }
  // End of list of possible types for union field RefundType.
}
फ़ील्ड
यूनियन फ़ील्ड RefundType. इससे यह तय होता है कि किस तरह का रिफ़ंड दिया जाना चाहिए. मान्य अनुरोध के हिस्से के तौर पर, रिफ़ंड का टाइप बताना ज़रूरी है. RefundType इनमें से कोई एक हो सकता है:
fullRefund

object (FullRefund)

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

proratedRefund

object (ProratedRefund)

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

itemBasedRefund

object (ItemBasedRefund)

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

FullRefund

इस टाइप में कोई फ़ील्ड नहीं है.

इसका इस्तेमाल यह तय करने के लिए किया जाता है कि RevocationContext में रिफ़ंड टाइप, पूरा रिफ़ंड है या नहीं.

ProratedRefund

इस टाइप में कोई फ़ील्ड नहीं है.

इसका इस्तेमाल यह तय करने के लिए किया जाता है कि RevocationContext में रिफ़ंड टाइप, प्रोरेटेड रिफ़ंड है या नहीं.

ItemBasedRefund

इसका इस्तेमाल यह तय करने के लिए किया जाता है कि एक से ज़्यादा आइटम वाली सदस्यता में से किस आइटम को रद्द करना है.

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

string

ज़रूरी है. अगर सदस्यता में ऐड-ऑन शामिल हैं, तो रद्द किए जाने वाले सदस्यता आइटम का प्रॉडक्ट आईडी.