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

बिलिंग

प्लान, उपयोग के अनुसार भुगतान, इनवॉइस और भुगतान के लिंक।

बिलिंग टूल

टूलयह क्या करता है
getBillingवर्कस्पेस का प्लान और उसमें शामिल चीज़ें, जैसे प्लान और बिलिंग दिखाता है: उसका बिल कैसे बनता है, वह कब नवीनीकृत होता है या ख़त्म होता है और अगला शुल्क, डोमेन, इस महीने के भेजे गए ईमेल, आज की AI क्रियाएँ और उपयोग के अनुसार भुगतान।
listBillingPlansहर प्लान, सबसे सस्ते से शुरू करके, उसकी कीमत, वह कहाँ बिकता है और उसमें क्या शामिल है।
getBillingUsageहर दिन के भेजे गए ईमेल और AI क्रियाएँ, और उपयोग के अनुसार भुगतान के अतिरिक्त उपयोग का हर महीने का ख़र्च, जैसे उपयोग चार्ट दिखाते हैं। days 3,660 दिन तक पीछे जाता है, और all उस दिन तक जब वर्कस्पेस बना था।
listBillingAlertsऐप का बिलिंग बैनर अभी क्या कहेगा, सबसे ज़रूरी पहले।
listBillingCountriesहर देश कोड जिसे बिलिंग पता लेता है।
getPayAsYouGoउपयोग के अनुसार भुगतान: अतिरिक्त उपयोग का बिल बनता है या नहीं, मासिक सीमा और अब तक का ख़र्च, मौजूदा अवधि, चुनी जा सकने वाली सीमाएँ और कीमतें।
setPayAsYouGoउपयोग के अनुसार भुगतान चालू या बंद करें। पहली बार यह एक लिंक लौटाता है जहाँ व्यक्ति कार्ड जोड़ता है। ऐप की चैट में यह हमेशा पहले पूछता है।
setPayAsYouGoLimitउपयोग के अनुसार भुगतान की मासिक सीमा तय करें। ऐप की चैट में यह हमेशा पहले पूछता है।
confirmPayAsYouGoव्यक्ति के कार्ड जोड़ने के बाद, जाँचें कि वह सहेजा गया और उसे दर्ज करें। ऐप की चैट में यह हमेशा पहले पूछता है।
startPlanCheckoutमुफ़्त प्लान वाले वर्कस्पेस के लिए किसी पेड प्लान के भुगतान का लिंक। ऐप की चैट में यह हमेशा पहले पूछता है।
openBillingPortalबिलिंग पोर्टल का लिंक, जहाँ प्लान बदला या रद्द किया जाता है और कार्ड अपडेट होता है। ऐप की चैट में यह हमेशा पहले पूछता है।
listInvoicesहर शुल्क उसके इनवॉइस की स्थिति के साथ, जैसे प्लान और बिलिंग में इतिहास उन्हें दिखाता है, एक बार में एक पेज।
getInvoiceकिसी शुल्क के इनवॉइस का लिंक, एक PDF, क्योंकि टूल कोई फ़ाइल नहीं ले जाता।
saveBillingDetailsकिसी शुल्क पर बिल किया गया नाम और पता सहेजें, पते को आगे के शुल्कों के लिए रखें और उसका इनवॉइस लिखना शुरू करें। ऐप की चैट में यह हमेशा पहले पूछता है।

बिलिंग तक सिर्फ़ वर्कस्पेस का मालिक पहुँचता है, हर पते के साथ जुड़े क्लाइंट से। पढ़ने को billing:read और हर बदलाव को billing:write चाहिए।

किसी टूल से कुछ भी भुगतान नहीं होता। भुगतान, बिलिंग पोर्टल और उपयोग के अनुसार भुगतान के लिए कार्ड जोड़ना, हर एक एक लिंक लौटाता है जिसे व्यक्ति खोलता है, और वहीं वह भुगतान करता है, कार्ड बदलता है या रद्द करता है।

इस सर्वर के कुछ टूल ऐसा बदलाव करते हैं जिसे REST API सत्यापन कोड से सुरक्षित रखता है, और वही कोड माँगते हैं। जब तक क्लाइंट ने पिछले 60 मिनट में कोई कोड सत्यापित न किया हो, और व्यक्ति ने अकाउंट → कनेक्टेड ऐप्स में उसके लिए "60 मिनट के लिए बदलावों की अनुमति दें" न चुना हो, ऐसा टूल एक ऐसे नतीजे से जवाब देता है जो Refused (step_up_required): से शुरू होता है, और कुछ नहीं बदलता। emptyAudience कभी कोड नहीं माँगता। API का प्रमाणीकरण पेज कोड माँगने वाले हर टूल की सूची देता है, और बताता है कि कोड कैसे माँगें और सत्यापित करें।

संदर्भ

getBilling

स्कोपbilling:readऐप का असिस्टेंट इसे बिना पूछे चलाता हैटूलकिटbilling

The plan of this workspace and what it includes, as Plans & Billing shows it: how it is billed, when it renews or ends and the next charge, how many domains it holds, how much of this month's sends and today's AI actions are used, and pay as you go. Only the owner of the workspace reaches billing, through a client connected with every address.

इनपुट

कोई इनपुट नहीं लेता।

इनमें भी उपलब्ध

API
GET /billing
SDK
billing.get()

listBillingPlans

स्कोपbilling:readऐप का असिस्टेंट इसे बिना पूछे चलाता हैटूलकिटbilling

Every plan, cheapest first, with its price, whether it is sold here and at which intervals, and what it includes. Prices are in US dollars. Only the owner of the workspace reaches billing, through a client connected with every address.

इनपुट

कोई इनपुट नहीं लेता।

इनमें भी उपलब्ध

API
GET /billing/plans
SDK
billing.listPlans()

getBillingUsage

स्कोपbilling:readऐप का असिस्टेंट इसे बिना पूछे चलाता हैटूलकिटbilling

Sends and AI actions per day, and what pay as you go extras cost per month, as the Usage charts show them. days goes back 1 to 3660 days, 30 by default, and "all" goes back to the day the workspace was made. Days with no use are left out. Only the owner of the workspace reaches billing, through a client connected with every address.

इनपुट

daysinteger | string

इनमें भी उपलब्ध

API
GET /billing/usage
SDK
billing.getUsage()

listBillingAlerts

स्कोपbilling:readऐप का असिस्टेंट इसे बिना पूछे चलाता हैटूलकिटbilling

What the billing banner of the app would say now, most urgent first: a failed payment, paused pay as you go, sending or AI paused at a limit, a plan about to end, an allowance nearly used and a charge coming soon. Only the owner of the workspace reaches billing, through a client connected with every address.

इनपुट

कोई इनपुट नहीं लेता।

इनमें भी उपलब्ध

API
GET /billing/alerts
SDK
billing.listAlerts()

listBillingCountries

स्कोपbilling:readऐप का असिस्टेंट इसे बिना पूछे चलाता हैटूलकिटbilling

Every country a billing address can be in, as the two-letter ISO 3166 codes saveBillingDetails takes as country. Only the owner of the workspace reaches billing, through a client connected with every address.

इनपुट

कोई इनपुट नहीं लेता।

इनमें भी उपलब्ध

API
GET /billing/countries
SDK
billing.listCountries()

getPayAsYouGo

स्कोपbilling:readऐप का असिस्टेंट इसे बिना पूछे चलाता हैटूलकिटbilling

Pay as you go on this workspace: whether usage past the allowances is billed, the monthly limit and what extras cost so far, the current billing period, the limits that can be chosen and the prices. Only the owner of the workspace reaches billing, through a client connected with every address.

इनपुट

कोई इनपुट नहीं लेता।

इनमें भी उपलब्ध

API
GET /billing/pay-as-you-go
SDK
billing.getPayAsYouGo()

setPayAsYouGo

स्कोपbilling:writeऐप का असिस्टेंट हमेशा पहले पूछता हैटूलकिटbilling

Turn pay as you go on or off, as the switch on Plans & Billing does. Off takes effect at once, and usage stops at the plan's allowances. On takes effect at once when a card is saved. The first time, it returns a link where the person adds a card on the billing provider's page: give them the link, and call confirmPayAsYouGo once they say they are done. Nothing is paid through this tool. It asks for a verification code, and in the app's chat it always asks first. Only the owner of the workspace reaches billing, through a client connected with every address.

इनपुट

enabledbooleanआवश्यक
themestring

Light or dark, for the page the link opens. Left out, it follows the browser.

इनमें से एक"light""dark"
localestring

A language tag such as de or pt-PT, for the page the link opens.

अधिकतम 35 वर्ण

इनमें भी उपलब्ध

API
PATCH /billing/pay-as-you-go
SDK
billing.setPayAsYouGo()

setPayAsYouGoLimit

स्कोपbilling:writeऐप का असिस्टेंट हमेशा पहले पूछता हैटूलकिटbilling

Set the monthly spending limit of pay as you go, in US cents. Extras stop for the rest of a calendar month once it is reached. Pay as you go has to be set up first. It asks for a verification code, and in the app's chat it always asks first. Only the owner of the workspace reaches billing, through a client connected with every address.

इनपुट

limitCentsintegerआवश्यक

One of 1000, 2500, 5000, 10000, 25000, 50000, 100000, 250000, 500000.

इनमें भी उपलब्ध

API
PUT /billing/pay-as-you-go/limit
SDK
billing.setPayAsYouGoLimit()

confirmPayAsYouGo

स्कोपbilling:writeऐप का असिस्टेंट हमेशा पहले पूछता हैटूलकिटbilling

After the person added a card through the link setPayAsYouGo gave, check with the billing provider that it was saved and record it, as the app does when they come back. It asks for a verification code, and in the app's chat it always asks first. Only the owner of the workspace reaches billing, through a client connected with every address.

इनपुट

कोई इनपुट नहीं लेता।

इनमें भी उपलब्ध

API
POST /billing/pay-as-you-go/confirm
SDK
billing.confirmPayAsYouGo()

startPlanCheckout

स्कोपbilling:writeऐप का असिस्टेंट हमेशा पहले पूछता हैटूलकिटbilling

Start buying a paid plan for a workspace on Free, as choosing a plan in the app does, and return the link to the checkout on the billing provider's page. Nothing is charged until the person pays there, so give them the link. A workspace that already pays for a plan changes it with openBillingPortal instead. interval is month or year, month by default. It asks for a verification code, and in the app's chat it always asks first. Only the owner of the workspace reaches billing, through a client connected with every address.

इनपुट

planstringआवश्यक
इनमें से एक"starter""business""enterprise"
intervalstring
इनमें से एक"month""year"
themestring

Light or dark, for the page the link opens. Left out, it follows the browser.

इनमें से एक"light""dark"
localestring

A language tag such as de or pt-PT, for the page the link opens.

अधिकतम 35 वर्ण

इनमें भी उपलब्ध

API
POST /billing/checkout
SDK
billing.startCheckout()

openBillingPortal

स्कोपbilling:writeऐप का असिस्टेंट हमेशा पहले पूछता हैटूलकिटbilling

A link to the billing portal, where the person changes or cancels the plan, updates the card and downloads past invoices, as Manage does in the app. Nothing changes until they act there. It asks for a verification code, and in the app's chat it always asks first. Only the owner of the workspace reaches billing, through a client connected with every address.

इनपुट

themestring

Light or dark, for the page the link opens. Left out, it follows the browser.

इनमें से एक"light""dark"
localestring

A language tag such as de or pt-PT, for the page the link opens.

अधिकतम 35 वर्ण

इनमें भी उपलब्ध

API
POST /billing/portal
SDK
billing.openPortal()

listInvoices

स्कोपbilling:readऐप का असिस्टेंट इसे बिना पूछे चलाता हैटूलकिटbilling

Every charge of the workspace with the state of its invoice, as History on Plans & Billing lists them, newest first unless sort is oldest. search matches the plan, the invoice number, the charge id and the name billed. getInvoice returns the link to an invoice. Only the owner of the workspace reaches billing, through a client connected with every address.

इनपुट

pageinteger
कम से कम 1
limitinteger
कम से कम 1अधिकतम 100
sortstring
इनमें से एक"newest""oldest"
searchstring
अधिकतम 120 वर्ण

इनमें भी उपलब्ध

API
GET /billing/invoices
SDK
billing.listInvoices()

getInvoice

स्कोपbilling:readऐप का असिस्टेंट इसे बिना पूछे चलाता हैटूलकिटbilling

The link to the invoice of one charge, a PDF, since a tool carries no file. An invoice that was not written yet is written first, which takes a few seconds. Take the charge id from listInvoices. Only the owner of the workspace reaches billing, through a client connected with every address.

इनपुट

orderIdstringआवश्यक
खाली नहीं

इनमें भी उपलब्ध

API
GET /billing/invoices/{orderId}
SDK
billing.getInvoice()

saveBillingDetails

स्कोपbilling:writeऐप का असिस्टेंट हमेशा पहले पूछता हैटूलकिटbilling

Save the name and address billed on a charge, as the Billing address dialog does, keep the address for later charges, and start writing its invoice. country is a two-letter code from listBillingCountries, and in the US and Canada state is its two-letter code. It asks for a verification code, and in the app's chat it always asks first. Only the owner of the workspace reaches billing, through a client connected with every address.

इनपुट

orderIdstringआवश्यक
खाली नहीं
namestringआवश्यक
1 से 200 वर्ण
line1stringआवश्यक
1 से 200 वर्ण
line2string
अधिकतम 200 वर्ण
citystringआवश्यक
1 से 120 वर्ण
postalCodestring
अधिकतम 40 वर्ण
statestring
अधिकतम 60 वर्ण
countrystringआवश्यक
इनमें से एक"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR""AS""AT""AU""AW""AX""AZ""BA""BB""BD""BE""BF""BG""BH""BI""BJ""BL""BM""BN""BO""BQ""BR""BS""BT""BV""BW""BY""BZ""CA""CC""CD""CF""CG""CH""CI""CK""CL""CM""CN""CO""CR""CV""CW""CX""CY""CZ""DE""DJ""DK""DM""DO""DZ""EC""EE""EG""EH""ER""ES""ET""FI""FJ""FK""FM""FO""FR""GA""GB""GD""GE""GF""GG""GH""GI""GL""GM""GN""GP""GQ""GR""GS""GT""GU""GW""GY""HK""HM""HN""HR""HT""HU""ID""IE""IL""IM""IN""IO""IQ""IS""IT""JE""JM""JO""JP""KE""KG""KH""KI""KM""KN""KR""KW""KY""KZ""LA""LB""LC""LI""LK""LR""LS""LT""LU""LV""LY""MA""MC""MD""ME""MF""MG""MH""MK""ML""MM""MN""MO""MP""MQ""MR""MS""MT""MU""MV""MW""MX""MY""MZ""NA""NC""NE""NF""NG""NI""NL""NO""NP""NR""NU""NZ""OM""PA""PE""PF""PG""PH""PK""PL""PM""PN""PR""PS""PT""PW""PY""QA""RE""RO""RS""RW""SA""SB""SC""SD""SE""SG""SH""SI""SJ""SK""SL""SM""SN""SO""SR""SS""ST""SV""SX""SZ""TC""TD""TF""TG""TH""TJ""TK""TL""TM""TN""TO""TR""TT""TV""TW""TZ""UA""UG""UM""US""UY""UZ""VA""VC""VE""VG""VI""VN""VU""WF""WS""YE""YT""ZA""ZM""ZW"

इनमें भी उपलब्ध

API
PUT /billing/invoices/{orderId}/details
SDK
billing.saveInvoiceDetails()