CLI: agreements
Complete help for farthershore agreements and every subcommand.
farthershore agreements
Usage: farthershore agreements [options] [command]
Options:
-h, --help display help for command
Commands:
list [options] [businessIdOrSlug] List a business's economic agreements
show [businessIdOrSlug] [agreementId] Show one economic agreement with its version history
pins [businessIdOrSlug] [subscriptionId] Read a subject's subscription pins (recurring-price pin + usage-pricing binding). Read-only; migrate-to-latest is deferred.
create [options] [businessIdOrSlug] Create an economic agreement (confirm-gated: previews first; pass --confirm <token> to commit)
amend [options] [businessIdOrSlug] [agreementId] Amend an agreement's contract terms (append-only; confirm-gated: previews first; pass --confirm <token> to commit)
help [command] display help for command
farthershore agreements list
Usage: farthershore agreements list [options] [businessIdOrSlug]
List a business's economic agreements
Options:
--subject <subscriptionId> Filter by subject (subscription) id.
--env <slug> Preview environment slug or id (omit for
production).
-h, --help display help for command
farthershore agreements show
Usage: farthershore agreements show [options] [businessIdOrSlug] <agreementId>
Show one economic agreement with its version history
Options:
-h, --help display help for command
farthershore agreements pins
Usage: farthershore agreements pins [options] [businessIdOrSlug] <subscriptionId>
Read a subject's subscription pins (recurring-price pin + usage-pricing
binding). Read-only; migrate-to-latest is deferred.
Options:
-h, --help display help for command
farthershore agreements create
Usage: farthershore agreements create [options] [businessIdOrSlug]
Create an economic agreement (confirm-gated: previews first; pass --confirm
<token> to commit)
Options:
--subject <subscriptionId> The subject (subscription) the agreement binds.
--binding <mode> Usage-pricing binding: current | current_with_contract_terms | fixed_version.
--policy <pricingPolicyId> The pricing policy to bind.
--policy-version <pricingPolicyVersionId> fixed_version only: the immutable policy version to pin.
--new-meter-policy <policy> What a never-negotiated meter does: adopt_at_current_rate | exclude_until_renewal | require_amendment (default require_amendment).
--new-measure-policy <policy> What a new measure on an agreed meter does: adopt_at_current_rate | exclude_until_renewal | require_amendment (default require_amendment).
--terms-json <json> Negotiated contract terms as JSON: {"percentDiscount":{"num":"1","den":"5"},"floorNanos":"…","capNanos":"…","selectorScope":[{"kind":"provider_model_glob","provider":"acme","modelGlob":"acme-*"}]}. Required for current_with_contract_terms and for amend.
--effective-at <iso> When the agreement/version takes effect (ISO-8601). Default: now.
--expires-at <iso> Optional expiry (ISO-8601).
--env <slug> Preview environment slug or id (omit for production).
--confirm <token> The confirmationToken returned by the preview run. Omit to preview only.
--idempotency-key <key> Required for this mutation. Generate it once and reuse the exact value on retry.
-h, --help display help for command
Two-step: run once to PREVIEW (prints the effect + confirmationToken; nothing is written), then re-run the SAME command with --confirm <token> to commit.
farthershore agreements amend
Usage: farthershore agreements amend [options] [businessIdOrSlug] <agreementId>
Amend an agreement's contract terms (append-only; confirm-gated: previews first;
pass --confirm <token> to commit)
Options:
--terms-json <json> Negotiated contract terms as JSON:
{"percentDiscount":{"num":"1","den":"5"},"floorNanos":"…","capNanos":"…","selectorScope":[{"kind":"provider_model_glob","provider":"acme","modelGlob":"acme-*"}]}.
Required for current_with_contract_terms and for
amend.
--effective-at <iso> When the agreement/version takes effect (ISO-8601).
Default: now.
--confirm <token> The confirmationToken returned by the preview run.
Omit to preview only.
--idempotency-key <key> Required for this mutation. Generate it once and
reuse the exact value on retry.
-h, --help display help for command
Two-step: run once to PREVIEW (prints the effect + confirmationToken; nothing is written), then re-run the SAME command with --confirm <token> to append the new version.