Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get a store purchase
Gets a store purchase.
Gets a store purchase.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/store_purchases/store-purchase - Scope
billing:read - Effect
read— nothing is written. - Collection store_purchases
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the store purchase to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/store_purchases/{store_purchase}. |
uid | string | spu_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
subject | Subject | Who it belongs to. Output only. |
store | string | app_store or google_play. Output only. |
product_id | string | The store product id. Output only. |
product | string | The catalog product it sells, when the catalog maps the store product. Output only. |
bundle_or_package | string | The bundle id or package name. Output only. |
transaction_id | string | The store's transaction id (App Store transaction id, Play order id). Output only. |
original_transaction_id | string | The first transaction of a subscription or restored purchase. Output only. |
quantity | int32 | Units bought. Output only. |
environment | string | production or sandbox. Output only. |
state | string | purchased, pending, or revoked. Output only. |
purchase_time | timestamp | When the store says it was bought. Output only. |
revoke_time | timestamp | When the store refunded or revoked it. Output only. |
price | string | The price the store charged, in minor units of currency, when the store reports it. Output only. |
currency_code | string | ISO 4217 currency of price. Output only. |
customer_subscription | string | The subscription it belongs to, for a subscription purchase. 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_purchases/store-purchase" \
-H "Authorization: Bearer $SYLPHX_API_KEY"