Kalo te dokumentacioni
CLI

openemail billing

Çdo komandë në këtë hapësirë emrash, me argumentet, flamujt dhe shembujt e saj.

Komandat

The plan of the workspace and what it costs, as Plans & Billing shows them: the plan and its usage, 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. Only the workspace owner reaches it, and nothing is paid through the API.

Çdo komandë këtu pranon edhe flamujt globalë, si --json, --profile dhe --dry-run. Shihni flamujt globalë

openemail billing get

Read the plan

Lejetbilling:readKërkon hyrjePseudonimeshowview

Përdorimi

openemail billing get [flags]

Resolves the plan of the 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. metered is false when billing is off on the 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 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Shembuj

openemail billing get
Print the raw JSON
openemail billing get --json

E disponueshme edhe në

API
GET /billing
SDK
billing.get()

openemail billing list-plans

List the plans

Lejetbilling:readKërkon hyrje

Përdorimi

openemail billing list-plans [flags]

Resolves every plan, cheapest first, with its price in US cents and what it includes. available says whether it is sold on the 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 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Shembuj

openemail billing list-plans
Print the raw JSON
openemail billing list-plans --json

E disponueshme edhe në

API
GET /billing/plans
SDK
billing.listPlans()

openemail billing get-usage

Read the usage history

Lejetbilling:readKërkon hyrje

Përdorimi

openemail billing get-usage [flags]

Resolves the sends and AI actions of each day, and what pay as you go extras cost each 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 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Flamujt

--days <value>

How many days back to go, from 1 to 3,660, or all for every day since the workspace was made. The server defaults to 30.

Parazgjedhja30

Shembuj

openemail billing get-usage
With optional flags
openemail billing get-usage --days 90
Print the raw JSON
openemail billing get-usage --json

E disponueshme edhe në

API
GET /billing/usage
SDK
billing.getUsage()

openemail billing list-alerts

List the billing alerts

Lejetbilling:readKërkon hyrje

Përdorimi

openemail billing list-alerts [flags]

Resolves 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 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Shembuj

openemail billing list-alerts
Print the raw JSON
openemail billing list-alerts --json

E disponueshme edhe në

API
GET /billing/alerts
SDK
billing.listAlerts()

openemail billing list-countries

List the billing countries

Lejetbilling:readKërkon hyrje

Përdorimi

openemail billing list-countries [flags]

Resolves every country a billing address can be in, as the two-letter ISO 3166 codes saveInvoiceDetails takes as country.

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 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Shembuj

openemail billing list-countries
Print the raw JSON
openemail billing list-countries --json

E disponueshme edhe në

API
GET /billing/countries
SDK
billing.listCountries()

openemail billing get-pay-as-you-go

Read pay as you go

Lejetbilling:readKërkon hyrje

Përdorimi

openemail billing get-pay-as-you-go [flags]

Resolves pay as you go on the workspace: whether usage past the allowances is billed, the monthly limit and what extras cost so far, the current billing period once it is set up, the limits that can be chosen and the prices.

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 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Shembuj

openemail billing get-pay-as-you-go
Print the raw JSON
openemail billing get-pay-as-you-go --json

E disponueshme edhe në

API
GET /billing/pay-as-you-go
SDK
billing.getPayAsYouGo()

openemail billing set-pay-as-you-go

Turn pay as you go on or off

Lejetbilling:writeKërkon hyrje

Përdorimi

openemail billing set-pay-as-you-go --enabled [flags]
openemail billing set-pay-as-you-go --data <json|@file|-> [flags]

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 confirmPayAsYouGo after they return.

Nothing is paid through the API: the person pays, changes the card or cancels on the billing provider's page the link opens, 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 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Flamujt

--enabled

true to turn it on, false to turn it off. Required, here or in --data.

--theme <value>

light or dark, for the page the link opens.

--locale <value>

A language tag such as de or pt-PT, for the page the link opens.

--data <json|@file|->

The whole body as JSON, inline, from a file with @path, or - for standard input. Flags override its keys.

Shembuj

openemail billing set-pay-as-you-go --enabled
Read the whole body from a JSON file
openemail billing set-pay-as-you-go --data @billing.json

E disponueshme edhe në

API
PATCH /billing/pay-as-you-go
SDK
billing.setPayAsYouGo()

openemail billing set-pay-as-you-go-limit

Set the pay as you go limit

Lejetbilling:writeKërkon hyrje

Përdorimi

openemail billing set-pay-as-you-go-limit --limit-cents <n> [flags]
openemail billing set-pay-as-you-go-limit --data <json|@file|-> [flags]

Sets the monthly spending limit of pay as you go, in US cents, one of the amounts getPayAsYouGo 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 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Flamujt

--limit-cents <n>

The limit in US cents: 1,000, 2,500, 5,000, 10,000, 25,000, 50,000, 100,000, 250,000 or 500,000. Required, here or in --data.

--data <json|@file|->

The whole body as JSON, inline, from a file with @path, or - for standard input. Flags override its keys.

Shembuj

openemail billing set-pay-as-you-go-limit --limit-cents 1
Read the whole body from a JSON file
openemail billing set-pay-as-you-go-limit --data @billing.json

E disponueshme edhe në

API
PUT /billing/pay-as-you-go/limit
SDK
billing.setPayAsYouGoLimit()

openemail billing confirm-pay-as-you-go

Confirm pay as you go

Lejetbilling:writeKërkon hyrje

Përdorimi

openemail billing confirm-pay-as-you-go [flags]

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.

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 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Shembuj

openemail billing confirm-pay-as-you-go
Print the raw JSON
openemail billing confirm-pay-as-you-go --json

E disponueshme edhe në

API
POST /billing/pay-as-you-go/confirm
SDK
billing.confirmPayAsYouGo()

openemail billing start-checkout

Start a checkout

Lejetbilling:writeKërkon hyrje

Përdorimi

openemail billing start-checkout --plan <value> [flags]
openemail billing start-checkout --data <json|@file|-> [flags]

Starts buying a paid plan for a workspace on Free, as choosing a plan in the app does, and resolves with 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 with openPortal instead.

Nothing is paid through the API: the person pays, changes the card or cancels on the billing provider's page the link opens, 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 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Flamujt

--plan <value>

starter, business or enterprise. Required, here or in --data.

--interval <value>

month or year. Defaults to month.

--theme <value>

light or dark, for the page the link opens.

--locale <value>

A language tag such as de or pt-PT, for the page the link opens.

--data <json|@file|->

The whole body as JSON, inline, from a file with @path, or - for standard input. Flags override its keys.

Shembuj

The required values only
openemail billing start-checkout --plan business
With optional flags
openemail billing start-checkout --plan business --interval year
Read the whole body from a JSON file
openemail billing start-checkout --data @billing.json

E disponueshme edhe në

API
POST /billing/checkout
SDK
billing.startCheckout()

openemail billing open-portal

Open the billing portal

Lejetbilling:writeKërkon hyrje

Përdorimi

openemail billing open-portal [flags]

Resolves with 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 is paid through the API: the person pays, changes the card or cancels on the billing provider's page the link opens, 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 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Flamujt

--theme <value>

light or dark, for the page the link opens.

--locale <value>

A language tag such as de or pt-PT, for the page the link opens.

--data <json|@file|->

The whole body as JSON, inline, from a file with @path, or - for standard input. Flags override its keys.

Shembuj

openemail billing open-portal
With optional flags
openemail billing open-portal --theme dark

E disponueshme edhe në

API
POST /billing/portal
SDK
billing.openPortal()

openemail billing list-invoices

List the charges

Lejetbilling:readKërkon hyrje

Përdorimi

openemail billing list-invoices [flags]

Resolves every charge of the workspace with the state of its invoice, a page at a time, as History on Plans & Billing lists them. search matches the plan, the invoice number, the charge id and the name billed.

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 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Flamujt

--page <n>

Which page, from 1.

Parazgjedhja1
--limit <n>

Charges per page, from 1 to 100. The server defaults to 25.

Parazgjedhja25
--sort <value>

newest, the default, or oldest.

Parazgjedhja"newest"
--search <value>

Words to look for, up to 120 characters.

Shembuj

openemail billing list-invoices
With optional flags
openemail billing list-invoices --limit 10
Print the raw JSON
openemail billing list-invoices --json

E disponueshme edhe në

API
GET /billing/invoices
SDK
billing.listInvoices()

openemail billing get-invoice

Get the invoice of a charge

Lejetbilling:readKërkon hyrje

Përdorimi

openemail billing get-invoice <order-id> [flags]

Resolves with 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, 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 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Argumentet

<order-id>E detyrueshme

The charge id, as listInvoices returns it.

Shembuj

openemail billing get-invoice order_4c1b257a
Print the raw JSON
openemail billing get-invoice order_4c1b257a --json

E disponueshme edhe në

API
GET /billing/invoices/{orderId}
SDK
billing.getInvoice()

openemail billing save-invoice-details

Save the billing details of a charge

Lejetbilling:writeKërkon hyrje

Përdorimi

openemail billing save-invoice-details <order-id> --name <value> --line1 <value> --city <value> --country <value> [flags]
openemail billing save-invoice-details <order-id> --data <json|@file|-> [flags]

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.

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 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Argumentet

<order-id>E detyrueshme

The charge id, as listInvoices returns it.

Flamujt

--name <value>

Who is billed, up to 200 characters. Required, here or in --data.

--line1 <value>

The street address, up to 200 characters. Required, here or in --data.

--line2 <value>

A flat, suite or building, up to 200 characters.

--city <value>

Up to 120 characters. Required, here or in --data.

--postal-code <value>

Up to 40 characters.

--state <value>

The state or region, up to 60 characters. In the US and Canada, its two-letter code.

--country <value>

A two-letter ISO 3166 code, one of those listCountries returns. Required, here or in --data.

--data <json|@file|->

The whole body as JSON, inline, from a file with @path, or - for standard input. Flags override its keys.

Shembuj

The required values only
openemail billing save-invoice-details order_4c1b257a --name 'Acme Ltd' --line1 '1 Market Street' --city London --country GB
With optional flags
openemail billing save-invoice-details order_4c1b257a --name 'Acme Ltd' --line1 '1 Market Street' --city London --country GB --postal-code 'EC1A 1AA'
Read the whole body from a JSON file
openemail billing save-invoice-details order_4c1b257a --data @billing.json

E disponueshme edhe në

API
PUT /billing/invoices/{orderId}/details
SDK
billing.saveInvoiceDetails()