Facturación
El plan, el pago por uso, las facturas y los enlaces para pagar.
Herramientas de facturación
| Herramienta | Qué hace |
|---|---|
| getBilling | El plan del espacio de trabajo y lo que incluye, como lo muestra Planes y facturación: cómo se factura, cuándo se renueva o termina y el próximo cargo, los dominios, los envíos de este mes, las acciones de IA de hoy y el pago por uso. |
| listBillingPlans | Cada plan, del más barato al más caro, con su precio, dónde se vende y lo que incluye. |
| getBillingUsage | Los envíos y las acciones de IA por día, y lo que cuestan por mes los extras del pago por uso, como los muestran los gráficos de Uso. days retrocede hasta 3660 días, y all hasta el día en que se creó el espacio de trabajo. |
| listBillingAlerts | Lo que diría ahora el aviso de facturación de la app, lo más urgente primero. |
| listBillingCountries | Cada código de país que admite una dirección de facturación. |
| getPayAsYouGo | Pago por uso: si se facturan los extras, el límite mensual y lo que cuestan hasta ahora, el periodo actual, los límites que se pueden elegir y los precios. |
| setPayAsYouGo | Activar o desactivar el pago por uso. La primera vez devuelve un enlace donde la persona añade una tarjeta. En el chat de la app siempre pregunta primero. |
| setPayAsYouGoLimit | Fijar el límite mensual del pago por uso. En el chat de la app siempre pregunta primero. |
| confirmPayAsYouGo | Cuando la persona haya añadido la tarjeta, comprobar que se guardó y registrarlo. En el chat de la app siempre pregunta primero. |
| startPlanCheckout | El enlace a un pago para un plan de pago, para un espacio de trabajo en el plan gratuito. En el chat de la app siempre pregunta primero. |
| openBillingPortal | El enlace al portal de facturación, donde se cambia o se cancela el plan y se actualiza la tarjeta. En el chat de la app siempre pregunta primero. |
| listInvoices | Cada cargo con el estado de su factura, como los lista el Historial de Planes y facturación, una página cada vez. |
| getInvoice | El enlace a la factura de un cargo, un PDF, ya que una herramienta no lleva archivos. |
| saveBillingDetails | Guardar el nombre y la dirección facturados en un cargo, conservar la dirección para cargos posteriores y empezar a generar su factura. En el chat de la app siempre pregunta primero. |
Solo el propietario del espacio de trabajo llega a la facturación, mediante un cliente conectado con todas las direcciones. Leer requiere billing:read y cada cambio requiere billing:write.
Nada se paga mediante una herramienta. Un pago, el portal de facturación y añadir una tarjeta para el pago por uso devuelven cada uno un enlace que la persona abre, y allí paga, cambia la tarjeta o cancela.
Algunas herramientas de este servidor hacen un cambio que la API REST protege con un código de verificación, y piden el mismo código. Hasta que el cliente haya verificado un código en los últimos 60 minutos, o la persona haya elegido Permitir cambios durante 60 minutos para él en Cuenta → Aplicaciones conectadas, esa herramienta responde con un resultado que empieza por Refused (step_up_required): y no cambia nada. emptyAudience nunca pide un código. La página Autenticación de la API enumera cada herramienta que lo pide y muestra cómo pedir un código y verificarlo.
Referencia
getBilling
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.
Entradas
No recibe entradas.
También disponible en
listBillingPlans
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.
Entradas
No recibe entradas.
También disponible en
getBillingUsage
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.
Entradas
daysinteger | string
También disponible en
listBillingAlerts
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.
Entradas
No recibe entradas.
También disponible en
listBillingCountries
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.
Entradas
No recibe entradas.
También disponible en
getPayAsYouGo
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.
Entradas
No recibe entradas.
También disponible en
setPayAsYouGo
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.
- Pide un código de verificación
PATCH /billing/pay-as-you-go
Entradas
enabledbooleanObligatoriothemestringLight or dark, for the page the link opens. Left out, it follows the browser.
Uno de"light""dark"localestringA language tag such as de or pt-PT, for the page the link opens.
Hasta 35 caracteres
También disponible en
setPayAsYouGoLimit
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.
- Pide un código de verificación
PUT /billing/pay-as-you-go/limit
Entradas
limitCentsintegerObligatorioOne of 1000, 2500, 5000, 10000, 25000, 50000, 100000, 250000, 500000.
También disponible en
confirmPayAsYouGo
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.
- Pide un código de verificación
POST /billing/pay-as-you-go/confirm
Entradas
No recibe entradas.
También disponible en
startPlanCheckout
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.
- Pide un código de verificación
POST /billing/checkout
Entradas
planstringObligatorio- Uno de
"starter""business""enterprise" intervalstring- Uno de
"month""year" themestringLight or dark, for the page the link opens. Left out, it follows the browser.
Uno de"light""dark"localestringA language tag such as de or pt-PT, for the page the link opens.
Hasta 35 caracteres
También disponible en
openBillingPortal
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.
- Pide un código de verificación
POST /billing/portal
Entradas
themestringLight or dark, for the page the link opens. Left out, it follows the browser.
Uno de"light""dark"localestringA language tag such as de or pt-PT, for the page the link opens.
Hasta 35 caracteres
También disponible en
listInvoices
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.
Entradas
pageinteger- Al menos 1
limitinteger- Al menos 1Como máximo 100
sortstring- Uno de
"newest""oldest" searchstring- Hasta 120 caracteres
También disponible en
getInvoice
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.
Entradas
orderIdstringObligatorio- No vacío
También disponible en
saveBillingDetails
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.
- Pide un código de verificación
PUT /billing/invoices/{orderId}/details
Entradas
orderIdstringObligatorio- No vacío
namestringObligatorio- De 1 a 200 caracteres
line1stringObligatorio- De 1 a 200 caracteres
line2string- Hasta 200 caracteres
citystringObligatorio- De 1 a 120 caracteres
postalCodestring- Hasta 40 caracteres
statestring- Hasta 60 caracteres
countrystringObligatorio- Uno de
"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"