Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Jobs and cron
Localization
Monitoring
Notifications
Payments
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
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
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/checkout_policies/default. |
uid | string | cpl_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | CheckoutPolicySpec | Desired 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.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets the environment's checkout policy: which buyer countries consumer checkout refuses. An environment that never wrote one refuses none. |
PATCH | update | Updates 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