Update a purchase by ID

PUT 
/organizations/:organizationId/projects/:projectId/platforms/android/devices/:deviceId/purchases/:purchaseId

Update a purchase by ID

Request

Path Parameters

organizationId stringrequired
projectId stringrequired
deviceId stringrequired
purchaseId stringrequired

application/json

Body

required

purchaseState stringrequired

Possible values: [PURCHASED, CANCELED, PENDING]

The state of the purchase

acknowledgedAt date-timerequired

The time the purchase was acknowledged

consumedAt date-timerequired

The time the purchase was consumed

Responses

200

Purchase updated successfully

application/json

Schema

Schema

id stringrequired

ID

purchaseState stringrequired

Possible values: [PURCHASED, CANCELED, PENDING]

The state of the purchase

quantity numberrequired

Quantity of items purchased

purchaseTime date-timerequired

The time the purchase was made

obfuscatedAccountId stringrequired

Obfuscated account ID

obfuscatedProfileId stringrequired

Obfuscated profile ID

developerPayload stringrequired

Developer payload

orderId stringrequired

Order ID

applicationId stringrequired

The applicationId associated with the app, also referred to as packageName.

purchaseToken stringrequired

Purchase token

productId stringrequired

Product ID

userId stringrequired

User ID

organizationId stringrequired

Organization ID

deviceId stringrequired

Device ID

androidPlatformId stringrequired

Android platform ID

consumedAt date-timerequired

The time the purchase was consumed

updatedAt date-timerequired

The time the purchase was updated

acknowledgedAt date-timerequired

The time the purchase was acknowledged

createdAt date-timerequired

Creation timestamp

product object

sku stringrequired

Product SKU

Example (from schema)

{
  "id": "id1234",
  "purchaseState": "Purchased",
  "quantity": 1,
  "purchaseTime": "2021-09-20T00:40:56.000Z",
  "obfuscatedAccountId": "abcd1234",
  "obfuscatedProfileId": "efgh5678",
  "developerPayload": "payload",
  "orderId": "order1234",
  "applicationId": "com.example.app",
  "purchaseToken": "purchaseToken1234",
  "productId": "prod1234",
  "userId": "user1234",
  "organizationId": "org1234",
  "deviceId": "device1234",
  "androidPlatformId": "platform1234",
  "consumedAt": "2021-09-20T00:40:56.000Z",
  "updatedAt": "2021-09-20T00:40:56.000Z",
  "acknowledgedAt": "2021-09-20T00:40:56.000Z",
  "createdAt": "2021-09-20T00:40:56.000Z",
  "product": {
    "sku": "product_sku_1234"
  }
}

Loading...