sylphx money price_catalogs
Every sylphx money price_catalogs command: its argument, its flags and a run line.
The price_catalogs commands of Sylphx Money, as the CLI spells them: the same
calls as the price_catalogs API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
get
Gets the environment's catalog.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money price-catalogs get orgs/acme/projects/shop/envs/production/price_catalogs/price-catalogGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/price_catalogs/price-catalog · scope billing:read · effect read · Request, response and examples
update
Updates the environment's catalog: its features and products, whole.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money price-catalogs update orgs/acme/projects/shop/envs/production/price_catalogs/price-catalogPATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/price_catalogs/price-catalog · scope billing:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.features | json | What an entitlement can grant. Repeat the flag for each value. |
--spec.products | json | What is sold. Repeat the flag for each value. |
--spec.client-grant-ttl | duration | How long a signed store-purchase grant is valid, from the moment it is issued; a client re-verifies to renew it. Default 7 days, 1 hour to 30 days. |
--spec.refund-claw-back | bool | Whether a delivered one-time purchase whose money the store or processor takes back (a refund, a void, a chargeback) gives back its goods: its entitlements end, and the refund event asks the app to take back the assets it granted, up to what the subject still holds. Applies once the project is enabled for take-backs, to refunds dated from then on; unset then means on. |
--spec.application-data | json | Caller-owned, publicly readable application data published atomically with the products in this revision. Money preserves it without interpreting its schema or using it for prices, grants, checkout or processor reconciliation. The caller validates its schema and version. At most 65536 UTF-8 bytes when serialized as compact JSON; must be an object. Never include secrets or personal data: the public catalog exposes this field. |
--spec.currency-mode | enum | How an end user's checkout currency is chosen. Wallets and the ledger hold every currency in every mode; this governs only what an end user is charged in. Unset means CURRENCY_MODE_MULTI_CURRENCY. Any other mode needs a default_currency on every active price. One of multi_currency, country_locked, single_asset. |
--spec.rehome-cooldown-days | int | In CURRENCY_MODE_COUNTRY_LOCKED, the days an end user waits after their home currency was bound before a payment from another country may move it. The old home currency's wallet must also be empty. Unset means 90. |
--spec.fx-rates-per-usd | key=value | Exact FX snapshot used by opted-in prices: target major units per USD, as positive decimal strings with at most 18 fractional places. USD is always 1 and can be omitted. Money does not fetch rates during a write. Repeat the flag for each value. |
--spec.checkout-branding.display-name | string | Header override, folded to one line and limited to 60 characters by Money. If omitted, use the catalog name for a single product, or Stripe's default. |
--spec.checkout-branding.icon.file | string | A Stripe File ID owned by the connected merchant account. |
--spec.checkout-branding.icon.url | string | A public HTTPS image URL on a public DNS name, up to 2,048 bytes. |
--spec.checkout-branding.logo.file | string | A Stripe File ID owned by the connected merchant account. |
--spec.checkout-branding.logo.url | string | A public HTTPS image URL on a public DNS name, up to 2,048 bytes. |
--spec.checkout-branding.button-color | string | Six-digit hex color, including the leading '#'. |
--spec.checkout-branding.background-color | string | Six-digit hex color, including the leading '#'. |
--spec.checkout-branding.border-style | string | Stripe Checkout's shape for buttons and inputs. |
--spec.checkout-branding.font-family | string | Stripe Checkout's font family, in lowercase snake_case. |
--allow-missing | bool | Create the catalog when it does not exist (declarative upsert). |
--dry-run | bool | Validate and print the result without writing (validate_only). |
sync
Pushes the catalog to the merchant account's processor now: products and prices by lookup key; an amount change makes a new price.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money price-catalogs sync orgs/acme/projects/shop/envs/production/price_catalogs/price-catalogPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/price_catalogs/price-catalog:sync · scope billing:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--dry-run | bool | Observe Stripe and return a plan without updating Stripe or Money. |
--plan-fingerprint | string | If set on apply, refuse the entire operation if the plan no longer matches. |