Modal logo
Changelog API Reference modal.Appmodal.Clientmodal.CloudBucketMountmodal.Clsmodal.Cronmodal.Dictmodal.Errormodal.FilePatternMatchermodal.Functionmodal.FunctionCallmodal.Imagemodal.Periodmodal.Proxymodal.Queuemodal.Retriesmodal.Sandboxmodal.SandboxSnapshotmodal.Secretmodal.Tunnelmodal.Volumemodal.asgi_appmodal.batchedmodal.billingmodal.call_graphmodal.concurrentmodal.container_processmodal.current_function_call_idmodal.current_input_idmodal.enable_outputmodal.entermodal.exitmodal.fastapi_endpointmodal.file_iomodal.forwardmodal.gpumodal.interactmodal.io_streamsmodal.is_localmodal.methodmodal.parametermodal.web_endpointmodal.web_servermodal.wsgi_appmodal.exceptionmodal.config CLI Reference modal appmodal billingmodal changelogmodal configmodal containermodal dashboardmodal deploymodal dictmodal environmentmodal launchmodal profilemodal queuemodal runmodal secretmodal servemodal setupmodal shellmodal tokenmodal volume

modal billing

View workspace billing information.

Usage:

Options:

  • --help: Show this message and exit.

Commands:

  • report: Generate a billing report for the workspace.

Generate a billing report for the workspace.

The report range can be provided by setting --start / --end dates (--end defaults to ‘now’) or by requesting a date range using --for (e.g., --for today, --for 'last month').

This command provides a CLI frontend for the modal.billing.workspace_billing_report API.

Note that, as with the API, the start date is inclusive and the end date is exclusive. Data will be reported for full intervals only. Using --for is a convenient way to define a complete interval.

Examples:

Usage:

Options:

  • --start TEXT: Start date. Date (in UTC by default): ISO format (2025-01-01) or relative (yesterday, 3 days ago, etc.).
  • --end TEXT: End date. Date (in UTC by default): ISO format (2025-01-01) or relative (yesterday, 3 days ago, etc.). Defaults to now.
  • --for TEXT: Convenience range: today, yesterday, this week, last week, this month, last month.
  • -r, --resolution TEXT: Time resolution: ‘d’ (daily) or ‘h’ (hourly). [default: d]
  • --tz TEXT: Timezone for date interpretation: ‘local’, offset (5, -4, +05:30), or IANA name. Requires hourly resolution.
  • -t, --tag-names TEXT: Comma-separated list of tag names to include.
  • --json: Output as JSON.
  • --csv: Output as CSV.
  • --help: Show this message and exit.