Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

On this page

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

Shell
sylphx money price-catalogs get orgs/acme/projects/shop/envs/production/price_catalogs/price-catalog

GET 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

Shell
sylphx money price-catalogs update orgs/acme/projects/shop/envs/production/price_catalogs/price-catalog

PATCH 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

FlagTypeWhat it does
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--spec.featuresjsonWhat an entitlement can grant. Repeat the flag for each value.
--spec.productsjsonWhat is sold. Repeat the flag for each value.
--spec.client-grant-ttldurationHow 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.
--allow-missingboolCreate the catalog when it does not exist (declarative upsert).
--dry-runboolValidate 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

Shell
sylphx money price-catalogs sync orgs/acme/projects/shop/envs/production/price_catalogs/price-catalog

POST 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