Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Localization
Monitoring
Notifications
Payments
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx money revenue_sources
Every sylphx money revenue_sources command: its argument, its flags and a run line.
The revenue_sources commands of Sylphx Money, as the CLI spells them: the same
calls as the revenue_sources API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets a revenue source, with its freshness. Revenue reporting (docs/adr/ADR-01M40HRQT0VSXZ1WANP8M318F2) is org-wide: revenue:read or revenue:write, held by an org-wide key or an org owner's or admin's session only; a project or environment key is refused.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money revenue-sources get orgs/acme/revenue_sources/revenue-sourceGET https://api.sylphx.com/v1/orgs/acme/revenue_sources/revenue-source · scope revenue:read · effect read · Request, response and examples
#list
Lists the org's revenue sources, with their freshness.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx money revenue-sources list orgs/acmeGET https://api.sylphx.com/v1/orgs/acme/revenue_sources · scope revenue:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
#create
Registers a revenue source. The money source is implicit and never created here.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
sylphx money revenue-sources create --parent orgs/acme --spec.kind …POST https://api.sylphx.com/v1/orgs/acme/revenue_sources · scope revenue: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. |
--spec.kind | string | money, stripe, google_play, app_store, ad_network, file or manual. Set on create and never changed; money is never created. Required. |
--spec.display-name | string | Shown on summaries and in the console. |
--spec.paused | bool | A paused source is not synced and cannot be run; its facts still count. |
--spec.config | key=value | The connector's settings (an account id, a bucket, a column mapping), never a credential. At most 32 entries. Repeat the flag for each value. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#update
Renames, pauses or resumes a revenue source, or changes its settings.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money revenue-sources update orgs/acme/revenue_sources/revenue-sourcePATCH https://api.sylphx.com/v1/orgs/acme/revenue_sources/revenue-source · scope revenue:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--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. |
--spec.display-name | string | Shown on summaries and in the console. |
--spec.paused | bool | A paused source is not synced and cannot be run; its facts still count. |
--spec.config | key=value | The connector's settings (an account id, a bucket, a column mapping), never a credential. At most 32 entries. Repeat the flag for each value. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#delete
Deletes a revenue source and the facts it reported. The money source cannot be deleted; pause it instead.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money revenue-sources delete orgs/acme/revenue_sources/revenue-source --yesDELETE https://api.sylphx.com/v1/orgs/acme/revenue_sources/revenue-source · scope revenue:write · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--etag | string | The current etag; when set, the delete happens only if it matches. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--yes | bool | Do not ask before this destructive call. |
#run
Syncs a revenue source now, or backfills a period. A money source fills any booked fact its environment's ledger holds and the facts lack; a paused source, or one whose connector has not shipped yet, is refused (INVALID_STATE).
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money revenue-sources run orgs/acme/revenue_sources/revenue-sourcePOST https://api.sylphx.com/v1/orgs/acme/revenue_sources/revenue-source:run · scope revenue:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--mode | string | sync (default) reads what is new; backfill re-reads the period start_day to end_day. |
--start-day | string | The first day of a backfill, YYYY-MM-DD. |
--end-day | string | The last day of a backfill, YYYY-MM-DD, inclusive. |