Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Price catalogs

A Catalog is an environment's features, products, and prices: the desired state Money keeps its merchant account's processor objects equal…

A Catalog is an environment's features, products, and prices: the desired state Money keeps its merchant account's processor objects equal to, by lookup key. It is declared in sylphx.toml [money] or written here.

Service Sylphx Money · Resource type money.sylphx.com/PriceCatalog · Name pattern orgs/{org}/projects/{project}/envs/{env}/price_catalogs/{price_catalog} · Shape singleton

#Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/price_catalogs/default.
uidstringcat_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specCatalogSpecDesired state. Required.
statusCatalogStatusObserved state. Output only.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets the environment's catalog.
PATCHupdateUpdates the environment's catalog: its features and products, whole.
POSTsyncPushes the catalog to the merchant account's processor now: products and prices by lookup key; an amount change makes a new price.

#get

Gets the environment's 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.

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

#sync

Pushes the catalog to the merchant account's processor now: products and prices by lookup key; an amount change makes a new price.

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