​

billing

orc billing inspects the organization contract, credit balance, invoices, and monthly spending that apply to a Workspace. Configure JPY spending limits and automatic recharge, quote additional usage credits, and proceed to Stripe checkout.

Log in and verify the target Workspace before execution. Select it with --workspace; the contract and billing destination belong to the parent organization billing account. Changes to spending limits and automatic recharge, purchases, and access to the contract management portal require a human organization owner or admin. API keys and service accounts cannot perform these operations.

Inspect the target Workspace contract

Inspect spending this month

--json returns an envelope containing success, data, and metadata. Read field details in data. Credit balance, purchase price, and monthly spending have different purposes; do not treat them as the same value.

Returns a snapshot of the organization contract applied to the Workspace. Inspect the plan, seat count, API credit balance, entitlements and usage, Stripe subscription state, cancellation scheduled for period end, and contract period end. current_period_end is returned when available; it is not an expiry for each credit bucket.

Inspect contract and balance

Receive the contract snapshot as JSON

Returns the latest 12 invoices for the Workspace parent billing account. Includes invoice ID, issue timestamp, description, payment state, amount, currency, and invoice URL when available. Returns an empty list for an unregistered billing destination.

List invoices

Creates an administrator Stripe contract management session and opens the returned URL in the default browser. Use it to manage the registered billing destination, payment methods, and subscription. Check the outcome of actions in the browser.

Return the billing URL without opening a browser

Type: boolean. Optional.

Open contract management

Returns spending and the spending limit for the current month in Asia/Tokyo, in JPY. used is posted spending and reserved is reserved spending. Both become null when pricing cannot be calculated; do not treat them as zero spending. Also returns periodStart, periodEnd, revision, and canManage indicating whether settings can be changed.

Inspect monthly spending and limit

Save the spending limit with limit and the most recently retrieved revision. limit is an integer in JPY from 0 to 1,000,000,000; null means no limit. Do not supply currency. This changes settings only and does not purchase credits. Supply all required input; omitted fields do not produce a partial update.

(required) Body field: revision

Type: number. Optional.

Read settings before changing the limit

Review the limit update request

Save the limit

Returns automatic recharge enabled, JPY thresholdJpy and targetJpy, revision, management permission canManage, and saved payment method eligibility available and unavailableReason. Reading does not charge.

Inspect automatic recharge state

Supply enabled, thresholdJpy, targetJpy, and the retrieved revision. The threshold is an integer from 0 to 99,999,999 JPY and the target balance from 1 to 99,999,999 JPY; the target must exceed the threshold by at least 50 JPY. Applies to the purchased JPY balance. When balance reaches or falls below the threshold, the setting purchases the shortfall to reach the target. Enabling requires a saved card or Link eligible for automatic payment. Changes require confirmation; pass --yes in non-interactive environments.

(required) Body field: enabled

Type: string. Optional.

(required) Body field: revision

Type: number. Optional.

(required) Body field: targetJpy

Type: number. Optional.

(required) Body field: thresholdJpy

Type: number. Optional.

Review changes in advance

Confirm and save settings

Start Stripe Checkout with amountJpy, UUID attemptId, and Unix millisecond attemptAt. This operation does not take calculationId. After CLI confirmation, open checkout, verify the billing destination and final tax-inclusive total in Stripe, and pay. Non-interactive execution requires --yes. A successful url response means checkout was created, not that payment or a credit grant completed.

(required) Body field: amountJpy

Type: number. Optional.

(required) Body field: attemptAt

Type: number. Optional.

(required) Body field: attemptId

Type: string. Optional.

Return the billing URL without opening a browser

Type: boolean. Optional.

Review the purchase attempt request

Proceed to checkout after confirmation

Use the same file when retrying. Check payment state before creating a new attempt.

Resend the same purchase attempt

Supply the JPY value of usage credits to purchase as amountJpy, an integer from 1 to 99,999,999. Returns creditAmountJpy, discount amount and rate, tax, total including tax, Stripe tax calculation ID calculationId, and expiresAt in Unix seconds. This quotes using the billing destination; it does not purchase or grant credits.

(required) Body field: amountJpy

Type: number. Optional.

Quote 15,000 JPY of usage credits

revision is an example. Replace it with the latest get response for the target Workspace. Set limit to null for no limit.

Monthly spending limit input

Use the latest revision. Once enabled, the saved payment method is charged when the configured conditions are met.

Automatic recharge settings input

After checking the quote amount, discount, tax, and expiry, create an attempt file once per purchase. Retain that saved file when retrying the same purchase.

Prepare a purchase attempt from a quote

Do not consider a purchase complete just because the browser opened. Check the checkout result and its reflection in the contract and invoices.

Check state after payment

Before purchasing, check amount and tax with purchase quote, and prepare an attempt for the same amountJpy. purchase create requests confirmation and opens the returned Stripe Checkout URL. Final tax and billing destination review and payment take place in Stripe. The quote calculationId identifies a tax calculation; it is not a purchase authorization ID.

attemptAt is the creation time in Unix milliseconds. The server rejects attempts older than 23 hours or more than 60 seconds in the future. On communication failure, retain attemptId and attemptAt when retrying; check payment state first for old attempts.

For spending limits and automatic recharge, pass the revision retrieved by get to update. The confirmation-required purchase create and auto-recharge update operations need --yes when execution cannot be interactive. --dry-run reviews the planned request; it does not guarantee server authorization, billing destination checks, or amount calculation will succeed.

Reads also require authentication and access to the target Workspace. Run monthly-spend update, auto-recharge update, purchase create, and portal in a human organization owner or admin session. If permissions are insufficient, ask an organization administrator rather than retrying credentials to bypass the restriction.

The following global options can be used with orc billing:

For details and examples, see global options.

Check the target Workspace and logged-in organization. Billing changes require a human owner/admin session. Expanding API key permissions does not remove this restriction.

For a revision conflict, run get again, inspect current settings, and rebuild the needed change. Do not repeatedly send an old revision.

Quotes require a billing destination. Enabling automatic recharge also requires a payment method eligible for automatic payment. Check available and unavailableReason from auto-recharge get; an administrator can configure billing information in billing portal.

Do not treat Checkout URL creation as payment completion. Check Stripe, current, and invoices. Retain the attempt while retrying the same purchase. If an incomplete previous automatic charge prevents settings changes, follow the displayed guidance instead of changing amounts to bypass it.

Pricing cannot be calculated. Do not replace used and reserved with zero; check the pricing state. When handling API or network failures in scripts, use exit codes rather than stderr wording.