Get a subscription purchase by ID

GET 
/organizations/:organizationId/projects/:projectId/platforms/android/devices/:deviceId/subscriptions/:purchaseId

Get a subscription purchase by ID

Request

Path Parameters

organizationId stringrequired
projectId stringrequired
deviceId stringrequired
purchaseId stringrequired

Responses

200

application/json

Schema

Schema

id stringrequired

ID

subscriptionId stringrequired

Subscription ID

userId stringrequired

User ID

organizationId stringrequired

Organization ID

purchaseToken stringrequired

Purchase token

autoRenewing booleanrequired

Auto renewing status

startTime date-timerequired

The time the subscription started

expiryTime date-timerequired

The time the subscription will expire

status stringrequired

Possible values: [PENDING, ACTIVE, PAUSED, CANCELED, GRACE_PERIOD, ON_HOLD, EXPIRED]

Subscription status

basePlanId stringrequired

Base plan ID

offerId stringrequired

Offer ID

oldPurchaseToken stringrequired

Old purchase token

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.

deviceId stringrequired

Device ID

acknowledgedAt date-timerequired

The time the subscription was acknowledged

subscription object

sku stringrequired

Subscription SKU

Example (from schema)

{
  "id": "id1234",
  "subscriptionId": "sub1234",
  "userId": "user1234",
  "organizationId": "org1234",
  "purchaseToken": "purchaseToken1234",
  "autoRenewing": true,
  "startTime": "2021-09-20T00:40:56.000Z",
  "expiryTime": "2021-10-20T00:40:56.000Z",
  "status": "ACTIVE",
  "basePlanId": "basePlan1234",
  "offerId": "offer1234",
  "oldPurchaseToken": "oldPurchaseToken1234",
  "obfuscatedAccountId": "abcd1234",
  "obfuscatedProfileId": "efgh5678",
  "developerPayload": "payload",
  "orderId": "order1234",
  "applicationId": "com.example.app",
  "deviceId": "device1234",
  "acknowledgedAt": "2021-10-20T00:40:56.000Z",
  "subscription": {
    "sku": "subscription_sku_1234"
  }
}

Loading...