दस्तावेज़ पर जाएँ
API

उपयोग के अनुसार भुगतान चालू या बंद करें

प्लान और बिलिंग का स्विच, और वह कार्ड जो उसे पहली बार चाहिए।

PATCH/billing/pay-as-you-go

2 कॉल में से कोई भी आपके वर्कस्पेस पर चलाता है।

PATCH /billing/pay-as-you-go

प्लान और बिलिंग का स्विच, और वह कार्ड जो उसे पहली बार चाहिए।

उदाहरण

billing:write चाहिए। बंद करना तुरंत लागू होता है, और उपयोग कोटे पर रुक जाता है। कार्ड सहेजा हो तो चालू करना तुरंत लागू होता है। पहली बार checkoutUrl एक लिंक है जहाँ व्यक्ति कार्ड जोड़ता है, और ऐसा करते ही उपयोग के अनुसार भुगतान शुरू होता है। theme और locale उस पेज की शैली तय करते हैं जिसे लिंक खोलता है।

curl
curl -X PATCH "$OE/billing/pay-as-you-go" -H "$AUTH" -H 'content-type: application/json' \  -d '{ "enabled": true, "locale": "de" }'
प्रतिक्रिया
{  "object": "pay_as_you_go_switch",  "enabled": false,  "suspended": false,  "activating": false,  "checkoutUrl": "https://checkout.example.com/c/7Yw2kq9RzX4mB1vN?locale=de"}

API से कुछ भी भुगतान नहीं होता। लिंक भुगतान प्रदाता का पेज खोलता है, जहाँ व्यक्ति भुगतान करता है, कार्ड बदलता है या रद्द करता है, जैसे वह ऐप से करता है।

OAuth एक्सेस टोकन को इस कॉल के लिए सत्यापन कोड चाहिए। जब तक ऐप पिछले 60 मिनट में कोई कोड सत्यापित न कर ले, कॉल 403 step_up_required लौटाती है और कुछ नहीं बदलती। API कुंजी से कभी नहीं पूछा जाता। प्रमाणीकरण पेज बताता है कि कोड कैसे माँगें और सत्यापित करें।

भुगतान के बाद

billing:write चाहिए। व्यक्ति के कार्ड जोड़ने के बाद POST /billing/pay-as-you-go/confirm भुगतान प्रदाता से जाँचता है और उसे दर्ज करता है, जैसे ऐप उसके लौटने पर करता है। enabled बताता है कि उपयोग के अनुसार भुगतान अभी चालू है या नहीं, और इसे दोबारा कॉल करना सुरक्षित है।

curl
curl -X POST "$OE/billing/pay-as-you-go/confirm" -H "$AUTH"
प्रतिक्रिया
{ "object": "pay_as_you_go_confirmation", "enabled": true }

स्विच से आया activating: true बताता है कि अभी-अभी एक कार्ड सहेजा गया और उपयोग के अनुसार भुगतान चालू हो रहा है, इसलिए थोड़ी देर में इसे फिर पढ़ें।

OAuth एक्सेस टोकन को इस कॉल के लिए सत्यापन कोड चाहिए। जब तक ऐप पिछले 60 मिनट में कोई कोड सत्यापित न कर ले, कॉल 403 step_up_required लौटाती है और कुछ नहीं बदलती। API कुंजी से कभी नहीं पूछा जाता। प्रमाणीकरण पेज बताता है कि कोड कैसे माँगें और सत्यापित करें।

संदर्भ