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
Checkout sessions
A Checkout Session is a hosted page where a subject pays for catalog prices.
A Checkout Session is a hosted page where a subject pays for catalog prices. Money creates the processor's session on the environment's merchant account and returns its URL.
Service Sylphx Money · Resource type money.sylphx.com/CheckoutSession · Name pattern orgs/{org}/projects/{project}/envs/{env}/checkout_sessions/{checkout_session} · Shape record
#Fields
| 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. |
#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 |
|---|---|---|
POST | create | Creates a hosted checkout for a subject. |
GET | get | Gets a checkout session. |
#create
Creates a hosted checkout for a subject.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/checkout_sessions · scope billing:write · effect write · Request, response and examples
#get
Gets a checkout session.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/checkout_sessions/checkout-session · scope billing:read · effect read · Request, response and examples