PayNow

ON_TRIAL_ACTIVATED

Triggered when a trial is activated

Payload
bodyobjectRequired
created_atstringRequired
The date and time when the Trial was created
customerCustomerDTORequired
idstringRequired
The Flake ID of the Customer
minecraftMinecraftCustomerDTORequired
→ MinecraftCustomerDTO
profileGenericProfileDTORequired
→ GenericProfileDTO
steamSteamCustomerDTORequired
→ SteamCustomerDTO
namestringOptional
customer_idstringRequired
The Flake ID of the Customer associated with the Trial
idstringRequired
The Flake ID of the Trial
period_scalestringRequired
The period scale of the Trial
period_valueintegerRequired
The period value of the Trial
product_idstringRequired
The Flake ID of the Product associated with the Trial
product_namestringRequired
The name of the Product associated with the Trial
product_version_idstringRequired
The Flake ID of the Product Version associated with the Trial
statusstringRequired
The current status of the Trial. Possible options: created, active, canceled, completed
store_idstringRequired
The Flake ID of the Store associated with the Trial
canceled_atstringOptional
Indicates when the Trial was canceled
checkout_idstringOptional
The Flake ID of the Checkout associated with the Trial
checkout_line_idstringOptional
The Flake ID of the Checkout Line associated with the Trial
ends_atstringOptional
The end date of the Trial
product_image_urlstringOptional
The image URL of the Product associated with the Trial
starts_atstringOptional
The start date of the Trial
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_TRIAL_ACTIVATED",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "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"
    },
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product_name": "Example Product",
    "period_value": 1,
    "period_scale": "month",
    "status": "created",
    "created_at": "2024-06-10T08:30:00Z",
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "product_image_url": "https://example.com/image.jpg",
    "starts_at": "2024-06-10T00:00:00Z",
    "ends_at": "2024-06-17T23:59:59Z",
    "canceled_at": "2024-06-15T10:15:00Z"
  }
}