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
| Field | Type | What it is |
|---|---|---|
name | string | The name of the store consumption request to get. Required. |
Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/store_consumption_requests/{store_consumption_request}. |
uid | string | scr_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
store | string | Store name (app_store). Output only. |
bundle_id | string | App Store bundle identifier. Output only. |
environment | string | production or sandbox. Output only. |
transaction_id | string | App Store transaction identifier. Output only. |
original_transaction_id | string | App Store original transaction identifier. Output only. |
notification_id | string | Store notification UUID that opened this request. Output only. |
consumption_request_reason | string | Apple's consumptionRequestReason, when present. Output only. |
store_purchase | string | Linked StorePurchase resource name, when verified in Money. Output only. |
subject | Subject | Linked buyer subject, when known. Output only. |
status | string | Current state: pending, consent_missing, consent_withdrawn, in_flight, sent, failed_retryable, failed_terminal, or expired. Output only. |
observed_time | timestamp | When Money observed the notification. Output only. |
deadline_time | timestamp | 12-hour Apple response deadline. Output only. |
attempt_count | int32 | Number of outbound Apple Send Consumption attempts started. Output only. |
last_attempt_time | timestamp | Timestamp of the last outbound Apple Send Consumption attempt. Output only. |
sent_time | timestamp | Timestamp when Apple accepted the consumption report (HTTP 202). Output only. |
apple_http_status | int32 | HTTP status code returned by Apple's consumption endpoint (202 when sent). Output only. |
last_refusal_reason | string | Last fail-closed refusal reason, when blocked before calling Apple. Output only. |
consent_id | string | Consent ledger event id evaluated for the dispatch, when present. 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. |
Subject
| Field | Type | What it is |
|---|---|---|
end_user | string | An end user's id (Sylphx Auth, or the app's own OIDC issuer). One of the kind group. |
customer_organization | string | A 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.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
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"