پرش به مستندات
سرور MCP

صورت‌حساب

طرح، پرداخت به‌اندازهٔ مصرف، فاکتورها و پیوندهای پرداخت.

ابزارهای صورت‌حساب

ابزارچه می‌کند
getBillingطرح فضای کاری و آنچه شامل می‌شود، همان‌طور که طرح‌ها و صورت‌حساب نشان می‌دهد: چگونه صورت‌حساب می‌شود، کی تمدید می‌شود یا پایان می‌یابد و پرداخت بعدی، دامنه‌ها، ارسال‌های این ماه، کارهای هوش مصنوعی امروز و پرداخت به‌اندازهٔ مصرف.
listBillingPlansهر طرح، از ارزان‌ترین، با قیمتش، جایی که فروخته می‌شود و آنچه شامل می‌شود.
getBillingUsageارسال‌ها و کارهای هوش مصنوعی در روز، و هزینهٔ مصرف اضافهٔ پرداخت به‌اندازهٔ مصرف در ماه، همان‌طور که نمودارهای مصرف نشان می‌دهند. days تا 3660 روز به عقب برمی‌گردد، و 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()