Skip to content
Console
On this page

Get a store consumption request

Gets a captured store consumption request.

Gets a captured store consumption request.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/store_consumption_requests/store-consumption-request
  • Scope billing:read
  • Effect read — nothing is written.
  • Collection store_consumption_requests

Request

FieldTypeWhat it is
namestringThe name of the store consumption request to get. Required.

Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/store_consumption_requests/{store_consumption_request}.
uidstringscr_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
storestringStore name (app_store). Output only.
bundle_idstringApp Store bundle identifier. Output only.
environmentstringproduction or sandbox. Output only.
transaction_idstringApp Store transaction identifier. Output only.
original_transaction_idstringApp Store original transaction identifier. Output only.
notification_idstringStore notification UUID that opened this request. Output only.
consumption_request_reasonstringApple's consumptionRequestReason, when present. Output only.
store_purchasestringLinked StorePurchase resource name, when verified in Money. Output only.
subjectSubjectLinked buyer subject, when known. Output only.
statusstringCurrent state: pending, consent_missing, consent_withdrawn, in_flight, sent, failed_retryable, failed_terminal, or expired. Output only.
observed_timetimestampWhen Money observed the notification. Output only.
deadline_timetimestamp12-hour Apple response deadline. Output only.
attempt_countint32Number of outbound Apple Send Consumption attempts started. Output only.
last_attempt_timetimestampTimestamp of the last outbound Apple Send Consumption attempt. Output only.
sent_timetimestampTimestamp when Apple accepted the consumption report (HTTP 202). Output only.
apple_http_statusint32HTTP status code returned by Apple's consumption endpoint (202 when sent). Output only.
last_refusal_reasonstringLast fail-closed refusal reason, when blocked before calling Apple. Output only.
consent_idstringConsent ledger event id evaluated for the dispatch, when present. 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

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/store_consumption_requests/store-consumption-request" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"