Start

Platform

App store purchases

Auth

Builds

Database

Flags

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Events

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

create
get

Reference

sylphx money checkout_sessions

Every sylphx money checkout_sessions command: its argument, its flags and a run line.

Checked 2026-09-28

The checkout_sessions commands of Sylphx Money, as the CLI spells them: the same calls as the checkout_sessions API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

#create

Creates a hosted checkout for a subject.

ID — The id segment of the new Resource's name; the server assigns one when omitted.

CLI

Shell

sylphx money checkout-sessions create --parent orgs/acme/projects/shop/envs/production --success-url …

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/checkout_sessions · scope billing:write · effect write · Request, response and examples

Flags

Flag	Type	What it does
`--parent`	`string`	The parent to create in; defaults to the linked project or the key's scope.
`--meta.labels`	`key=value`	Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
`--meta.annotations`	`key=value`	Caller-writable, unindexed annotations. Repeat the flag for each value.
`--meta.display-name`	`string`	Caller-writable human-readable name.
`--subject.end-user`	`string`	An end user's id (Sylphx Auth, or the app's own OIDC issuer).
`--subject.customer-organization`	`string`	A customer organization's id.
`--line-items`	`json`	What is bought: catalog prices by lookup key. One recurring price makes a subscription; one-time prices make an order. Required. Repeat the flag for each value.
`--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`	`key=value`	Copied to the subscription or order, for example attribution (`utm_source`, `ref`). At most 20 keys. Repeat the flag for each value.
`--allow-promotion-codes`	`bool`	Whether the buyer may enter a promotion code.

#get

Gets a checkout session.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx money checkout-sessions get orgs/acme/projects/shop/envs/production/checkout_sessions/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

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links