Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get a checkout session
Gets a checkout session.
Gets a checkout session.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/checkout_sessions/checkout-session - Scope
billing:read - Effect
read— nothing is written. - Collection checkout_sessions
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the checkout session to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/checkout_sessions/{checkout_session}. |
uid | string | chk_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
subject | Subject | Who pays and is entitled. Required. |
line_items | LineItem[] | What is bought: catalog prices by lookup key. One recurring price makes a subscription; one-time prices make an order. Required. |
success_url | string | Where the buyer lands after paying; {CHECKOUT_SESSION_ID} is replaced by the processor's session id. HTTPS only. Required. |
cancel_url | string | Where the buyer lands on cancel. HTTPS only. |
currency_code | string | The currency to charge in, upper-case ISO 4217; default the processor's choice for the buyer among the prices' currencies. |
locale | string | The page language, for example en or zh-HK; default automatic. |
metadata | map<string, string> | Copied to the subscription or order, for example attribution (utm_source, ref). At most 20 keys. |
allow_promotion_codes | bool | Whether the buyer may enter a promotion code. |
url | string | The hosted page. Output only. |
state | string | open, complete, or expired. Output only. |
expire_time | timestamp | When the page stops accepting payment. Output only. |
processor_session_id | string | The processor's session id. Output only. |
#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. |
#Subject
| Field | Type | What it is |
|---|---|---|
end_user | string | An end user's id (Sylphx Auth, or the app's own OIDC issuer). One of the kind group. |
customer_organization | string | A customer organization's id. One of the kind group. |
#LineItem
| Field | Type | What it is |
|---|---|---|
price | string | The price's lookup key. Required. |
quantity | int32 | How many; default 1. Seats for a per-seat or family price. |
#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_sessions/checkout-session" \
-H "Authorization: Bearer $SYLPHX_API_KEY"