문서로 건너뛰기
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()