---
# @generated by sylphx-gen 0.1.0 from contracts@8a9fca9773aec38ab008501562caa0e2762fc3d40938f82c8ce513c03d8b8e7d. Do not edit.
title: "Revenue sources"
description: "The `revenue_sources` collection of Sylphx Money: A Revenue Source is one place an org's revenue is read from."
type: reference
product: payments
summary: "A Revenue Source is one place an org's revenue is read from."
updated: 2026-09-28
order: 900
---

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`](/docs/api/revenue_sources#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`](/docs/api/revenue_sources#list) | Lists the org's revenue sources, with their freshness. |
| `POST` | [`create`](/docs/api/revenue_sources#create) | Registers a revenue source. The `money` source is implicit and never created here. |
| `PATCH` | [`update`](/docs/api/revenue_sources#update) | Renames, pauses or resumes a revenue source, or changes its settings. |
| `DELETE` | [`delete`](/docs/api/revenue_sources#delete) | Deletes a revenue source and the facts it reported. The `money` source cannot be deleted; pause it instead. |
| `POST` | [`run`](/docs/api/revenue_sources#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](/docs/api/revenue_sources/get)

## 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](/docs/api/revenue_sources/list)

## 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](/docs/api/revenue_sources/create)

## 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](/docs/api/revenue_sources/update)

## 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](/docs/api/revenue_sources/delete)

## 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](/docs/api/revenue_sources/run)
