ON_SUBSCRIPTION_ACTIVATED
Triggered when a subscription is activated
Payload
bodyobjectRequired
billing_countrystringRequired
The ISO-3166 Country Code of the customer associated with the Subscription
billing_cycle_sequenceintegerRequired
The current billing cycle number
billing_emailstringRequired
The billing email address of the customer associated with the Subscription
checkoutCheckoutDTORequired
idstringRequired
The Flake ID of the Checkout
metadataobjectRequired
Metadata associated with the checkout
checkout_idstringRequired
The Flake ID of the Checkout associated with the Subscription
checkout_line_idstringRequired
The Flake ID of the Checkout Line associated with the Subscription
currencystringRequired
The currency code of the Subscription
customerCustomerDTORequired
idstringRequired
The Flake ID of the Customer
minecraftMinecraftCustomerDTORequired
→ MinecraftCustomerDTOprofileGenericProfileDTORequired
→ GenericProfileDTOsteamSteamCustomerDTORequired
→ SteamCustomerDTOnamestringOptional
customer_idstringRequired
The Flake ID of the Customer associated with the Subscription
customer_ipstringRequired
The IP address of the Customer
discount_amountintegerRequired
The discount amount applied to the Subscription represented in cents
idstringRequired
The Flake ID of the Subscription
initial_discount_amountintegerRequired
The initial discount amount applied to the Subscription represented in cents
initial_giftcard_usage_amountintegerRequired
The initial gift card usage amount applied to the Subscription represented in cents
initial_subtotal_amountintegerRequired
The initial subtotal amount of the Subscription represented in cents
initial_tax_amountintegerRequired
The initial tax amount of the Subscription represented in cents
initial_total_amountintegerRequired
The initial total amount of the Subscription represented in cents
interval_scalestringRequired
The interval scale of the billing cycle
interval_valueintegerRequired
The interval value of the billing cycle
linesSubscriptionLineDTO[]RequiredThe lines of the Subscription
currencystringRequired
The currency code of this Subscription Line
discount_amountintegerRequired
The discount amount applied to this Subscription Line represented in cents
idstringRequired
The Flake ID of the Subscription Line
initial_discount_amountintegerRequired
The initial discount amount applied to this Subscription Line represented in cents
initial_giftcard_usage_amountintegerRequired
The initial gift card usage amount applied to this Subscription Line represented in cents
initial_subtotal_amountintegerRequired
The initial subtotal amount of this Subscription Line represented in cents
initial_tax_amountintegerRequired
The initial tax amount of this Subscription Line represented in cents
initial_total_amountintegerRequired
The initial total amount of this Subscription Line represented in cents
priceintegerRequired
The price of this Subscription Line represented in cents
product_idstringRequired
The Flake ID of the Product associated with this Subscription Line
product_namestringRequired
The name of the Product associated with this Subscription Line
product_version_idstringRequired
The Flake ID of the Product Version associated with this Subscription Line
subscription_idstringRequired
The Flake ID of the Subscription associated with this Subscription Line
subtotal_amountintegerRequired
The subtotal amount of this Subscription Line represented in cents
tax_amountintegerRequired
The tax amount of this Subscription Line represented in cents
tax_inclusivebooleanRequired
Whether the price of this Subscription Line is tax inclusive
total_amountintegerRequired
The total amount of this Subscription Line represented in cents
checkout_line_idstringOptional
The Flake ID of the Checkout Line associated with this Subscription Line
gift_to_customerCustomerDTOOptional
→ CustomerDTOgift_to_customer_idstringOptional
The Flake ID of the customer this Subscription Line was gifted to
initial_order_line_idstringOptional
The Flake ID of the initial Order Line associated with this Subscription Line
initial_presentment_discount_amountintegerOptional
The initial presentment discount amount of this Subscription Line represented in cents
initial_presentment_giftcard_usage_amountintegerOptional
The initial presentment gift card usage amount of this Subscription Line represented in cents
initial_presentment_subtotal_amountintegerOptional
The initial presentment subtotal amount of this Subscription Line represented in cents
initial_presentment_tax_amountintegerOptional
The initial presentment tax amount of this Subscription Line represented in cents
initial_presentment_total_amountintegerOptional
The initial presentment total amount of this Subscription Line represented in cents
presentment_currencystringOptional
The presentment currency code of this Subscription Line
presentment_discount_amountintegerOptional
The presentment discount amount of this Subscription Line represented in cents
presentment_subtotal_amountintegerOptional
The presentment subtotal amount of this Subscription Line represented in cents
presentment_tax_amountintegerOptional
The presentment tax amount of this Subscription Line represented in cents
presentment_total_amountintegerOptional
The presentment total amount of this Subscription Line represented in cents
productProductDTOOptional
→ ProductDTOproduct_image_urlstringOptional
The image URL of the Product associated with this Subscription Line
sale_idstringOptional
The Flake ID of the Sale associated with this Subscription Line
selected_gameserver_idstringOptional
The Flake ID of the selected Game Server for this Subscription Line
trial_idstringOptional
The Flake ID of the Trial associated with this Subscription Line
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
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
→ ProductGameServerDTOidstringRequired
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
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 Flake ID of the Product associated with the Subscription
product_namestringRequired
The name of the Product associated with the Subscription
product_version_idstringRequired
The Flake ID of the Product Version associated with the Subscription
statusstringRequired
The current status of the Subscription. Possible options: created, active, canceled
store_idstringRequired
The Flake ID of the Store associated with the Subscription
subtotal_amountintegerRequired
The subtotal amount of the Subscription represented in cents
tax_amountintegerRequired
The tax amount of the Subscription represented in cents
total_amountintegerRequired
The total amount of the Subscription represented in cents
active_atstringOptional
Indicates when the subscription was active
created_atstringOptional
The date and time when the Subscription was created
current_period_endstringOptional
The end date of the current billing period
current_period_startstringOptional
The start date of the current billing period
product_image_urlstringOptional
The image URL of the Product associated with the Subscription
event_idstringRequired
The ID of the Webhook Event
event_typeenumRequired
The type of webhook event
Possible enum values
ON_ORDER_COMPLETEDON_REFUNDON_CHARGEBACKON_CHARGEBACK_CLOSEDON_DELIVERY_ITEM_ADDEDON_DELIVERY_ITEM_ACTIVATEDON_DELIVERY_ITEM_USEDON_DELIVERY_ITEM_REVOKEDON_DELIVERY_ITEM_EXPIREDON_DELIVERY_ITEM_RENEWEDON_SUBSCRIPTION_ACTIVATEDON_SUBSCRIPTION_RENEWEDON_SUBSCRIPTION_CANCELEDON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUTON_CONNECTED_USER_REGISTEREDON_CONNECTED_USER_BECAME_PAYABLEON_CONNECTED_USER_BECAME_UNPAYABLEON_CONNECTED_USER_PAYOUT_CREATEDON_CONNECTED_USER_PAYOUT_COMPLETEDON_CONNECTED_USER_TRANSACTION_INSERTEDON_CONNECTED_USER_TRUST_STATUS_CHANGEDON_TRIAL_ACTIVATEDON_TRIAL_COMPLETEDON_TRIAL_CANCELEDON_PURCHASE_FOLLOW_UP_ATTEMPT_EMAIL_SENTON_PURCHASE_FOLLOW_UP_ATTEMPT_SUCCEEDEDON_ABANDONED_CHECKOUT_RECOVERY_ATTEMPT_EMAIL_SENTON_ABANDONED_CHECKOUT_RECOVERY_ATTEMPT_SUCCEEDEDON_PAYMENT_COMPLETEDON_PAYMENT_FAILED
Example payload
{
"event_type": "ON_SUBSCRIPTION_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"
},
"checkout": {
"id": "411486491630370816",
"metadata": {},
"lines": [
{
"id": "411486491630370816",
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"metadata": {}
}
]
},
"billing_cycle_sequence": 1,
"billing_email": "[email protected]",
"subtotal_amount": 9999,
"tax_amount": 1500,
"discount_amount": 1000,
"total_amount": 10499,
"currency": "USD",
"interval_value": 1,
"interval_scale": "month",
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"product_name": "Example Product",
"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"
},
"billing_country": "US",
"initial_subtotal_amount": 9999,
"initial_tax_amount": 1500,
"initial_discount_amount": 2000,
"initial_giftcard_usage_amount": 0,
"initial_total_amount": 9499,
"customer_ip": "127.0.0.1/24",
"checkout_id": "411486491630370816",
"checkout_line_id": "411486491630370816",
"status": "created",
"lines": [
{
"id": "411486491630370816",
"subscription_id": "411486491630370816",
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"product_name": "Example Product",
"tax_inclusive": false,
"price": 9999,
"discount_amount": 1000,
"subtotal_amount": 8999,
"tax_amount": 1350,
"total_amount": 10349,
"initial_discount_amount": 2000,
"initial_subtotal_amount": 7999,
"initial_giftcard_usage_amount": 0,
"initial_tax_amount": 1200,
"initial_total_amount": 9199,
"currency": "USD",
"checkout_line_id": "411486491630370816",
"initial_order_line_id": "411486491630370816",
"gift_to_customer_id": "411486491630370816",
"gift_to_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"
},
"selected_gameserver_id": "411486491630370816",
"sale_id": "411486491630370816",
"trial_id": "411486491630370816",
"product_image_url": "https://example.com/image.jpg",
"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"
},
"presentment_currency": "EUR",
"presentment_subtotal_amount": 8299,
"presentment_discount_amount": 0,
"presentment_tax_amount": 1245,
"presentment_total_amount": 9544,
"initial_presentment_discount_amount": 0,
"initial_presentment_subtotal_amount": 7359,
"initial_presentment_giftcard_usage_amount": 0,
"initial_presentment_tax_amount": 1104,
"initial_presentment_total_amount": 8463
}
],
"product_image_url": "https://example.com/image.jpg",
"current_period_start": "2024-02-01T00:00:00Z",
"current_period_end": "2024-03-01T00:00:00Z",
"created_at": "2024-02-01T10:15:00Z",
"active_at": "2024-02-01T10:20:00Z"
}
}