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 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
Update a revenue source
Renames, pauses or resumes a revenue source, or changes its settings.
Renames, pauses or resumes a revenue source, or changes its settings.
- Path
PATCH https://api.sylphx.com/v1/orgs/acme/revenue_sources/revenue-source - Scope
revenue:write - Effect
write— a successful call changes state. - Collection revenue_sources
- Query
update_mask,validate_only
#Request
| Field | Type | What it is |
|---|---|---|
revenue_source | RevenueSource | The source with its new values; name addresses it. Required. |
update_mask | field_mask | The fields to change: spec.display_name, spec.paused, spec.config. Empty changes every one the body sets. |
validate_only | bool | Validate only; write nothing. |
#RevenueSource
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/revenue_sources/{revenue_source}. |
meta | ResourceMeta | Resource metadata. |
spec | RevenueSourceSpec | Desired state. Required. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
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. |
#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. |
credential | string | The connector's credential, such as a Stripe live restricted key with read access to balance transactions and payouts. Shared by all connector kinds: sealed on write, never returned; omit it on update to keep it. Never returned again. |
#Response
| 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. |
credential | string | The connector's credential, such as a Stripe live restricted key with read access to balance transactions and payouts. Shared by all connector kinds: sealed on write, never returned; omit it on update to keep it. Never returned again. |
#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.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.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 PATCH "https://api.sylphx.com/v1/orgs/acme/revenue_sources/revenue-source" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"orgs/acme/revenue_sources/revenue-source","spec":{"kind":"…"}}'