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
Get a checkout policy
Gets the environment's checkout policy: which buyer countries consumer checkout refuses.
Gets the environment's checkout policy: which buyer countries consumer checkout refuses. An environment that never wrote one refuses none.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/checkout_policies/checkout-policy - Scope
billing:read - Effect
read— nothing is written. - Collection checkout_policies
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the checkout policy to get. Required. |
#Response
| 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. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#CheckoutPolicySpec
| Field | Type | What it is |
|---|---|---|
denied_country_codes | string[] | Buyer countries consumer checkout refuses: ISO 3166-1 alpha-2 codes (DE), or the group EU (the 27 member states). At most 300 entries. Empty refuses nobody. |
allow_tax_id_buyers | bool | Whether a buyer from a denied country who gives a tax id (a business) may still buy. Checkout then asks for the tax id; default false. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/checkout_policies/checkout-policy" \
-H "Authorization: Bearer $SYLPHX_API_KEY"