Facturation
L’offre, le paiement à l’usage, les factures et les liens pour payer.
Outils Facturation
| Outil | Ce qu'il fait |
|---|---|
| getBilling | L’offre de l’espace de travail et ce qu’elle comprend, comme la montre Offres et facturation : comment elle est facturée, quand elle se renouvelle ou se termine et le prochain paiement, les domaines, les envois de ce mois, les actions IA du jour et le paiement à l’usage. |
| listBillingPlans | Chaque offre, la moins chère d’abord, avec son prix, où elle est vendue et ce qu’elle comprend. |
| getBillingUsage | Les envois et les actions IA par jour, et ce que coûtent les suppléments du paiement à l’usage par mois, comme les montrent les graphiques d’utilisation. days remonte jusqu’à 3 660 jours, et all jusqu’au jour où l’espace de travail a été créé. |
| listBillingAlerts | Ce que dirait maintenant la bannière de facturation de l’application, le plus urgent d’abord. |
| listBillingCountries | Chaque code de pays qu’une adresse de facturation accepte. |
| getPayAsYouGo | Paiement à l’usage : si les suppléments sont facturés, la limite mensuelle et ce qu’ils coûtent jusqu’ici, la période en cours, les limites que l’on peut choisir et les prix. |
| setPayAsYouGo | Activer ou désactiver le paiement à l’usage. La première fois, il renvoie un lien où la personne ajoute une carte. Dans le chat de l’application, il demande toujours d’abord. |
| setPayAsYouGoLimit | Définir la limite mensuelle du paiement à l’usage. Dans le chat de l’application, il demande toujours d’abord. |
| confirmPayAsYouGo | Une fois que la personne a ajouté la carte, vérifier qu’elle a été enregistrée et le consigner. Dans le chat de l’application, il demande toujours d’abord. |
| startPlanCheckout | Le lien d’un paiement pour une offre payante, pour un espace de travail sur l’offre gratuite. Dans le chat de l’application, il demande toujours d’abord. |
| openBillingPortal | Le lien du portail de facturation, où l’offre se change ou se résilie et la carte se met à jour. Dans le chat de l’application, il demande toujours d’abord. |
| listInvoices | Chaque paiement avec l’état de sa facture, comme les liste l’historique d’Offres et facturation, une page à la fois. |
| getInvoice | Le lien vers la facture d’un paiement, un PDF, puisqu’un outil ne transporte pas de fichier. |
| saveBillingDetails | Enregistrer le nom et l’adresse facturés sur un paiement, garder l’adresse pour les paiements suivants et lancer la rédaction de sa facture. Dans le chat de l’application, il demande toujours d’abord. |
Seul le propriétaire de l’espace de travail atteint la facturation, via un client connecté avec toutes les adresses. La lecture nécessite billing:read et chaque changement nécessite billing:write.
Rien ne se paie par un outil. Un paiement, le portail de facturation et l’ajout d’une carte pour le paiement à l’usage renvoient chacun un lien que la personne ouvre, et c’est là qu’elle paie, change la carte ou résilie.
Certains outils de ce serveur font un changement que l'API REST protège par un code de vérification, et demandent le même code. Tant que le client n'a pas vérifié de code dans les 60 dernières minutes, et que la personne n'a pas choisi Autoriser les modifications pendant 60 minutes pour lui dans Compte → Applications connectées, un tel outil répond par un résultat qui commence par Refused (step_up_required): et ne change rien. emptyAudience ne demande jamais de code. La page Authentification de l'API liste chaque outil qui en demande un, et montre comment demander un code et le vérifier.
Référence
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.
Entrées
Ne prend aucune entrée.
Aussi disponible dans
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.
Entrées
Ne prend aucune entrée.
Aussi disponible dans
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.
Entrées
daysinteger | string
Aussi disponible dans
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.
Entrées
Ne prend aucune entrée.
Aussi disponible dans
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.
Entrées
Ne prend aucune entrée.
Aussi disponible dans
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.
Entrées
Ne prend aucune entrée.
Aussi disponible dans
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.
- Demande un code de vérification
PATCH /billing/pay-as-you-go
Entrées
enabledbooleanObligatoirethemestringLight or dark, for the page the link opens. Left out, it follows the browser.
L'un de"light""dark"localestringA language tag such as de or pt-PT, for the page the link opens.
Jusqu'à 35 caractères
Aussi disponible dans
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.
- Demande un code de vérification
PUT /billing/pay-as-you-go/limit
Entrées
limitCentsintegerObligatoireOne of 1000, 2500, 5000, 10000, 25000, 50000, 100000, 250000, 500000.
Aussi disponible dans
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.
- Demande un code de vérification
POST /billing/pay-as-you-go/confirm
Entrées
Ne prend aucune entrée.
Aussi disponible dans
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.
- Demande un code de vérification
POST /billing/checkout
Entrées
planstringObligatoire- L'un de
"starter""business""enterprise" intervalstring- L'un de
"month""year" themestringLight or dark, for the page the link opens. Left out, it follows the browser.
L'un de"light""dark"localestringA language tag such as de or pt-PT, for the page the link opens.
Jusqu'à 35 caractères
Aussi disponible dans
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.
- Demande un code de vérification
POST /billing/portal
Entrées
themestringLight or dark, for the page the link opens. Left out, it follows the browser.
L'un de"light""dark"localestringA language tag such as de or pt-PT, for the page the link opens.
Jusqu'à 35 caractères
Aussi disponible dans
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.
Entrées
pageinteger- Au moins 1
limitinteger- Au moins 1Au plus 100
sortstring- L'un de
"newest""oldest" searchstring- Jusqu'à 120 caractères
Aussi disponible dans
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.
Entrées
orderIdstringObligatoire- Non vide
Aussi disponible dans
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.
- Demande un code de vérification
PUT /billing/invoices/{orderId}/details
Entrées
orderIdstringObligatoire- Non vide
namestringObligatoire- De 1 à 200 caractères
line1stringObligatoire- De 1 à 200 caractères
line2string- Jusqu'à 200 caractères
citystringObligatoire- De 1 à 120 caractères
postalCodestring- Jusqu'à 40 caractères
statestring- Jusqu'à 60 caractères
countrystringObligatoire- L'un 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"