결제
이 그룹의 모든 작업: 받는 값, 반환하는 값, 응답할 수 있는 오류.
작업
The plan of the workspace and what it costs, as Plans & Billing shows them: what the plan includes and how much of it is used, the plans on sale, pay as you go, every charge with its invoice, and the links that start a checkout or open the billing portal.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Nothing is paid through the API. Starting a checkout, opening the billing portal and adding a card for pay as you go each return a link to the billing provider's page, where the person pays, changes the card or cancels, as they do from the app.
GET/billing
Read the plan
The plan of the workspace and what it includes: the billing interval, when it renews or ends and the next charge, how many domains it holds, how much of the sends and AI actions are used, and pay as you go. metered is false when billing is off on this install, and then nothing is capped.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Requires the billing:read scope.
반환값
The plan and what it includes.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
GET/billing/plans
List the plans
Every plan, cheapest first, with its price and what it includes. available says whether it is sold on this install, and intervals the billing intervals it is sold at.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Requires the billing:read scope.
반환값
Every plan.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
GET/billing/usage
Read the usage history
Sends and AI actions per day, and what pay as you go extras cost per month, as the Usage charts show them.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Requires the billing:read scope.
쿼리 매개변수
daysinteger | stringHow many days back to go, 1 to 3660, or
allfor every day since the workspace was made. 30 by default.기본값30
반환값
Usage per day and extras per month.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
GET/billing/alerts
List the billing alerts
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. An empty list means there is nothing to say.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Requires the billing:read scope.
반환값
The alerts, most urgent first.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
GET/billing/countries
List the billing countries
Every country a billing address can be in, as two-letter ISO 3166 codes, the values country takes on PUT /billing/invoices/{orderId}/details.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Requires the billing:read scope.
반환값
Every country code.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
GET/billing/pay-as-you-go
Read pay as you go
Whether usage past the allowances is billed, the monthly limit and what extras cost so far, the limits that can be chosen, the prices, and the current billing period of pay as you go once it is set up.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Requires the billing:read scope.
반환값
Pay as you go on this workspace.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
PATCH/billing/pay-as-you-go
Turn pay as you go on or off
Turns pay as you go on or off, as the switch on Plans & Billing does. Off takes effect at once, and usage stops at the allowances. On takes effect at once when a card is already saved. The first time, checkoutUrl is a link where the person adds a card, and pay as you go starts once they have: call POST /billing/pay-as-you-go/confirm after they return. activating means a card was just saved and it is being turned on. theme and locale style the page the link opens.
Nothing is paid through the API. Starting a checkout, opening the billing portal and adding a card for pay as you go each return a link to the billing provider's page, where the person pays, changes the card or cancels, as they do from the app.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Requires the billing:write scope.
요청 본문
themestringlightordark, for the page the link opens.다음 중 하나"light""dark"localestringA language tag such as
deorpt-PT, for the page the link opens.최대 35자enabledboolean필수trueto turn it on,falseto turn it off.
반환값
What happened.
오류
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 503
billing_not_configured: pay as you go is not set up on this install.
모든 작업이 반환할 수 있는 오류400401404422500오류 목록
다른 사용처
PUT/billing/pay-as-you-go/limit
Set the pay as you go limit
Sets the monthly spending limit of pay as you go, one of the amounts GET /billing/pay-as-you-go lists in limits. Extras stop for the rest of a calendar month once it is reached.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Requires the billing:write scope.
요청 본문
limitCentsinteger필수The monthly limit in US cents.
다음 중 하나100025005000100002500050000100000250000500000
반환값
The limit.
오류
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
pay_as_you_go_not_enrolled: pay as you go has never been set up on this workspace.
모든 작업이 반환할 수 있는 오류400401404422500오류 목록
다른 사용처
POST/billing/pay-as-you-go/confirm
Confirm pay as you go
Checks with the billing provider whether the card from a pay as you go checkout was saved, and records it, as the app does when the person comes back from the checkout. enabled says whether pay as you go is on now. It is safe to call again.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Requires the billing:write scope.
반환값
Whether pay as you go is on.
오류
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.
모든 작업이 반환할 수 있는 오류400401404422500오류 목록
다른 사용처
POST/billing/checkout
Start a checkout
Starts buying a paid plan for a workspace on Free, as choosing a plan in the app does, and returns the link to the checkout. Nothing is charged until the person pays there, and the plan starts once they have. A workspace that already pays for a plan changes it on the billing portal instead.
Nothing is paid through the API. Starting a checkout, opening the billing portal and adding a card for pay as you go each return a link to the billing provider's page, where the person pays, changes the card or cancels, as they do from the app.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Requires the billing:write scope.
요청 본문
themestringlightordark, for the page the link opens.다음 중 하나"light""dark"localestringA language tag such as
deorpt-PT, for the page the link opens.최대 35자planstring필수starter,businessorenterprise.다음 중 하나"starter""business""enterprise"intervalstringmonthoryear. Defaults tomonth.다음 중 하나"month""year"
반환값
The link to the checkout.
오류
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
plan_conflict: the workspace already pays for a plan.- 422
plan_unavailable: the plan is not sold on this install, or not at that interval.invalid_parameter: the body did not validate.- 503
billing_not_configured: paid plans are not set up on this install.
모든 작업이 반환할 수 있는 오류400401404500오류 목록
다른 사용처
POST/billing/portal
Open the billing portal
Returns 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. The body is optional.
Nothing is paid through the API. Starting a checkout, opening the billing portal and adding a card for pay as you go each return a link to the billing provider's page, where the person pays, changes the card or cancels, as they do from the app.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Requires the billing:write scope.
요청 본문
themestringlightordark, for the page the link opens.다음 중 하나"light""dark"localestringA language tag such as
deorpt-PT, for the page the link opens.최대 35자
반환값
The link to the billing portal.
오류
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 503
billing_not_configured: billing is not set up on this install.
모든 작업이 반환할 수 있는 오류400401404422500오류 목록
다른 사용처
GET/billing/invoices
List the charges
Every charge of the workspace with its invoice, as History on Plans & Billing lists them. page and limit page through them, total counts them all, and search matches the plan, the invoice number, the charge id and the name billed. metered is false when billing is off on this install.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Requires the billing:read scope.
쿼리 매개변수
pageintegerWhich page, from 1.
1 이상기본값1limitintegerCharges per page, 1 to 100.
1 이상100 이하기본값25sortstringNewest or oldest first.
다음 중 하나"newest""oldest"기본값"newest"searchstringWords to look for.
최대 120자
반환값
A page of charges.
오류
- 502
billing_unreachable: the billing provider did not answer.
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
GET/billing/invoices/{orderId}
Get the invoice of a charge
The link to the invoice of one charge, as a PDF, and its file name. An invoice that was not written yet is written first, from the billing details on the charge or on the account, which can take a few seconds. The link is signed by the billing provider, downloads the PDF and stops working after a while, so fetch it again rather than keeping it.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Requires the billing:read scope.
경로 매개변수
orderIdstring필수The id of a charge, as
GET /billing/invoiceslists it.
반환값
The link to the invoice.
오류
- 409
billing_details_required: the charge has no billing name and address yet.invoice_unavailable: a draft or void charge has no invoice.- 502
billing_unreachable: the billing provider did not answer.- 504
invoice_not_ready: the invoice is still being written.
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
PUT/billing/invoices/{orderId}/details
Save the billing details of a charge
Saves the name and address billed on a charge, as the Billing address dialog does, keeps the address for later charges, and starts writing its invoice. invoice is ready when the charge already had one, started when it is being written, and refused with the reason in message. Read it with GET /billing/invoices/{orderId}.
Billing belongs to the owner of the workspace. An API key acts for the owner, and an OAuth access token reaches billing only when the owner connected the app with every address. A token that acts for a member is refused with owner_only, and a key or token limited to particular addresses or domains with capability_unsupported. Reading needs billing:read, every change needs billing:write, and an OAuth access token needs a verification code for every change.
Requires the billing:write scope.
경로 매개변수
orderIdstring필수The id of a charge, as
GET /billing/invoiceslists it.
요청 본문
namestring필수Who is billed, up to 200 characters.
1~200자line1string필수The street address, up to 200 characters.
1~200자line2stringA flat, suite or building, up to 200 characters.
최대 200자citystring필수Up to 120 characters.
1~120자postalCodestringUp to 40 characters.
최대 40자statestringThe state or region, up to 60 characters. In the US and Canada, its two-letter code.
최대 60자countrystring필수A two-letter ISO 3166 code, one of those
listCountriesreturns.다음 중 하나"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"
반환값
Saved.
오류
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 422
billing_address_rejected: the billing provider refused the address.invalid_parameter: the body did not validate.- 502
billing_unreachable: the billing provider did not answer.
모든 작업이 반환할 수 있는 오류400401404500오류 목록
다른 사용처
객체
Billingobject
objectstring필수- 다음 중 하나
"billing" workspaceIdstring필수workspaceNamestringplanstring필수- 다음 중 하나
"free""starter""business""enterprise" planNamestringmeteredboolean필수False when billing is off on this install, and then nothing is capped.
intervalstringHow often the plan is billed. Null on Free.
null 가능다음 중 하나"month""year"renewsAtstringWhen the plan renews, or ends when
cancelAtPeriodEndis true.null 가능형식date-timecancelAtPeriodEndbooleanThe plan was cancelled and ends at
renewsAt.nextChargeobjectThe next charge of the plan, when one is due.
centsis null until it is known.null 가능centsinteger- null 가능
currencystring- null 가능
atstring- 형식
date-time
domainsobjectusedintegerDomains in the workspace.
0 이상includedintegerDomains the plan includes. Null when there is no limit.
null 가능0 이상canAddboolean
usageobjectsendsobjectusedintegerUsed so far.
0 이상limitintegerWhat the plan includes. Null when there is no limit.
null 가능0 이상resetsAtstringWhen the monthly sends start again.
형식date-time
aiActionsobjectusedintegerUsed so far.
0 이상limitintegerWhat the plan includes. Null when there is no limit.
null 가능0 이상resetsAtstringWhen the daily AI actions start again.
형식date-time
payAsYouGoobjectavailablebooleanWhether the plan of the workspace can buy anything past its allowances.
enabledbooleanWhether usage past the allowances is being billed now: switched on and not paused.
suspendedbooleanPaused because the last payment failed. Update the card on the billing portal to resume.
enrolledbooleanWhether pay as you go has ever been set up, with a card, on this workspace.
switchedOnbooleanWhether it is switched on, paused or not.
coversSendsbooleanWhether sends past the monthly allowance can be bought on this plan.
coversAiActionsbooleanWhether AI actions past the daily allowance can be bought on this plan.
limitCentsintegerThe monthly spending limit in US cents. Extras stop once a calendar month reaches it.
spentCentsintegerWhat extras cost this calendar month so far, in US cents.
0 이상extraSendsintegerSends past the allowance this month.
0 이상extraAiActionsintegerAI actions past the allowance this month.
0 이상estimatedCentsintegerWhat those extras come to, in US cents.
0 이상
availablePlansstring[]The plans sold on this install.
다음 중 하나"free""starter""business""enterprise"
BillingAlertobject
objectstring필수- 다음 중 하나
"billing_alert" idstring필수Stays the same while the same thing is true, so a dismissed alert can stay dismissed.
kindstring필수- 다음 중 하나
"payment_failed""pay_as_you_go_paused""sending_paused""spend_limit_reached""ai_used_up""plan_ending""sends_nearly_used""spend_nearly_reached""upcoming_charge" severitystring필수- 다음 중 하나
"blocked""warning""info" targetstring필수Which tab of Plans & Billing it is about: the plan or the usage.
다음 중 하나"billing""usage"planNamestring- null 가능
atstringWhen it happens: the charge, the end of the plan or the reset.
null 가능형식date-timecentsinteger- null 가능
currencystring- null 가능
usedinteger- null 가능
limitinteger- null 가능
payAsYouGobooleanWhether pay as you go can lift the limit it is about.
BillingAlertListobject
objectstring- 다음 중 하나
"list" dataBillingAlert[]
BillingCheckoutobject
objectstring- 다음 중 하나
"checkout" urlstring- 형식
uri
BillingCountryListobject
objectstring- 다음 중 하나
"list" datastring[]
BillingInvoiceobject
objectstring필수- 다음 중 하나
"invoice" idstring필수The charge id the invoice calls take.
createdAtstring필수- 형식
date-time amountCentsinteger필수subtotalCentsintegercurrencystring필수statusstring- null 가능다음 중 하나
"draft""pending""paid""refunded""partially_refunded""void" paidbooleanreasonstringWhy it was charged: a purchase, a renewal or a change.
invoiceNumberstring- null 가능
invoiceReadybooleanWhether its invoice was written.
needsBillingDetailsbooleanIts invoice needs a billing name and address first.
billingNamestring- null 가능
productstring- null 가능
payAsYouGobooleanA charge for pay as you go extras.
discountobject- null 가능
codestring- null 가능
namestring- null 가능
amountCentsintegerpercentOffnumber- null 가능
BillingInvoiceDetailsobject
objectstring- 다음 중 하나
"invoice_details" orderIdstringinvoicestring- 다음 중 하나
"ready""started""refused" messagestringWhy the invoice could not be started, when
invoiceisrefused.null 가능
BillingInvoiceLinkobject
objectstring- 다음 중 하나
"invoice_link" orderIdstringurlstringThe link is signed by the billing provider, downloads the PDF and stops working after a while, so fetch it again rather than keeping it.
형식urifileNamestring
BillingInvoiceListobject
objectstring- 다음 중 하나
"list" dataBillingInvoice[]totalintegerHow many charges there are in all.
0 이상pageinteger- 1 이상
limitinteger- 1 이상
hasMorebooleanmeteredbooleanFalse when billing is off on this install.
BillingPlanobject
objectstring필수- 다음 중 하나
"plan" idstring필수- 다음 중 하나
"free""starter""business""enterprise" namestring필수availableboolean필수Whether it is sold on this install.
intervalsstring[]필수The billing intervals it is sold at. Empty for Free.
다음 중 하나"month""year"monthlyPriceCentsintegerThe price billed monthly, in US cents a month.
0 이상yearlyMonthlyPriceCentsintegerThe price billed yearly, in US cents a month.
0 이상includedDomainsintegerDomains it includes. Null when there is no limit.
null 가능0 이상monthlySendsintegerSends it includes each calendar month. Null when there is no limit.
null 가능0 이상dailyAiActionsintegerAI actions it includes each day. Null when there is no limit.
null 가능0 이상teamAccessbooleanWhether members can be added.
prioritySupportbooleanextraSendsbooleanWhether pay as you go can buy sends past the allowance.
extraAiActionsbooleanWhether pay as you go can buy AI actions past the allowance.
BillingPlanListobject
objectstring- 다음 중 하나
"list" dataBillingPlan[]
BillingPortalobject
objectstring- 다음 중 하나
"billing_portal" urlstring- 형식
uri
BillingUsageobject
objectstring필수- 다음 중 하나
"usage_history" daysobject[]필수daystring- 형식
date aiActionsintegerAI actions that day.
0 이상aiExtraintegerOf those, the ones past the daily allowance, billed by pay as you go.
0 이상sendsintegerEmails sent that day.
0 이상
monthsobject[]필수monthstringThe month, as YYYY-MM.
extraSendsintegerSends billed by pay as you go.
0 이상extraAiActionsintegerAI actions billed by pay as you go.
0 이상sendCentsintegerWhat the extra sends cost, in US cents.
0 이상aiCentsintegerWhat the extra AI actions cost, in US cents.
0 이상centsintegerBoth, in US cents.
0 이상
dailyAiActionsintegerAI actions the plan includes each day. Null when there is no limit.
null 가능0 이상monthlySendsintegerSends the plan includes each month. Null when there is no limit.
null 가능0 이상
PayAsYouGoobject
objectstring필수- 다음 중 하나
"pay_as_you_go" availableboolean필수Whether the plan of the workspace can buy anything past its allowances.
enabledboolean필수Whether usage past the allowances is being billed now: switched on and not paused.
suspendedbooleanPaused because the last payment failed. Update the card on the billing portal to resume.
enrolledbooleanWhether pay as you go has ever been set up, with a card, on this workspace.
switchedOnbooleanWhether it is switched on, paused or not.
coversSendsbooleanWhether sends past the monthly allowance can be bought on this plan.
coversAiActionsbooleanWhether AI actions past the daily allowance can be bought on this plan.
limitCentsintegerThe monthly spending limit in US cents. Extras stop once a calendar month reaches it.
spentCentsintegerWhat extras cost this calendar month so far, in US cents.
0 이상extraSendsintegerSends past the allowance this month.
0 이상extraAiActionsintegerAI actions past the allowance this month.
0 이상estimatedCentsintegerWhat those extras come to, in US cents.
0 이상limitsinteger[]필수The monthly limits that can be chosen, in US cents.
다음 중 하나100025005000100002500050000100000250000500000pricesobject필수What extras cost:
priceCentsUS cents for everyunit.sendsobjectunitintegerpriceCentsinteger
aiActionsobjectunitintegerpriceCentsinteger
periodobjectThe current billing period of pay as you go. Null until it is set up.
null 가능endsAtstring- 형식
date-time sendsintegerExtra sends in the period.
0 이상aiActionsintegerExtra AI actions in the period.
0 이상estimatedCentsintegerWhat they come to, in US cents.
0 이상
PayAsYouGoConfirmationobject
objectstring- 다음 중 하나
"pay_as_you_go_confirmation" enabledboolean
PayAsYouGoLimitobject
objectstring- 다음 중 하나
"pay_as_you_go_limit" limitCentsinteger
PayAsYouGoSwitchobject
objectstring- 다음 중 하나
"pay_as_you_go_switch" enabledbooleansuspendedbooleanactivatingbooleanA card was just saved, and pay as you go is being turned on.
checkoutUrlstringWhere the person adds a card, the first time pay as you go is turned on.
null 가능