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
Run a revenue source
Syncs a revenue source now, or backfills a period.
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).
- Path
POST https://api.sylphx.com/v1/orgs/acme/revenue_sources/revenue-source:run - Scope
revenue:write - Effect
write— a successful call changes state. - Collection revenue_sources
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The source to run. Required. |
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. |
#Response
| Field | Type | What it is |
|---|---|---|
run | string | The run's id. |
state | string | succeeded, failed, or running while a connector works through it. |
facts | int64 | The facts the run wrote. |
revenue_source | RevenueSource | The source after the run. |
#RevenueSource
| 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. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#RevenueSourceSpec
| Field | Type | What it is |
|---|---|---|
kind | string | money, stripe, google_play, app_store, ad_network, file or manual. Set on create and never changed; money is never created. Required. |
display_name | string | Shown on summaries and in the console. |
paused | bool | A paused source is not synced and cannot be run; its facts still count. |
config | map<string, string> | The connector's settings (an account id, a bucket, a column mapping), never a credential. At most 32 entries. |
#RevenueSourceStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready while the source is fresh; False with reason Stale, Paused or NeverSynced otherwise. Output only. |
environment | string | For a money source, the environment it books: orgs/{org}/projects/{project}/envs/{env}. Empty for every other kind. Output only. |
last_success_time | timestamp | When the source last synced successfully. Unset for a money source, which books in real time. Output only. |
newest_day | string | The newest day the source holds, YYYY-MM-DD; empty when it holds none. Output only. |
stale | bool | The newest day is older than the kind's normal lag plus one day, or the source has never synced: summaries name it and mark the days it has not reported as incomplete. Output only. |
last_run_state | string | The last run: running, succeeded or failed; empty before the first. Output only. |
last_run_error | string | The last failed run's error code; never a response body. Output only. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.INVALID_STATE— The Resource is in a state that forbids the call.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/revenue_sources/revenue-source:run" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'