الفوترة
كل عملية في هذه المجموعة: ما تقبله وما تُرجعه والأخطاء التي قد تردّ بها.
العمليات
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.يمكن أن يكون nullcentsinteger- يمكن أن يكون null
currencystring- يمكن أن يكون null
atstring- التنسيق
date-time
domainsobjectusedintegerDomains in the workspace.
على الأقل 0includedintegerDomains the plan includes. Null when there is no limit.
يمكن أن يكون nullعلى الأقل 0canAddboolean
usageobjectsendsobjectusedintegerUsed so far.
على الأقل 0limitintegerWhat the plan includes. Null when there is no limit.
يمكن أن يكون nullعلى الأقل 0resetsAtstringWhen the monthly sends start again.
التنسيقdate-time
aiActionsobjectusedintegerUsed so far.
على الأقل 0limitintegerWhat the plan includes. Null when there is no limit.
يمكن أن يكون nullعلى الأقل 0resetsAtstringWhen 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.
على الأقل 0extraSendsintegerSends past the allowance this month.
على الأقل 0extraAiActionsintegerAI actions past the allowance this month.
على الأقل 0estimatedCentsintegerWhat 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.
على الأقل 0pageinteger- على الأقل 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.
على الأقل 0yearlyMonthlyPriceCentsintegerThe price billed yearly, in US cents a month.
على الأقل 0includedDomainsintegerDomains it includes. Null when there is no limit.
يمكن أن يكون nullعلى الأقل 0monthlySendsintegerSends it includes each calendar month. Null when there is no limit.
يمكن أن يكون nullعلى الأقل 0dailyAiActionsintegerAI actions it includes each day. Null when there is no limit.
يمكن أن يكون nullعلى الأقل 0teamAccessbooleanWhether 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.
على الأقل 0aiExtraintegerOf those, the ones past the daily allowance, billed by pay as you go.
على الأقل 0sendsintegerEmails sent that day.
على الأقل 0
monthsobject[]مطلوبmonthstringThe month, as YYYY-MM.
extraSendsintegerSends billed by pay as you go.
على الأقل 0extraAiActionsintegerAI actions billed by pay as you go.
على الأقل 0sendCentsintegerWhat the extra sends cost, in US cents.
على الأقل 0aiCentsintegerWhat the extra AI actions cost, in US cents.
على الأقل 0centsintegerBoth, in US cents.
على الأقل 0
dailyAiActionsintegerAI actions the plan includes each day. Null when there is no limit.
يمكن أن يكون nullعلى الأقل 0monthlySendsintegerSends 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.
على الأقل 0extraSendsintegerSends past the allowance this month.
على الأقل 0extraAiActionsintegerAI actions past the allowance this month.
على الأقل 0estimatedCentsintegerWhat those extras come to, in US cents.
على الأقل 0limitsinteger[]مطلوب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.
يمكن أن يكون nullendsAtstring- التنسيق
date-time sendsintegerExtra sends in the period.
على الأقل 0aiActionsintegerExtra AI actions in the period.
على الأقل 0estimatedCentsintegerWhat 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