Skip to content
Console
Menu

Generated Assets

Workflows

Getting Started

Authentication

KV Store

Checkout policies

A Checkout Policy is an environment's seller setting for which buyers consumer checkout refuses, by buyer country.

A Checkout Policy is an environment's seller setting for which buyers consumer checkout refuses, by buyer country. One per environment, id default; an environment without one refuses nobody.

Service Sylphx Money · Resource type money.sylphx.com/CheckoutPolicy · Name pattern orgs/{org}/projects/{project}/envs/{env}/checkout_policies/{checkout_policy} · Shape singleton

#Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/checkout_policies/default.
uidstringcpl_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specCheckoutPolicySpecDesired state. Required.

#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 checkout policy: which buyer countries consumer checkout refuses. An environment that never wrote one refuses none.
PATCHupdateUpdates the environment's checkout policy, whole.

#get

Gets the environment's checkout policy: which buyer countries consumer checkout refuses. An environment that never wrote one refuses none.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/checkout_policies/checkout-policy · scope billing:read · effect read · Request, response and examples

#update

Updates the environment's checkout policy, whole.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/checkout_policies/checkout-policy · scope billing:write · effect write · Request, response and examples