PayNow

ON_DELIVERY_ITEM_USED

Triggered when a delivery item in the customers inventory becomes used

Payload
bodyobjectRequired
added_atstringRequired
Indicates when the Delivery Item was added to the customers inventory
idstringRequired
The Flake ID of the Delivery Item
productProductDTORequired
allow_one_time_purchasebooleanRequired
Indicates if one-time purchases are supported on the product
allow_subscriptionbooleanRequired
Indicates if subscriptions are supported on the product
commandsProductCommandDTO[]Required
The commands associated with the product
→ ProductCommandDTO
descriptionstringRequired
The description of the product
enabledbooleanRequired
Indicates if the product is enabled.
gameserver_namesstringRequired
A comma-seperated string of all the game servers associated with the product
gameserversProductGameServerDTO[]Required
The game servers associated with the product
→ ProductGameServerDTO
idstringRequired
The Flake ID of the Product
metadataobjectRequired
The metadata of the product
namestringRequired
The name of the Product
priceintegerRequired
The price of the product, represented in cents.
remove_after_enabledbooleanRequired
Indicates whether automatic removal is enabled
single_game_server_onlybooleanRequired
Indicates if the customer must select a single game server when purchasing the product
slugstringRequired
The URL-Friendly Slug of the Product
sort_orderintegerRequired
The sort order of the product
store_idstringRequired
The Flake ID of the Store
tag_namesstringRequired
A comma-seperated string of all the tags associated with the product
tagsProductTagDTO[]Required
The tags associated with the product
→ ProductTagDTO
version_idstringRequired
The Flake ID of the Version of the Product
created_atstringOptional
When the product was created
image_urlstringOptional
The Image URL of the product
labelstringOptional
The label of the product
remove_after_time_scalestringOptional
The scale of the time in which this product should be removed
remove_after_time_valueintegerOptional
The value of the time in which this product should be removed
subscription_interval_scalestringOptional
The value of the interval in which the product subscription renews at
subscription_interval_valueintegerOptional
The value of the interval in which the product subscription renews at
updated_atstringOptional
When the product was last updated
product_idstringRequired
The associated Product ID of the Delivery Item
product_version_idstringRequired
The associated Product Version ID of the Delivery Item
statestringRequired
The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
store_idstringRequired
The Flake ID of the Store associated with the Delivery Item
active_atstringOptional
Indicates when the Delivery Item become active
checkout_idstringOptional
The Flake ID of the Checkout associated with the Delivery Item
customerCustomerDTOOptional
idstringRequired
The Flake ID of the Customer
minecraftMinecraftCustomerDTORequired
→ MinecraftCustomerDTO
profileGenericProfileDTORequired
→ GenericProfileDTO
steamSteamCustomerDTORequired
→ SteamCustomerDTO
namestringOptional
execute_on_gameserverGameServerDTOOptional
enabledbooleanRequired
Indicates if the Game Server is enabled
idstringRequired
The Flake ID of the Game Server
namestringRequired
The name of the Game Server
execute_on_gameserver_idstringOptional
The Flake ID of the Game Server the Delivery Item is associated with
expires_atstringOptional
Indicates when the Delivery Item expires
order_customer_idstringOptional
The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
order_idstringOptional
The Flake ID of the Order ID associated with the Delivery Item
order_line_idstringOptional
The Flake Id of the Order Line ID associated with the Delivery Item
removed_atstringOptional
Indicates when the Delivery Item was removed from the customers inventory
revoke_reasonstringOptional
Indicates the reason the delivery item was revoked from the customers inventory
revoked_atstringOptional
Indicates when the Delivery Item was revoked from the customers inventory
subscription_idstringOptional
The Flake ID of the Subscription associated with the Delivery Item
event_idstringRequired
The ID of the Webhook Event
event_typeenumRequired
The type of webhook event
Possible enum values
  • ON_ORDER_COMPLETED
  • ON_REFUND
  • ON_CHARGEBACK
  • ON_CHARGEBACK_CLOSED
  • ON_DELIVERY_ITEM_ADDED
  • ON_DELIVERY_ITEM_ACTIVATED
  • ON_DELIVERY_ITEM_USED
  • ON_DELIVERY_ITEM_REVOKED
  • ON_DELIVERY_ITEM_EXPIRED
  • ON_DELIVERY_ITEM_RENEWED
  • ON_SUBSCRIPTION_ACTIVATED
  • ON_SUBSCRIPTION_RENEWED
  • ON_SUBSCRIPTION_CANCELED
  • ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT
  • ON_CONNECTED_USER_REGISTERED
  • ON_CONNECTED_USER_BECAME_PAYABLE
  • ON_CONNECTED_USER_BECAME_UNPAYABLE
  • ON_CONNECTED_USER_PAYOUT_CREATED
  • ON_CONNECTED_USER_PAYOUT_COMPLETED
  • ON_CONNECTED_USER_TRANSACTION_INSERTED
  • ON_CONNECTED_USER_TRUST_STATUS_CHANGED
  • ON_TRIAL_ACTIVATED
  • ON_TRIAL_COMPLETED
  • ON_TRIAL_CANCELED
  • ON_PURCHASE_FOLLOW_UP_ATTEMPT_EMAIL_SENT
  • ON_PURCHASE_FOLLOW_UP_ATTEMPT_SUCCEEDED
  • ON_ABANDONED_CHECKOUT_RECOVERY_ATTEMPT_EMAIL_SENT
  • ON_ABANDONED_CHECKOUT_RECOVERY_ATTEMPT_SUCCEEDED
  • ON_PAYMENT_COMPLETED
  • ON_PAYMENT_FAILED
Example payload
{
  "event_type": "ON_DELIVERY_ITEM_USED",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "version_id": "411486491630370816",
      "slug": "string",
      "name": "string",
      "description": "string",
      "enabled": true,
      "sort_order": 0,
      "price": 0,
      "single_game_server_only": true,
      "allow_one_time_purchase": true,
      "allow_subscription": true,
      "remove_after_enabled": true,
      "tags": [
        {
          "id": "411486491630370816",
          "slug": "string",
          "name": "string"
        }
      ],
      "tag_names": "string",
      "gameservers": [
        {
          "id": "411486491630370816",
          "name": "string",
          "enabled": true
        }
      ],
      "gameserver_names": "string",
      "commands": [
        {
          "stage": "on_purchase",
          "content": "string",
          "online_only": true
        }
      ],
      "metadata": {},
      "image_url": "string",
      "label": "string",
      "subscription_interval_value": 1,
      "subscription_interval_scale": "month",
      "remove_after_time_value": 1,
      "remove_after_time_scale": "month",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    },
    "state": "usable",
    "added_at": "2024-01-10T08:00:00Z",
    "customer": {
      "id": "411486491630370816",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "string"
      },
      "minecraft": {
        "id": "string",
        "name": "Notch",
        "avatar_url": "string"
      },
      "profile": {
        "id": "string",
        "platform": "string",
        "name": "John",
        "avatar_url": "string"
      },
      "name": "John"
    },
    "order_customer_id": "411486491630370816",
    "checkout_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "execute_on_gameserver": {
      "id": "411486491630370816",
      "name": "John",
      "enabled": true
    },
    "active_at": "2024-01-10T09:00:00Z",
    "expires_at": "2024-12-31T23:59:59Z",
    "removed_at": "2024-02-01T10:00:00Z",
    "revoked_at": "2024-02-05T14:30:00Z",
    "revoke_reason": "string"
  }
}