billing

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

openship billing

Manage Cloud plans, server subscriptions, usage and payment checkouts

openship billing [options] [command]

Subcommand	Purpose
`plans [options]`	Show the current plan catalog and prices
`quote [options]`	Quote custom server capacity using current catalog pricing
`state [options]`	Show the effective plan, allowance and billing state
`resources [options]`	Show measured compute and traffic usage
`allowances [options]`	Show allowance use and the resources consuming it
`alerts`	Show credit and funding alerts
`usage [options]`	Read metered usage for a date range
`portal [options]`	Create a link to manage this subscription's payments
`subscription`	Purchase, inspect or change a managed server subscription
`change`	Preview and confirm a subscription change with its exact quote
`checkout`	Recover existing payment checkouts without creating another purchase
`topup`	Add usage credit through a payment checkout

Show credit and funding alerts

openship billing alerts [options]

Show allowance use and the resources consuming it

openship billing allowances [options]

Option	Meaning
`--server <id>`	Use this managed server's billing workspace
`--workspace <id>`	Billing workspace ID, including retained subscriptions

Show the current plan catalog and prices

openship billing plans [options]

Option	Meaning
`--locale <locale>`	Catalog language

Create a link to manage this subscription's payments

openship billing portal [options]

Option	Meaning
`--server <id>`	Use this managed server's billing workspace
`--workspace <id>`	Billing workspace ID, including retained subscriptions

Quote custom server capacity using current catalog pricing

openship billing quote [options]

Show measured compute and traffic usage

openship billing resources [options]

Option	Meaning
`--server <id>`	Use this managed server's billing workspace
`--workspace <id>`	Billing workspace ID, including retained subscriptions

Show the effective plan, allowance and billing state

openship billing state [options]

Option	Meaning
`--server <id>`	Use this managed server's billing workspace
`--workspace <id>`	Billing workspace ID, including retained subscriptions

Add usage credit through a payment checkout

openship billing topup [options] [command]

Subcommand	Purpose
`packs`	List current funding packages
`create [options] <pack>`	Create a top-up checkout; complete payment at the returned URL

Create a top-up checkout; complete payment at the returned URL

openship billing topup create [options] <pack>

Argument	Meaning
`pack`	Pack ID from topup packs

Option	Meaning
`--server <id>`	Use this managed server's billing workspace
`--workspace <id>`	Billing workspace ID, including retained subscriptions
`--idempotency-key <key>`	Stable key for this top-up request

List current funding packages

openship billing topup packs [options]

Read metered usage for a date range

openship billing usage [options]

Option	Meaning
`--server <id>`	Use this managed server's billing workspace
`--workspace <id>`	Billing workspace ID, including retained subscriptions
`--from <timestamp>`	Start timestamp
`--to <timestamp>`	End timestamp
`--group-by <period>`	Usage bucket size (choices: "hour", "day")