Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
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. |
--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