Farther ShoreDocs
Go to Farther Shore
Choose CLI and MCP operations
CLI reference
Platform operation catalog
MCP tool reference
Global CLI options
CLI: auth
CLI: login
CLI: logout
CLI: skills
CLI: docs
CLI: business
CLI: apply-timeline
CLI: proposal
CLI: env
CLI: plan
CLI: commercial-release
CLI: persona
CLI: usage
CLI: analytics
CLI: operations
CLI: organization
CLI: token
CLI: stripe
CLI: service-account
CLI: limit
farthershore limitfarthershore limit listfarthershore limit setfarthershore limit remove
CLI: audit-log
CLI: notifications
CLI: backend
CLI: frontend
CLI: webhook
CLI: agents
CLI: bulletin
CLI: promo-code
CLI: consumer
CLI: variables
CLI: agreements
CLI: tax-settings
CLI: resource-count
CLI: denial
CLI: dependents
CLI: workflow-control
CLI: automation
CLI: knowledge
CLI: link
CLI: unlink
CLI: create
CLI: import
CLI: build
CLI: validate
CLI: workflows
Status
Docs/Complete reference/CLI: limit

CLI: limit

Complete help for farthershore limit and every subcommand.

farthershore limit

Usage: farthershore limit [options] [command]

Manage subscriber-owned usage limits with a portal consumer session

Options:
  -h, --help                               display help for command

Commands:
  list [options] <businessId>
  set [options] <businessId>
  remove [options] <businessId> <limitId>
  help [command]                           display help for command

farthershore limit list

Usage: farthershore limit list [options] <businessId>

Options:
  --limit <count>                   Maximum rows (1-100; default 100)
  --offset <count>                  Rows to skip (default 0)
  --environment-id <uuid>           Portal environment UUID (or
                                    FARTHERSHORE_ENVIRONMENT_ID).
  --subscriber-organization <uuid>  Subscriber organization UUID (or
                                    FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).
  -h, --help                        display help for command

farthershore limit set

Usage: farthershore limit set [options] <businessId>

Options:
  --quantity <key>                  Meter quantity key
  --mode <mode>                     BLOCK or NOTIFY (required on create)
  --limit-id <id>                   Existing limit id to update
  --scope <scope>                   ORG, MEMBER, or SERVICE_ACCOUNT (default:
                                    "ORG")
  --subject-id <id>                 Membership or service-account id
  --units <count>                   Unit capacity
  --cents <count>                   Spend capacity in cents
  --notify-at <fraction>            Notification threshold fraction
  --environment-id <uuid>           Portal environment UUID (or
                                    FARTHERSHORE_ENVIRONMENT_ID).
  --subscriber-organization <uuid>  Subscriber organization UUID (or
                                    FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).
  -h, --help                        display help for command

farthershore limit remove

Usage: farthershore limit remove [options] <businessId> <limitId>

Options:
  --environment-id <uuid>           Portal environment UUID (or
                                    FARTHERSHORE_ENVIRONMENT_ID).
  --subscriber-organization <uuid>  Subscriber organization UUID (or
                                    FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).
  -h, --help                        display help for command
PreviousCLI: service-accountNextCLI: audit-log

On this page

farthershore limitfarthershore limit listfarthershore limit setfarthershore limit remove