CLI: Billing and databases
Read plans, subscriptions and usage, and manage your project databases (backups, pause, resume, resize) with sov.
sov billing
Billing plans, subscriptions, and usage
sov billing plans
List public billing plans.
sov billing plans [OPTIONS]- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing plan
Fetch one billing plan by name.
sov billing plan [OPTIONS] NAMEArguments and options
NAMEtextrequired- Plan name
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing subscription
Fetch the active subscription for an organisation.
sov billing subscription [OPTIONS] ORG_IDArguments and options
ORG_IDtextoptional- Organisation ID (defaults to scoped org)
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing set-subscription
Create or update an organisation subscription.
sov billing set-subscription [OPTIONS] ORG_IDArguments and options
ORG_IDtextrequired- Organisation ID
--plantextrequired- Plan name
--cycletextoptionaldefaultmonthly- monthly or annual
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing cancel-subscription
Cancel an organisation subscription.
sov billing cancel-subscription [OPTIONS] ORG_IDArguments and options
ORG_IDtextrequired- Organisation ID
--immediateflagoptional- Cancel immediately
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing usage
Fetch usage counters for an organisation.
sov billing usage [OPTIONS] ORG_IDArguments and options
ORG_IDtextoptional- Organisation ID (defaults to scoped org)
--periodtextoptional- Usage period
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing usage-history
Fetch historical usage for an organisation.
sov billing usage-history [OPTIONS] ORG_IDArguments and options
ORG_IDtextoptional- Organisation ID (defaults to scoped org)
--monthsint rangeoptionaldefault6
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing subscriptions
List all subscriptions (platform admin).
sov billing subscriptions [OPTIONS]- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing invoices
List invoices for an organisation.
sov billing invoices [OPTIONS] ORG_IDArguments and options
ORG_IDtextoptional- Organisation ID (defaults to scoped org)
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing compute
Fetch compute usage breakdown for an organisation.
sov billing compute [OPTIONS] ORG_IDArguments and options
ORG_IDtextrequired- Organisation ID
--periodtextoptional- Billing period YYYY-MM
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing build-invoice
Build an invoice for an organisation billing period.
sov billing build-invoice [OPTIONS] ORG_IDArguments and options
ORG_IDtextrequired- Organisation ID
--periodtextoptional- Billing period YYYY-MM
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing checkout
Create a hosted billing checkout session.
sov billing checkout [OPTIONS]Arguments and options
--plantextrequired- Plan name (pro|ultra)
--cycletextoptionaldefaultmonthly- monthly or annual
--emailtextoptional--providertextoptional- stripe or razorpay
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing provider
Show the active billing payment provider.
sov billing provider [OPTIONS]- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing fx
Fetch billing FX rates.
sov billing fx [OPTIONS]- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing overage
Fetch overage billing details for an organisation.
sov billing overage [OPTIONS] ORG_IDArguments and options
ORG_IDtextoptional- Organisation ID (defaults to scoped org)
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing open-invoice
Fetch the caller's open invoice for the scoped organisation.
sov billing open-invoice [OPTIONS]- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing pay-invoice
Pay an invoice for an organisation billing period.
sov billing pay-invoice [OPTIONS] ORG_ID PERIODArguments and options
ORG_IDtextrequired- Organisation ID
PERIODtextrequired- Invoice period YYYY-MM
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing razorpay create-order
Create a Razorpay order for self-serve checkout.
sov billing razorpay create-order [OPTIONS]Arguments and options
--plantextrequired- Plan name (pro|ultra)
--cycletextoptionaldefaultmonthly- monthly or annual
--emailtextoptional--accounttextoptional
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing razorpay verify
Verify a Razorpay payment signature and activate the plan.
sov billing razorpay verify [OPTIONS]Arguments and options
--order-idtextrequired--payment-idtextrequired--signaturetextrequired
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing account get
Fetch a billing account.
sov billing account get [OPTIONS] ACCOUNT_IDArguments and options
ACCOUNT_IDtextrequired- Billing account ID
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing account cancel
Cancel a billing account subscription.
sov billing account cancel [OPTIONS] ACCOUNT_IDArguments and options
ACCOUNT_IDtextrequired- Billing account ID
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov billing account resume
Resume a cancelled billing account.
sov billing account resume [OPTIONS] ACCOUNT_IDArguments and options
ACCOUNT_IDtextrequired- Billing account ID
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance
Platform governance and tenant databases
sov governance regions
List configured governance regions.
sov governance regions [OPTIONS]- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance regions-available
List regions with available capacity for provisioning.
sov governance regions-available [OPTIONS]Arguments and options
--sizetextoptionaldefaultmicro- Compute size filter
--plantextoptional- Optional plan filter
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance region-patch
Patch governance region metadata.
sov governance region-patch [OPTIONS] REGION_IDArguments and options
REGION_IDtextrequired- Region ID
--labeltextoptional--statustextoptional--default / --no-defaultflagoptional
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance tenants
List registered tenants.
sov governance tenants [OPTIONS]- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance tenant-get
Fetch one tenant record.
sov governance tenant-get [OPTIONS] ORG_IDArguments and options
ORG_IDtextrequired- Organisation / tenant ID
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance tenant-status
Update tenant lifecycle status.
sov governance tenant-status [OPTIONS] ORG_IDArguments and options
ORG_IDtextrequired- Organisation / tenant ID
--statustextrequired- active | suspended | deleted
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance tenant-databases
List databases provisioned for a tenant.
sov governance tenant-databases [OPTIONS] ORG_IDArguments and options
ORG_IDtextrequired- Organisation / tenant ID
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance db-provision
Provision a dedicated database for a tenant project.
sov governance db-provision [OPTIONS] ORG_IDArguments and options
ORG_IDtextrequired- Organisation / tenant ID
--tiertextoptionaldefaultdedicated--compute-sizetextoptional--regiontextoptional
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance db-connection
Fetch database connection metadata (password redacted).
sov governance db-connection [OPTIONS] ORG_ID PROJECT_IDArguments and options
ORG_IDtextrequired- Organisation / tenant ID
PROJECT_IDtextrequired- Project ID
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance db-connection-reveal
Reveal database password using an active JIT grant.
sov governance db-connection-reveal [OPTIONS] ORG_ID PROJECT_IDArguments and options
ORG_IDtextrequired- Organisation / tenant ID
PROJECT_IDtextrequired- Project ID
--grant-idtextrequired- Active JIT grant ID
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance db-pause
Pause a tenant database.
sov governance db-pause [OPTIONS] ORG_ID PROJECT_IDArguments and options
ORG_IDtextrequired- Organisation / tenant ID
PROJECT_IDtextrequired- Project ID
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance db-resume
Resume a paused tenant database.
sov governance db-resume [OPTIONS] ORG_ID PROJECT_IDArguments and options
ORG_IDtextrequired- Organisation / tenant ID
PROJECT_IDtextrequired- Project ID
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance db-resize
Resize a tenant database compute profile.
sov governance db-resize [OPTIONS] ORG_ID PROJECT_IDArguments and options
ORG_IDtextrequired- Organisation / tenant ID
PROJECT_IDtextrequired- Project ID
--compute-sizetextrequired- Target compute size
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance db-reconcile
Backfill tenant Postgres mirrors (policies, functions, platform schemas).
sov governance db-reconcile [OPTIONS] ORG_ID PROJECT_IDArguments and options
ORG_IDtextrequired- Organisation / tenant ID
PROJECT_IDtextrequired- Project ID
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance db-backups
List database backups for a tenant project.
sov governance db-backups [OPTIONS] ORG_ID PROJECT_IDArguments and options
ORG_IDtextrequired- Organisation / tenant ID
PROJECT_IDtextrequired- Project ID
--limitint rangeoptionaldefault5
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance db-backup-trigger
Trigger a manual database backup.
sov governance db-backup-trigger [OPTIONS] ORG_ID PROJECT_IDArguments and options
ORG_IDtextrequired- Organisation / tenant ID
PROJECT_IDtextrequired- Project ID
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance db-delete
Delete a tenant database (optionally after snapshot).
sov governance db-delete [OPTIONS] ORG_ID PROJECT_IDArguments and options
ORG_IDtextrequired- Organisation / tenant ID
PROJECT_IDtextrequired- Project ID
--snapshot / --no-snapshotflagoptional--yes / -yflagoptional- Skip confirmation
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance hosts
List governance hosts.
sov governance hosts [OPTIONS]Arguments and options
--region-idtextoptional
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance host-patch
Patch governance host metadata.
sov governance host-patch [OPTIONS] HOST_IDArguments and options
HOST_IDtextrequired- Host ID
--statustextoptional--addresstextoptional--total-vcpunumberoptional--total-memory-mbintegeroptional--total-storage-gbintegeroptional
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov governance project-metrics
Fetch governance metrics for one project.
sov governance project-metrics [OPTIONS] PROJECT_IDArguments and options
PROJECT_IDtextoptional- Project ID (defaults to scoped project)
--sincetextoptionaldefault24- Hours or ISO timestamp
--limitint rangeoptionaldefault500
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.