Skip to main content

Entitlement Fulfillment Object

transaction_idstring

The mod.io transaction ID for the entitlement transfer.

Example: 124641934672
transaction_stateTransaction State Enum (integer)
Enum ValueDescription
FAILED (0)Everyone
PENDING (1)Pending
FULFILLED (2)Fulfilled
LIMIT_EXCEEDED (3)Consume Limit Exceeded

Possible values: [0, 1, 2, 3]

sku_idstring

The portal SKU ID associated with the transaction.

Example: MODIO0001
entitlement_consumedboolean

Has the entitlement been consumed in the 3rd-party portal?

Example: true
entitlement_typeinteger<int32>

The entitlement type, once consumed and the entitlement is transferred to mod.io. Possible values: 0 = Virtual Tokens

Possible values: [0]

Example: 0
details object
tokens_allocatedinteger<int32>

The amount of virtual tokens (Mio's) allocated from the entitlement consumption.

Example: 1000
Entitlement Fulfillment Object
{
  "transaction_id": "124641934672",
  "transaction_state": 0,
  "sku_id": "MODIO0001",
  "entitlement_consumed": true,
  "entitlement_type": 0,
  "details": {
    "tokens_allocated": 1000
  }
}