Menu
Platform
AI
Alerts and status pages
App store purchases
Credits
Generated Assets
Knowledge
KV
Localization
Notifications
Organizations
Payments
Queues
Realtime
Sandboxes
Storage
Workflows
API reference
- Overview
- Access API keys
- Agent sessions API
- Agent versions API
- Agents API
- AI models API
- Artifact references API
- Artifacts API
- Assets API
- Auth configs API
- Bank receipts API
- Bank transfer accounts API
- Buckets API
- Builds API
- Catalogs API
- Chat profiles API
- Chat reports API
- Chat sticker packs API
- Checkout policies API
- Checkout sessions API
- Config changes API
- Config flags API
- Config segments API
- Connection providers API
- Connections API
- Connectors API
- Credit grants API
- Customer organizations API
- Customer subscriptions API
- Databases API
- Documents API
- Email domains API
- End users API
- Entities API
- Entitlement grants API
- Entries API
- Environments API
- Episodes API
- Error events API
- Error groups API
- Events API
- Exchange rates API
- Generations API
- Glossaries API
- Goals API
- Identities API
- Inbound emails API
- Inbound endpoints API
- Inbound messages API
- Inbound sms API
- Invitations API
- Job runs API
- Jobs API
- Knowledge schemas API
- KV API
- KV namespaces API
- Lease events API
- Leases API
- Licence keys API
- Licence tokens API
- Mail domains API
- Mail routes API
- Mailbox connect links API
- Mailbox OAUTH apps API
- Mailboxes API
- Memberships API
- Memories API
- Memory stores API
- Merchant accounts API
- Message topics API
- Messages API
- OAUTH clients API
- Objects API
- Organization roles API
- Orgs API
- Owner pools API
- Phone numbers API
- Portal sessions API
- Preferences API
- Price catalogs API
- Processor events API
- Projects API
- Queued executions API
- Queues API
- Realtime channels API
- Realtime members API
- Realtime messages API
- Recipients API
- Relations API
- Releases API
- Revenue API
- Revenue facts API
- Revenue sources API
- Runs API
- Sandbox shapes API
- Schedules API
- Scrubbing policies API
- Search API
- Search indexes API
- Secret versions API
- Secrets API
- Service enablements API
- Service observations API
- Services API
- Serving routes API
- Session events API
- Sessions API
- Signing key versions
- Signing keys
- Sms numbers API
- Source maps API
- Spaces API
- Store connections API
- Store consumption requests API
- Store purchases API
- Subscriptions API
- Suppressions API
- Tax threshold statuses API
- Templates API
- Test clocks API
- Token exchanges API
- Transfers API
- Trust policies API
- Trusted issuers API
- Uptime checks API
- Uptime manifests API
- Uptime sources API
- Usage events API
- Usage invoices API
- Usage meter prices API
- Usage meters API
- Usage reservations API
- Usage settings API
- Usage tiers API
- Volumes API
- Waits API
- Webhook deliveries API
- Webhook endpoints API
- Workflows API
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Revenue sources
A Revenue Source is one place an org's revenue is read from.
A Revenue Source is one place an org's revenue is read from. kind selects the connector Money implements once (ADR §2). The money source is implicit, one per environment with Money, made the first time Money books a sale there; it cannot be created or deleted through the API, only renamed or paused. A connector's credential is sealed and never returned; connectors arrive kind by kind, and a source of a kind whose connector has not shipped yet is registered and reported stale until it first syncs.
Service Sylphx Money · Resource type money.sylphx.com/RevenueSource · Name pattern orgs/{org}/revenue_sources/{revenue_source} · Shape spec_status
#Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/revenue_sources/{revenue_source}. |
uid | string | The source's id (rvs-…); never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | RevenueSourceSpec | Desired state. Required. |
status | RevenueSourceStatus | Observed state. 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 |
|---|---|---|
GET | 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. |
GET | list | Lists the org's revenue sources, with their freshness. |
POST | create | Registers a revenue source. The money source is implicit and never created here. |
PATCH | update | Renames, pauses or resumes a revenue source, or changes its settings. |
DELETE | delete | Deletes a revenue source and the facts it reported. The money source cannot be deleted; pause it instead. |
POST | 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). |
#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.
GET 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.
GET https://api.sylphx.com/v1/orgs/acme/revenue_sources · scope revenue:read · effect read · paginated · Request, response and examples
#create
Registers a revenue source. The money source is implicit and never created here.
POST https://api.sylphx.com/v1/orgs/acme/revenue_sources · scope revenue:write · effect write · Request, response and examples
#update
Renames, pauses or resumes a revenue source, or changes its settings.
PATCH https://api.sylphx.com/v1/orgs/acme/revenue_sources/revenue-source · scope revenue:write · effect write · Request, response and examples
#delete
Deletes a revenue source and the facts it reported. The money source cannot be deleted; pause it instead.
DELETE https://api.sylphx.com/v1/orgs/acme/revenue_sources/revenue-source · scope revenue:write · effect destructive · Request, response and examples
#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).
POST https://api.sylphx.com/v1/orgs/acme/revenue_sources/revenue-source:run · scope revenue:write · effect write · Request, response and examples