Zur Dokumentation springen
MCP-Server

Abrechnung

Der Tarif, Pay-as-you-go, Rechnungen und die Links zum Bezahlen.

Abrechnungs-Tools

ToolWas es tut
getBillingDer Tarif des Workspace und was er enthält, wie Tarife & Abrechnung ihn zeigt: wie er abgerechnet wird, wann er sich verlängert oder endet und die nächste Zahlung, die Domains, die Sendungen dieses Monats, die KI-Aktionen von heute und Pay-as-you-go.
listBillingPlansJeder Tarif, der günstigste zuerst, mit seinem Preis, wo er verkauft wird und was er enthält.
getBillingUsageSendungen und KI-Aktionen pro Tag und was Zusatznutzung über Pay-as-you-go pro Monat kostet, wie die Nutzungsdiagramme sie zeigen. days reicht bis zu 3.660 Tage zurück, und all bis zu dem Tag, an dem der Workspace angelegt wurde.
listBillingAlertsWas das Abrechnungsbanner der App gerade sagen würde, das Dringendste zuerst.
listBillingCountriesJeder Ländercode, den eine Rechnungsadresse annimmt.
getPayAsYouGoPay-as-you-go: ob Zusatznutzung abgerechnet wird, das monatliche Limit und was sie bisher kostet, der laufende Zeitraum, die wählbaren Limits und die Preise.
setPayAsYouGoPay-as-you-go ein- oder ausschalten. Beim ersten Mal gibt es einen Link zurück, unter dem die Person eine Karte hinzufügt. Im Chat der App fragt es immer zuerst.
setPayAsYouGoLimitDas monatliche Limit von Pay-as-you-go setzen. Im Chat der App fragt es immer zuerst.
confirmPayAsYouGoNachdem die Person die Karte hinzugefügt hat, prüfen, ob sie gespeichert wurde, und das festhalten. Im Chat der App fragt es immer zuerst.
startPlanCheckoutDer Link zu einem Checkout für einen bezahlten Tarif, für einen Workspace im Free-Tarif. Im Chat der App fragt es immer zuerst.
openBillingPortalDer Link zum Abrechnungsportal, wo der Tarif geändert oder gekündigt und die Karte aktualisiert wird. Im Chat der App fragt es immer zuerst.
listInvoicesJede Zahlung mit dem Stand ihrer Rechnung, wie der Verlauf unter Tarife & Abrechnung sie auflistet, seitenweise.
getInvoiceDer Link zur Rechnung einer Zahlung, ein PDF, da ein Tool keine Datei trägt.
saveBillingDetailsName und Adresse, die auf einer Zahlung abgerechnet werden, speichern, die Adresse für spätere Zahlungen behalten und ihre Rechnung erstellen lassen. Im Chat der App fragt es immer zuerst.

Nur der Inhaber des Workspace erreicht die Abrechnung, über einen Client, der mit jeder Adresse verbunden ist. Lesen erfordert billing:read, und jede Änderung erfordert billing:write.

Über ein Tool wird nichts bezahlt. Ein Checkout, das Abrechnungsportal und das Hinzufügen einer Karte für Pay-as-you-go geben jeweils einen Link zurück, den die Person öffnet, und dort bezahlt sie, ändert die Karte oder kündigt.

Einige Tools auf diesem Server nehmen eine Änderung vor, die die REST API mit einem Bestätigungscode schützt, und fragen nach demselben Code. Solange der Client in den letzten 60 Minuten keinen Code bestätigt hat und die Person für ihn unter Konto → Verbundene Apps nicht Änderungen für 60 Minuten erlauben gewählt hat, antwortet ein solches Tool mit einem Ergebnis, das mit Refused (step_up_required): beginnt, und ändert nichts. emptyAudience fragt nie nach einem Code. Die Seite Authentifizierung der API nennt jedes Tool, das fragt, und zeigt, wie man einen Code anfordert und bestätigt.

Referenz

getBilling

Geltungsbereichebilling:readDer Assistent in der App führt es ohne Nachfrage ausToolkitbilling

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.

Eingaben

Nimmt keine Eingaben an.

Auch verfügbar über

API
GET /billing
SDK
billing.get()

listBillingPlans

Geltungsbereichebilling:readDer Assistent in der App führt es ohne Nachfrage ausToolkitbilling

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.

Eingaben

Nimmt keine Eingaben an.

Auch verfügbar über

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

getBillingUsage

Geltungsbereichebilling:readDer Assistent in der App führt es ohne Nachfrage ausToolkitbilling

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.

Eingaben

daysinteger | string

Auch verfügbar über

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

listBillingAlerts

Geltungsbereichebilling:readDer Assistent in der App führt es ohne Nachfrage ausToolkitbilling

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.

Eingaben

Nimmt keine Eingaben an.

Auch verfügbar über

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

listBillingCountries

Geltungsbereichebilling:readDer Assistent in der App führt es ohne Nachfrage ausToolkitbilling

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.

Eingaben

Nimmt keine Eingaben an.

Auch verfügbar über

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

getPayAsYouGo

Geltungsbereichebilling:readDer Assistent in der App führt es ohne Nachfrage ausToolkitbilling

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.

Eingaben

Nimmt keine Eingaben an.

Auch verfügbar über

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

setPayAsYouGo

Geltungsbereichebilling:writeDer Assistent in der App fragt immer zuerst nachToolkitbilling

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.

Eingaben

enabledbooleanErforderlich
themestring

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

Einer von"light""dark"
localestring

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

Bis zu 35 Zeichen

Auch verfügbar über

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

setPayAsYouGoLimit

Geltungsbereichebilling:writeDer Assistent in der App fragt immer zuerst nachToolkitbilling

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.

Eingaben

limitCentsintegerErforderlich

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

Auch verfügbar über

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

confirmPayAsYouGo

Geltungsbereichebilling:writeDer Assistent in der App fragt immer zuerst nachToolkitbilling

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.

Eingaben

Nimmt keine Eingaben an.

Auch verfügbar über

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

startPlanCheckout

Geltungsbereichebilling:writeDer Assistent in der App fragt immer zuerst nachToolkitbilling

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.

Eingaben

planstringErforderlich
Einer von"starter""business""enterprise"
intervalstring
Einer von"month""year"
themestring

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

Einer von"light""dark"
localestring

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

Bis zu 35 Zeichen

Auch verfügbar über

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

openBillingPortal

Geltungsbereichebilling:writeDer Assistent in der App fragt immer zuerst nachToolkitbilling

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.

Eingaben

themestring

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

Einer von"light""dark"
localestring

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

Bis zu 35 Zeichen

Auch verfügbar über

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

listInvoices

Geltungsbereichebilling:readDer Assistent in der App führt es ohne Nachfrage ausToolkitbilling

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.

Eingaben

pageinteger
Mindestens 1
limitinteger
Mindestens 1Höchstens 100
sortstring
Einer von"newest""oldest"
searchstring
Bis zu 120 Zeichen

Auch verfügbar über

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

getInvoice

Geltungsbereichebilling:readDer Assistent in der App führt es ohne Nachfrage ausToolkitbilling

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.

Eingaben

orderIdstringErforderlich
Nicht leer

Auch verfügbar über

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

saveBillingDetails

Geltungsbereichebilling:writeDer Assistent in der App fragt immer zuerst nachToolkitbilling

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.

Eingaben

orderIdstringErforderlich
Nicht leer
namestringErforderlich
1 bis 200 Zeichen
line1stringErforderlich
1 bis 200 Zeichen
line2string
Bis zu 200 Zeichen
citystringErforderlich
1 bis 120 Zeichen
postalCodestring
Bis zu 40 Zeichen
statestring
Bis zu 60 Zeichen
countrystringErforderlich
Einer von"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"

Auch verfügbar über

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