Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

Get a test clock

Reads the owned test clock back from Stripe.

Reads the owned test clock back from Stripe. Live keys are refused.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/test_clocks/test-clock
  • Scope billing:read
  • Effect read — nothing is written.
  • Collection test_clocks

#Request

FieldTypeWhat it is
namestringThe test clock to read back. Required.

#Response

FieldTypeWhat it is
namestringThe clock's resource name.
uidstringStable identity, never reused. Output only.
metaResourceMetaResource metadata. Output only.
subjectSubjectThe subject whose new Stripe customer will use this clock. A subject with an existing Money Stripe customer cannot acquire a clock. Required.
frozen_timetimestampInitial simulated time on create; current Stripe time on reads. Required on create. Only whole seconds are supported. Required.
statestringStripe's status: ready, advancing, or internal_failure. Poll GetTestClock until ready before the next simulation step. Ready does not mean Money has applied every webhook; observe the subscription and entitlement too. Output only.
processor_clock_idstringStripe clock id, for processor receipts. Output only.
livemodeboolAlways false; a live processor object is refused. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong 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_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#Subject

FieldTypeWhat it is
end_userstringAn end user's id (Sylphx Auth, or the app's own OIDC issuer). One of the kind group.
customer_organizationstringA customer organization's id. One of the kind group.

#Errors

  • UNAUTHENTICATED — No valid key or token was presented.
  • PERMISSION_DENIED — The key lacks the method's permission.
  • INVALID_STATE — The Resource is in a state that forbids the call.
  • RESOURCE_NOT_FOUND — The named Resource does not exist or is not visible.
  • UNAVAILABLE — The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/test_clocks/test-clock" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"