{ "openapi": "3.1.1", "info": { "title": "PayNow Webhook Definitions", "description": "Webhook event specifications triggered by the PayNow API. These events are sent to your configured webhook URLs and contain event data such as orders, refunds, and subscription changes. Each webhook below represents an event type that your application can subscribe to.", "termsOfService": "https://paynow.gg/terms-of-use", "contact": { "name": "PayNow Services, Inc.", "url": "https://paynow.gg", "email": "support@paynow.gg" }, "version": "v1" }, "paths": { }, "components": { "schemas": { "CheckoutDTO": { "required": [ "id", "metadata", "lines" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Checkout", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata associated with the checkout", "x-discordVariable": "metadata" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CheckoutLineDTO" }, "description": "The lines of the Checkout", "x-discordVariable": "lines" } } }, "CheckoutLineDTO": { "required": [ "id", "product_id", "product_version_id", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the Checkout line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "product_id": { "type": "string", "description": "The Product Flake ID of the Checkout Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The Product Version Flake ID of the Checkout Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata associated with the Checkout Line", "x-discordVariable": "metadata" } } }, "CustomerDTO": { "required": [ "id", "steam", "minecraft", "profile" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Customer", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "name": { "type": [ "null", "string" ], "description": "", "example": "John", "x-discordVariable": "name" }, "steam": { "$ref": "#/components/schemas/SteamCustomerDTO" }, "minecraft": { "$ref": "#/components/schemas/MinecraftCustomerDTO" }, "profile": { "$ref": "#/components/schemas/GenericProfileDTO" } } }, "GameServerDTO": { "required": [ "id", "name", "enabled" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Game Server", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "name": { "type": "string", "description": "The name of the Game Server", "example": "John", "x-discordVariable": "name" }, "enabled": { "type": "boolean", "description": "Indicates if the Game Server is enabled", "x-discordVariable": "enabled" } } }, "GenericProfileDTO": { "required": [ "id", "platform", "name", "avatar_url" ], "type": "object", "properties": { "id": { "type": "string", "description": "", "x-discordVariable": "id" }, "platform": { "type": "string", "description": "", "x-discordVariable": "platform" }, "name": { "type": "string", "description": "", "example": "John", "x-discordVariable": "name" }, "avatar_url": { "type": "string", "description": "", "x-discordVariable": "avatar_url" } } }, "MinecraftCustomerDTO": { "required": [ "id", "name", "avatar_url" ], "type": "object", "properties": { "id": { "type": "string", "description": "", "x-discordVariable": "id" }, "name": { "type": "string", "description": "", "example": "Notch", "x-discordVariable": "name" }, "avatar_url": { "type": "string", "description": "", "x-discordVariable": "avatar_url" } } }, "OrderCouponUsageDTO": { "required": [ "coupon_id", "usage_amount" ], "type": "object", "properties": { "coupon_id": { "type": "string", "description": "", "format": "flake-id", "example": "411486491630370816" }, "usage_amount": { "type": "integer", "description": "" } } }, "OrderDTO": { "required": [ "id", "store_id", "customer", "checkout_id", "checkout", "applied_coupons", "applied_giftcards", "coupon_id", "type", "currency", "tax_inclusive", "tax_amount", "discount_amount", "subtotal_amount", "total_amount", "created_at", "completed_at", "billing_name", "billing_email", "billing_address_country", "customer_ip", "giftcard_usage_amount", "lines", "product_names", "product_tags", "product_gameservers", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Order", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the store associated with the order", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer": { "$ref": "#/components/schemas/CustomerDTO" }, "checkout_id": { "type": "string", "description": "The Flake ID of the Checkout associated with the order", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "checkout": { "$ref": "#/components/schemas/CheckoutDTO" }, "subscription_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Subscription associated with the order", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "subscription_id" }, "applied_coupons": { "type": "array", "items": { "$ref": "#/components/schemas/OrderCouponUsageDTO" }, "description": "Applied coupons to this order", "x-discordVariable": "applied_coupons" }, "applied_giftcards": { "type": "array", "items": { "$ref": "#/components/schemas/OrderGiftCardUsageDTO" }, "description": "Applied gift cards to this order", "x-discordVariable": "applied_giftcards" }, "coupon_id": { "type": "string", "description": "The Flake ID of the Coupon associated with the order", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "coupon_id" }, "type": { "type": "string", "description": "The type of the order", "example": "one_time", "x-discordVariable": "type" }, "currency": { "type": "string", "description": "The ISO-4217 Currency Code of the order", "example": "USD", "x-discordVariable": "currency" }, "tax_inclusive": { "type": "boolean", "description": "Indicates if the order value was inclusive of tax", "example": true, "x-discordVariable": "tax_inclusive" }, "tax_amount": { "type": "integer", "description": "The tax amount, represented as cents", "example": 1500, "x-discordVariable": "tax_amount" }, "discount_amount": { "type": "integer", "description": "The discount amount, represented as cents", "example": 500, "x-discordVariable": "discount_amount" }, "subtotal_amount": { "type": "integer", "description": "The subtotal amount, represented as cents", "example": 10000, "x-discordVariable": "subtotal_amount" }, "total_amount": { "type": "integer", "description": "The total amount, represented as cents", "example": 11000, "x-discordVariable": "total_amount" }, "created_at": { "type": "string", "description": "Indicates when the order was created", "format": "date-time", "example": "2024-01-15T10:30:00Z", "x-discordVariable": "created_at" }, "completed_at": { "type": "string", "description": "Indicates when the order was completed", "format": "date-time", "example": "2024-01-15T10:35:00Z", "x-discordVariable": "completed_at" }, "billing_name": { "type": "string", "description": "The billing name of the customer associated with the order", "example": "John Doe", "x-discordVariable": "billing_name" }, "billing_email": { "type": "string", "description": "The billing email address of the customer associated with the order", "example": "john@doe.com", "x-discordVariable": "billing_email" }, "billing_address_country": { "type": "string", "description": "The ISO-3316 Country Code of the customer associated with the order", "example": "US", "x-discordVariable": "billing_address_country" }, "customer_ip": { "type": "string", "description": "The IPv4 or IPv6 Address of the associated customer when creating the order", "example": "127.0.0.1/24", "x-discordVariable": "customer_ip" }, "giftcard_usage_amount": { "type": "integer", "description": "The total amount of giftcard usage associated with the order, represented in cents", "example": 0, "x-discordVariable": "giftcard_usage_amount" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineDTO" }, "description": "The order lines associated with the order", "x-discordVariable": "lines" }, "product_names": { "type": "string", "description": "A comma-seperated string of the names of the product associated with the order", "example": "Product A, Product B", "x-discordVariable": "product_names" }, "product_tags": { "type": "string", "description": "A comma-seperated string of the tags of the products associated with the order", "example": "ranks, perks", "x-discordVariable": "product_tags" }, "product_gameservers": { "type": "string", "description": "A comma-seperated string of the gameservers of the product associated with the order", "example": "game server one, game server two", "x-discordVariable": "product_gameservers" }, "status": { "type": "string", "description": "The status of the Order. Possbile options: created, completed, canceled", "example": "created", "x-discordVariable": "status" } } }, "OrderGiftCardUsageDTO": { "required": [ "giftcard_id", "usage_amount" ], "type": "object", "properties": { "giftcard_id": { "type": "string", "description": "", "format": "flake-id", "example": "411486491630370816" }, "usage_amount": { "type": "integer", "description": "" } } }, "OrderLineDTO": { "required": [ "id", "product_id", "product_version_id", "product", "product_name", "price", "quantity", "discount_amount", "subtotal_amount", "tax_amount", "total_amount" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Order Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "checkout_line_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Checkout Line associated with this Order Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_line_id" }, "product_id": { "type": "string", "description": "The Flake ID of the Product ID associated with this Order Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The Flake ID of the Product Version ID associated with this Order Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "product_name": { "type": "string", "description": "The name of the product associated with this Order Line", "x-discordVariable": "product_name" }, "product_image_url": { "type": [ "null", "string" ], "description": "The Image URL of the Product associated with this Order Line", "x-discordVariable": "product_image_url" }, "subscription_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Subscription associated with this Order Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "subscription_id" }, "subscription_line_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Subscription Line associated with this Order Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "subscription_line_id" }, "subscription_interval_value": { "type": [ "null", "integer" ], "description": "The value of the interval in which the subscription associated with this Order Line renews at", "example": 1, "x-discordVariable": "subscription_interval_value" }, "subscription_interval_scale": { "type": [ "null", "string" ], "description": "The value of the scale in which the subscription associated with this Order Line renews at", "example": "month", "x-discordVariable": "subscription_interval_scale" }, "trial_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Trial associated with this Order Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "trial_id" }, "gift_to_customer": { "oneOf": [ { "$ref": "#/components/schemas/CustomerDTO" }, { "type": "null" } ], "x-discordVariable": "gift_to_customer" }, "price": { "type": "integer", "description": "The price of the Order Line", "example": 1000, "x-discordVariable": "price" }, "quantity": { "type": "integer", "description": "The quantity of the Order Line", "example": 1, "x-discordVariable": "quantity" }, "discount_amount": { "type": "integer", "description": "The discount amount of the order line, represented in cents", "example": 0, "x-discordVariable": "discount_amount" }, "subtotal_amount": { "type": "integer", "description": "The subtotal amount of the order line, represented in cents", "example": 1000, "x-discordVariable": "subtotal_amount" }, "tax_amount": { "type": "integer", "description": "The tax amount of the order line, represented in cents", "example": 100, "x-discordVariable": "tax_amount" }, "total_amount": { "type": "integer", "description": "The total amount of the order line, represented in cents", "example": 1100, "x-discordVariable": "total_amount" }, "selected_gameserver_id": { "type": [ "null", "string" ], "description": "The Flake ID of which was the selected Game Server ID for the Order Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "selected_gameserver_id" } } }, "ProductCommandDTO": { "required": [ "stage", "content", "online_only" ], "type": "object", "properties": { "stage": { "type": "string", "description": "The stage of which the Product Command should be executed. Possible options: on_purchase, on_expire, on_refund, on_renew, on_chargeback, on_trial_start, on_trial_expire", "example": "on_purchase", "x-discordVariable": "stage" }, "content": { "type": "string", "description": "The command to execute", "x-discordVariable": "content" }, "online_only": { "type": "boolean", "description": "Indicated if the command should be executed only when the customer is online", "x-discordVariable": "online_only" } } }, "ProductDTO": { "required": [ "id", "store_id", "version_id", "slug", "name", "description", "enabled", "sort_order", "price", "single_game_server_only", "allow_one_time_purchase", "allow_subscription", "remove_after_enabled", "tags", "tag_names", "gameservers", "gameserver_names", "commands", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Product", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "version_id": { "type": "string", "description": "The Flake ID of the Version of the Product", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "version_id" }, "image_url": { "type": [ "null", "string" ], "description": "The Image URL of the product", "x-discordVariable": "image_url" }, "slug": { "type": "string", "description": "The URL-Friendly Slug of the Product", "x-discordVariable": "slug" }, "name": { "type": "string", "description": "The name of the Product", "x-discordVariable": "name" }, "description": { "type": "string", "description": "The description of the product", "x-discordVariable": "description" }, "enabled": { "type": "boolean", "description": "Indicates if the product is enabled.", "x-discordVariable": "enabled" }, "label": { "type": [ "null", "string" ], "description": "The label of the product", "x-discordVariable": "label" }, "sort_order": { "type": "integer", "description": "The sort order of the product", "x-discordVariable": "sort_order" }, "price": { "type": "integer", "description": "The price of the product, represented in cents.", "x-discordVariable": "price" }, "single_game_server_only": { "type": "boolean", "description": "Indicates if the customer must select a single game server when purchasing the product", "x-discordVariable": "single_game_server_only" }, "allow_one_time_purchase": { "type": "boolean", "description": "Indicates if one-time purchases are supported on the product", "x-discordVariable": "allow_one_time_purchase" }, "allow_subscription": { "type": "boolean", "description": "Indicates if subscriptions are supported on the product", "x-discordVariable": "allow_subscription" }, "subscription_interval_value": { "type": [ "null", "integer" ], "description": "The value of the interval in which the product subscription renews at", "example": 1, "x-discordVariable": "subscription_interval_value" }, "subscription_interval_scale": { "type": [ "null", "string" ], "description": "The value of the interval in which the product subscription renews at", "example": "month", "x-discordVariable": "subscription_interval_scale" }, "remove_after_enabled": { "type": "boolean", "description": "Indicates whether automatic removal is enabled", "x-discordVariable": "remove_after_enabled" }, "remove_after_time_value": { "type": [ "null", "integer" ], "description": "The value of the time in which this product should be removed", "example": 1, "x-discordVariable": "remove_after_time_value" }, "remove_after_time_scale": { "type": [ "null", "string" ], "description": "The scale of the time in which this product should be removed", "example": "month", "x-discordVariable": "remove_after_time_scale" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/ProductTagDTO" }, "description": "The tags associated with the product", "x-discordVariable": "tags" }, "tag_names": { "type": "string", "description": "A comma-seperated string of all the tags associated with the product", "x-discordVariable": "tag_names" }, "gameservers": { "type": "array", "items": { "$ref": "#/components/schemas/ProductGameServerDTO" }, "description": "The game servers associated with the product", "x-discordVariable": "gameservers" }, "gameserver_names": { "type": "string", "description": "A comma-seperated string of all the game servers associated with the product", "x-discordVariable": "gameserver_names" }, "commands": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCommandDTO" }, "description": "The commands associated with the product", "x-discordVariable": "commands" }, "created_at": { "type": [ "null", "string" ], "description": "When the product was created", "format": "date-time", "x-discordVariable": "created_at" }, "updated_at": { "type": [ "null", "string" ], "description": "When the product was last updated", "format": "date-time", "x-discordVariable": "updated_at" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The metadata of the product" } } }, "ProductGameServerDTO": { "required": [ "id", "name", "enabled" ], "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the Game Server", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "name": { "type": "string", "description": "The name of the Game Server", "x-discordVariable": "name" }, "enabled": { "type": "boolean", "description": "Indicates if the Game Server is enabled", "x-discordVariable": "enabled" } } }, "ProductTagDTO": { "required": [ "id", "slug", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Product Tag", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "slug": { "type": "string", "description": "The URL-Friendly slug of the Product Tag", "x-discordVariable": "slug" }, "name": { "type": "string", "description": "The name of the Product Tag", "x-discordVariable": "name" } } }, "SteamCustomerDTO": { "required": [ "id", "name", "avatar_url" ], "type": "object", "properties": { "id": { "type": "string", "description": "SteamID64", "example": "76561197960287930", "x-discordVariable": "id" }, "name": { "type": "string", "description": "The name on the Steam Profile", "example": "John", "x-discordVariable": "name" }, "avatar_url": { "type": "string", "description": "The Steam Avatar URL", "x-discordVariable": "avatar_url" } } }, "SubscriptionLineDTO": { "required": [ "id", "subscription_id", "product_id", "product_version_id", "product_name", "tax_inclusive", "price", "discount_amount", "subtotal_amount", "tax_amount", "total_amount", "initial_discount_amount", "initial_subtotal_amount", "initial_giftcard_usage_amount", "initial_tax_amount", "initial_total_amount", "currency" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Subscription Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "subscription_id": { "type": "string", "description": "The Flake ID of the Subscription associated with this Subscription Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "subscription_id" }, "checkout_line_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Checkout Line associated with this Subscription Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_line_id" }, "initial_order_line_id": { "type": [ "null", "string" ], "description": "The Flake ID of the initial Order Line associated with this Subscription Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "initial_order_line_id" }, "gift_to_customer_id": { "type": [ "null", "string" ], "description": "The Flake ID of the customer this Subscription Line was gifted to", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "gift_to_customer_id" }, "gift_to_customer": { "oneOf": [ { "$ref": "#/components/schemas/CustomerDTO" }, { "type": "null" } ], "x-discordVariable": "gift_to_customer" }, "selected_gameserver_id": { "type": [ "null", "string" ], "description": "The Flake ID of the selected Game Server for this Subscription Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "selected_gameserver_id" }, "sale_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Sale associated with this Subscription Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "sale_id" }, "trial_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Trial associated with this Subscription Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "trial_id" }, "product_id": { "type": "string", "description": "The Flake ID of the Product associated with this Subscription Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The Flake ID of the Product Version associated with this Subscription Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product_name": { "type": "string", "description": "The name of the Product associated with this Subscription Line", "example": "Example Product", "x-discordVariable": "product_name" }, "product_image_url": { "type": [ "null", "string" ], "description": "The image URL of the Product associated with this Subscription Line", "example": "https://example.com/image.jpg", "x-discordVariable": "product_image_url" }, "product": { "oneOf": [ { "$ref": "#/components/schemas/ProductDTO" }, { "type": "null" } ], "x-discordVariable": "product" }, "tax_inclusive": { "type": "boolean", "description": "Whether the price of this Subscription Line is tax inclusive", "example": false, "x-discordVariable": "tax_inclusive" }, "price": { "type": "integer", "description": "The price of this Subscription Line represented in cents", "example": 9999, "x-discordVariable": "price" }, "discount_amount": { "type": "integer", "description": "The discount amount applied to this Subscription Line represented in cents", "example": 1000, "x-discordVariable": "discount_amount" }, "subtotal_amount": { "type": "integer", "description": "The subtotal amount of this Subscription Line represented in cents", "example": 8999, "x-discordVariable": "subtotal_amount" }, "tax_amount": { "type": "integer", "description": "The tax amount of this Subscription Line represented in cents", "example": 1350, "x-discordVariable": "tax_amount" }, "total_amount": { "type": "integer", "description": "The total amount of this Subscription Line represented in cents", "example": 10349, "x-discordVariable": "total_amount" }, "initial_discount_amount": { "type": "integer", "description": "The initial discount amount applied to this Subscription Line represented in cents", "example": 2000, "x-discordVariable": "initial_discount_amount" }, "initial_subtotal_amount": { "type": "integer", "description": "The initial subtotal amount of this Subscription Line represented in cents", "example": 7999, "x-discordVariable": "initial_subtotal_amount" }, "initial_giftcard_usage_amount": { "type": "integer", "description": "The initial gift card usage amount applied to this Subscription Line represented in cents", "example": 0, "x-discordVariable": "initial_giftcard_usage_amount" }, "initial_tax_amount": { "type": "integer", "description": "The initial tax amount of this Subscription Line represented in cents", "example": 1200, "x-discordVariable": "initial_tax_amount" }, "initial_total_amount": { "type": "integer", "description": "The initial total amount of this Subscription Line represented in cents", "example": 9199, "x-discordVariable": "initial_total_amount" }, "currency": { "type": "string", "description": "The currency code of this Subscription Line", "example": "USD", "x-discordVariable": "currency" }, "presentment_currency": { "type": [ "null", "string" ], "description": "The presentment currency code of this Subscription Line", "example": "EUR", "x-discordVariable": "presentment_currency" }, "presentment_subtotal_amount": { "type": [ "null", "integer" ], "description": "The presentment subtotal amount of this Subscription Line represented in cents", "example": 8299, "x-discordVariable": "presentment_subtotal_amount" }, "presentment_discount_amount": { "type": [ "null", "integer" ], "description": "The presentment discount amount of this Subscription Line represented in cents", "example": 0, "x-discordVariable": "presentment_discount_amount" }, "presentment_tax_amount": { "type": [ "null", "integer" ], "description": "The presentment tax amount of this Subscription Line represented in cents", "example": 1245, "x-discordVariable": "presentment_tax_amount" }, "presentment_total_amount": { "type": [ "null", "integer" ], "description": "The presentment total amount of this Subscription Line represented in cents", "example": 9544, "x-discordVariable": "presentment_total_amount" }, "initial_presentment_discount_amount": { "type": [ "null", "integer" ], "description": "The initial presentment discount amount of this Subscription Line represented in cents", "example": 0, "x-discordVariable": "initial_presentment_discount_amount" }, "initial_presentment_subtotal_amount": { "type": [ "null", "integer" ], "description": "The initial presentment subtotal amount of this Subscription Line represented in cents", "example": 7359, "x-discordVariable": "initial_presentment_subtotal_amount" }, "initial_presentment_giftcard_usage_amount": { "type": [ "null", "integer" ], "description": "The initial presentment gift card usage amount of this Subscription Line represented in cents", "example": 0, "x-discordVariable": "initial_presentment_giftcard_usage_amount" }, "initial_presentment_tax_amount": { "type": [ "null", "integer" ], "description": "The initial presentment tax amount of this Subscription Line represented in cents", "example": 1104, "x-discordVariable": "initial_presentment_tax_amount" }, "initial_presentment_total_amount": { "type": [ "null", "integer" ], "description": "The initial presentment total amount of this Subscription Line represented in cents", "example": 8463, "x-discordVariable": "initial_presentment_total_amount" } } }, "WebhookEventType": { "enum": [ "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" ], "type": "string", "description": "The type of webhook event" } } }, "webhooks": { "ON_CHARGEBACK": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a chargeback is created", "description": "Webhook for ON_CHARGEBACK", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_CHARGEBACK" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "order_id", "gateway", "currency", "tax_inclusive", "amount", "gateway_fee_amount", "tax_amount", "platform_fee_amount", "store_net_amount", "status", "chargeback_status", "chargeback_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Payment associated with the Payment", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Payment", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "order_id": { "type": "string", "description": "The Flake ID of the Order associated with Payment", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_id" }, "customer": { "oneOf": [ { "$ref": "#/components/schemas/CustomerDTO" }, { "type": "null" } ], "x-discordVariable": "customer" }, "gateway": { "type": "string", "description": "The Payment Gateway of the Payment", "example": "stripe", "x-discordVariable": "gateway" }, "currency": { "type": "string", "description": "The ISO-4217 Currency Code of the Payment", "example": "USD", "x-discordVariable": "currency" }, "tax_inclusive": { "type": "boolean", "description": "Indicates if the payment was Tax Inclusive", "example": true, "x-discordVariable": "tax_inclusive" }, "amount": { "type": "integer", "description": "The payment amount, represented in cents", "example": 7500, "x-discordVariable": "amount" }, "gateway_fee_amount": { "type": "integer", "description": "The gateway fee amount, represented in cents", "example": 200, "x-discordVariable": "gateway_fee_amount" }, "tax_amount": { "type": "integer", "description": "The tax amount, represented in cents", "example": 1200, "x-discordVariable": "tax_amount" }, "platform_fee_amount": { "type": "integer", "description": "The platform fee amount, represented in cents", "example": 375, "x-discordVariable": "platform_fee_amount" }, "store_net_amount": { "type": "integer", "description": "The net amount recieved by the associated store, represented in cents", "example": 5925, "x-discordVariable": "store_net_amount" }, "status": { "type": "string", "description": "The status of the payment", "x-discordVariable": "status" }, "chargeback_status": { "type": "string", "description": "The chargeback outcome", "x-discordVariable": "chargeback_status" }, "chargeback_at": { "type": "string", "description": "Indicated when a chargeback was opened for the payment", "format": "date-time", "example": "2024-01-25T14:45:00Z", "x-discordVariable": "chargeback_at" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_CHARGEBACK_CLOSED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a chargeback is resolved", "description": "Webhook for ON_CHARGEBACK_CLOSED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_CHARGEBACK_CLOSED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "order_id", "gateway", "currency", "tax_inclusive", "amount", "gateway_fee_amount", "tax_amount", "platform_fee_amount", "store_net_amount", "status", "chargeback_status", "chargeback_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Payment associated with the Payment", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Payment", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "order_id": { "type": "string", "description": "The Flake ID of the Order associated with Payment", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_id" }, "customer": { "oneOf": [ { "$ref": "#/components/schemas/CustomerDTO" }, { "type": "null" } ], "x-discordVariable": "customer" }, "gateway": { "type": "string", "description": "The Payment Gateway of the Payment", "example": "stripe", "x-discordVariable": "gateway" }, "currency": { "type": "string", "description": "The ISO-4217 Currency Code of the Payment", "example": "USD", "x-discordVariable": "currency" }, "tax_inclusive": { "type": "boolean", "description": "Indicates if the payment was Tax Inclusive", "example": true, "x-discordVariable": "tax_inclusive" }, "amount": { "type": "integer", "description": "The payment amount, represented in cents", "example": 7500, "x-discordVariable": "amount" }, "gateway_fee_amount": { "type": "integer", "description": "The gateway fee amount, represented in cents", "example": 200, "x-discordVariable": "gateway_fee_amount" }, "tax_amount": { "type": "integer", "description": "The tax amount, represented in cents", "example": 1200, "x-discordVariable": "tax_amount" }, "platform_fee_amount": { "type": "integer", "description": "The platform fee amount, represented in cents", "example": 375, "x-discordVariable": "platform_fee_amount" }, "store_net_amount": { "type": "integer", "description": "The net amount recieved by the associated store, represented in cents", "example": 5925, "x-discordVariable": "store_net_amount" }, "status": { "type": "string", "description": "The status of the payment", "x-discordVariable": "status" }, "chargeback_status": { "type": "string", "description": "The chargeback outcome", "x-discordVariable": "chargeback_status" }, "chargeback_at": { "type": "string", "description": "Indicated when a chargeback was opened for the payment", "format": "date-time", "example": "2024-01-25T14:45:00Z", "x-discordVariable": "chargeback_at" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a Discord account is successfully linked to a checkout.", "description": "Webhook for ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "store_id", "customer_id", "customer", "checkout_id", "checkout_line_id", "order_id", "order", "discord_user_id", "discord_user_name", "discord_user_avatar_hash", "product_id", "product_version_id", "product" ], "type": "object", "properties": { "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Checkout", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer_id": { "type": "string", "description": "The Flake ID of the Customer associated with the Checkout", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "customer_id" }, "customer": { "$ref": "#/components/schemas/CustomerDTO" }, "checkout_id": { "type": "string", "description": "The Flake ID of the Checkout", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "checkout_line_id": { "type": "string", "description": "The Flake ID of the Checkout Line", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_line_id" }, "order_id": { "type": "string", "description": "The Flake ID of the Order associated with the Checkout", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_id" }, "order": { "$ref": "#/components/schemas/OrderDTO" }, "discord_user_id": { "type": "string", "description": "The Discord User ID of the linked account", "example": "123456789012345678", "x-discordVariable": "discord_user_id" }, "discord_user_name": { "type": "string", "description": "The Discord username of the linked account", "example": "john_doe", "x-discordVariable": "discord_user_name" }, "discord_user_avatar_hash": { "type": "string", "description": "The Discord avatar hash of the linked account", "example": "a1b2c3d4e5f6g7h8i9j0", "x-discordVariable": "discord_user_avatar_hash" }, "product_id": { "type": "string", "description": "The Flake ID of the Product associated with the Checkout", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The Flake ID of the Product Version associated with the Checkout", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "enqueued_at": { "type": [ "null", "string" ], "description": "Indicates when the Discord account link was enqueued", "format": "date-time", "example": "2024-01-15T10:30:00Z", "x-discordVariable": "enqueued_at" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_DELIVERY_ITEM_ADDED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a delivery item is added to the customers inventory", "description": "Webhook for ON_DELIVERY_ITEM_ADDED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_DELIVERY_ITEM_ADDED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "product_id", "product_version_id", "product", "state", "added_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer": { "oneOf": [ { "$ref": "#/components/schemas/CustomerDTO" }, { "type": "null" } ], "x-discordVariable": "customer" }, "order_customer_id": { "type": [ "null", "string" ], "description": "The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_customer_id" }, "checkout_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Checkout associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "order_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Order ID associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_id" }, "order_line_id": { "type": [ "null", "string" ], "description": "The Flake Id of the Order Line ID associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_line_id" }, "subscription_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Subscription associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "subscription_id" }, "execute_on_gameserver_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Game Server the Delivery Item is associated with", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "execute_on_gameserver_id" }, "execute_on_gameserver": { "oneOf": [ { "$ref": "#/components/schemas/GameServerDTO" }, { "type": "null" } ], "x-discordVariable": "execute_on_gameserver" }, "product_id": { "type": "string", "description": "The associated Product ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The associated Product Version ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "state": { "type": "string", "description": "The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed", "example": "usable", "x-discordVariable": "state" }, "added_at": { "type": "string", "description": "Indicates when the Delivery Item was added to the customers inventory", "format": "date-time", "example": "2024-01-10T08:00:00Z", "x-discordVariable": "added_at" }, "active_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item become active", "format": "date-time", "example": "2024-01-10T09:00:00Z", "x-discordVariable": "active_at" }, "expires_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item expires", "format": "date-time", "example": "2024-12-31T23:59:59Z", "x-discordVariable": "expires_at" }, "removed_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item was removed from the customers inventory", "format": "date-time", "example": "2024-02-01T10:00:00Z", "x-discordVariable": "removed_at" }, "revoked_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item was revoked from the customers inventory", "format": "date-time", "example": "2024-02-05T14:30:00Z", "x-discordVariable": "revoked_at" }, "revoke_reason": { "type": [ "null", "string" ], "description": "Indicates the reason the delivery item was revoked from the customers inventory", "x-discordVariable": "revoke_reason" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_DELIVERY_ITEM_ACTIVATED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a delivery item in the customers inventory activates", "description": "Webhook for ON_DELIVERY_ITEM_ACTIVATED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_DELIVERY_ITEM_ACTIVATED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "product_id", "product_version_id", "product", "state", "added_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer": { "oneOf": [ { "$ref": "#/components/schemas/CustomerDTO" }, { "type": "null" } ], "x-discordVariable": "customer" }, "order_customer_id": { "type": [ "null", "string" ], "description": "The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_customer_id" }, "checkout_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Checkout associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "order_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Order ID associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_id" }, "order_line_id": { "type": [ "null", "string" ], "description": "The Flake Id of the Order Line ID associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_line_id" }, "subscription_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Subscription associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "subscription_id" }, "execute_on_gameserver_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Game Server the Delivery Item is associated with", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "execute_on_gameserver_id" }, "execute_on_gameserver": { "oneOf": [ { "$ref": "#/components/schemas/GameServerDTO" }, { "type": "null" } ], "x-discordVariable": "execute_on_gameserver" }, "product_id": { "type": "string", "description": "The associated Product ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The associated Product Version ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "state": { "type": "string", "description": "The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed", "example": "usable", "x-discordVariable": "state" }, "added_at": { "type": "string", "description": "Indicates when the Delivery Item was added to the customers inventory", "format": "date-time", "example": "2024-01-10T08:00:00Z", "x-discordVariable": "added_at" }, "active_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item become active", "format": "date-time", "example": "2024-01-10T09:00:00Z", "x-discordVariable": "active_at" }, "expires_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item expires", "format": "date-time", "example": "2024-12-31T23:59:59Z", "x-discordVariable": "expires_at" }, "removed_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item was removed from the customers inventory", "format": "date-time", "example": "2024-02-01T10:00:00Z", "x-discordVariable": "removed_at" }, "revoked_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item was revoked from the customers inventory", "format": "date-time", "example": "2024-02-05T14:30:00Z", "x-discordVariable": "revoked_at" }, "revoke_reason": { "type": [ "null", "string" ], "description": "Indicates the reason the delivery item was revoked from the customers inventory", "x-discordVariable": "revoke_reason" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_DELIVERY_ITEM_USED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a delivery item in the customers inventory becomes used", "description": "Webhook for ON_DELIVERY_ITEM_USED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_DELIVERY_ITEM_USED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "product_id", "product_version_id", "product", "state", "added_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer": { "oneOf": [ { "$ref": "#/components/schemas/CustomerDTO" }, { "type": "null" } ], "x-discordVariable": "customer" }, "order_customer_id": { "type": [ "null", "string" ], "description": "The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_customer_id" }, "checkout_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Checkout associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "order_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Order ID associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_id" }, "order_line_id": { "type": [ "null", "string" ], "description": "The Flake Id of the Order Line ID associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_line_id" }, "subscription_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Subscription associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "subscription_id" }, "execute_on_gameserver_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Game Server the Delivery Item is associated with", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "execute_on_gameserver_id" }, "execute_on_gameserver": { "oneOf": [ { "$ref": "#/components/schemas/GameServerDTO" }, { "type": "null" } ], "x-discordVariable": "execute_on_gameserver" }, "product_id": { "type": "string", "description": "The associated Product ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The associated Product Version ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "state": { "type": "string", "description": "The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed", "example": "usable", "x-discordVariable": "state" }, "added_at": { "type": "string", "description": "Indicates when the Delivery Item was added to the customers inventory", "format": "date-time", "example": "2024-01-10T08:00:00Z", "x-discordVariable": "added_at" }, "active_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item become active", "format": "date-time", "example": "2024-01-10T09:00:00Z", "x-discordVariable": "active_at" }, "expires_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item expires", "format": "date-time", "example": "2024-12-31T23:59:59Z", "x-discordVariable": "expires_at" }, "removed_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item was removed from the customers inventory", "format": "date-time", "example": "2024-02-01T10:00:00Z", "x-discordVariable": "removed_at" }, "revoked_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item was revoked from the customers inventory", "format": "date-time", "example": "2024-02-05T14:30:00Z", "x-discordVariable": "revoked_at" }, "revoke_reason": { "type": [ "null", "string" ], "description": "Indicates the reason the delivery item was revoked from the customers inventory", "x-discordVariable": "revoke_reason" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } }, "deprecated": true } }, "ON_DELIVERY_ITEM_RENEWED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a delivery item in the customers inventory is renewed", "description": "Webhook for ON_DELIVERY_ITEM_RENEWED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_DELIVERY_ITEM_RENEWED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "product_id", "product_version_id", "product", "state", "added_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer": { "oneOf": [ { "$ref": "#/components/schemas/CustomerDTO" }, { "type": "null" } ], "x-discordVariable": "customer" }, "order_customer_id": { "type": [ "null", "string" ], "description": "The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_customer_id" }, "checkout_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Checkout associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "order_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Order ID associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_id" }, "order_line_id": { "type": [ "null", "string" ], "description": "The Flake Id of the Order Line ID associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_line_id" }, "subscription_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Subscription associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "subscription_id" }, "execute_on_gameserver_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Game Server the Delivery Item is associated with", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "execute_on_gameserver_id" }, "execute_on_gameserver": { "oneOf": [ { "$ref": "#/components/schemas/GameServerDTO" }, { "type": "null" } ], "x-discordVariable": "execute_on_gameserver" }, "product_id": { "type": "string", "description": "The associated Product ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The associated Product Version ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "state": { "type": "string", "description": "The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed", "example": "usable", "x-discordVariable": "state" }, "added_at": { "type": "string", "description": "Indicates when the Delivery Item was added to the customers inventory", "format": "date-time", "example": "2024-01-10T08:00:00Z", "x-discordVariable": "added_at" }, "active_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item become active", "format": "date-time", "example": "2024-01-10T09:00:00Z", "x-discordVariable": "active_at" }, "expires_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item expires", "format": "date-time", "example": "2024-12-31T23:59:59Z", "x-discordVariable": "expires_at" }, "removed_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item was removed from the customers inventory", "format": "date-time", "example": "2024-02-01T10:00:00Z", "x-discordVariable": "removed_at" }, "revoked_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item was revoked from the customers inventory", "format": "date-time", "example": "2024-02-05T14:30:00Z", "x-discordVariable": "revoked_at" }, "revoke_reason": { "type": [ "null", "string" ], "description": "Indicates the reason the delivery item was revoked from the customers inventory", "x-discordVariable": "revoke_reason" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_DELIVERY_ITEM_EXPIRED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a delivery item in the customers inventory expires", "description": "Webhook for ON_DELIVERY_ITEM_EXPIRED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_DELIVERY_ITEM_EXPIRED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "product_id", "product_version_id", "product", "state", "added_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer": { "oneOf": [ { "$ref": "#/components/schemas/CustomerDTO" }, { "type": "null" } ], "x-discordVariable": "customer" }, "order_customer_id": { "type": [ "null", "string" ], "description": "The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_customer_id" }, "checkout_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Checkout associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "order_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Order ID associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_id" }, "order_line_id": { "type": [ "null", "string" ], "description": "The Flake Id of the Order Line ID associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_line_id" }, "subscription_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Subscription associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "subscription_id" }, "execute_on_gameserver_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Game Server the Delivery Item is associated with", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "execute_on_gameserver_id" }, "execute_on_gameserver": { "oneOf": [ { "$ref": "#/components/schemas/GameServerDTO" }, { "type": "null" } ], "x-discordVariable": "execute_on_gameserver" }, "product_id": { "type": "string", "description": "The associated Product ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The associated Product Version ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "state": { "type": "string", "description": "The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed", "example": "usable", "x-discordVariable": "state" }, "added_at": { "type": "string", "description": "Indicates when the Delivery Item was added to the customers inventory", "format": "date-time", "example": "2024-01-10T08:00:00Z", "x-discordVariable": "added_at" }, "active_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item become active", "format": "date-time", "example": "2024-01-10T09:00:00Z", "x-discordVariable": "active_at" }, "expires_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item expires", "format": "date-time", "example": "2024-12-31T23:59:59Z", "x-discordVariable": "expires_at" }, "removed_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item was removed from the customers inventory", "format": "date-time", "example": "2024-02-01T10:00:00Z", "x-discordVariable": "removed_at" }, "revoked_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item was revoked from the customers inventory", "format": "date-time", "example": "2024-02-05T14:30:00Z", "x-discordVariable": "revoked_at" }, "revoke_reason": { "type": [ "null", "string" ], "description": "Indicates the reason the delivery item was revoked from the customers inventory", "x-discordVariable": "revoke_reason" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_DELIVERY_ITEM_REVOKED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a delivery item is revoked from the customers inventory", "description": "Webhook for ON_DELIVERY_ITEM_REVOKED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_DELIVERY_ITEM_REVOKED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "product_id", "product_version_id", "product", "state", "added_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer": { "oneOf": [ { "$ref": "#/components/schemas/CustomerDTO" }, { "type": "null" } ], "x-discordVariable": "customer" }, "order_customer_id": { "type": [ "null", "string" ], "description": "The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_customer_id" }, "checkout_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Checkout associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "order_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Order ID associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_id" }, "order_line_id": { "type": [ "null", "string" ], "description": "The Flake Id of the Order Line ID associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_line_id" }, "subscription_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Subscription associated with the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "subscription_id" }, "execute_on_gameserver_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Game Server the Delivery Item is associated with", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "execute_on_gameserver_id" }, "execute_on_gameserver": { "oneOf": [ { "$ref": "#/components/schemas/GameServerDTO" }, { "type": "null" } ], "x-discordVariable": "execute_on_gameserver" }, "product_id": { "type": "string", "description": "The associated Product ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The associated Product Version ID of the Delivery Item", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "state": { "type": "string", "description": "The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed", "example": "usable", "x-discordVariable": "state" }, "added_at": { "type": "string", "description": "Indicates when the Delivery Item was added to the customers inventory", "format": "date-time", "example": "2024-01-10T08:00:00Z", "x-discordVariable": "added_at" }, "active_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item become active", "format": "date-time", "example": "2024-01-10T09:00:00Z", "x-discordVariable": "active_at" }, "expires_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item expires", "format": "date-time", "example": "2024-12-31T23:59:59Z", "x-discordVariable": "expires_at" }, "removed_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item was removed from the customers inventory", "format": "date-time", "example": "2024-02-01T10:00:00Z", "x-discordVariable": "removed_at" }, "revoked_at": { "type": [ "null", "string" ], "description": "Indicates when the Delivery Item was revoked from the customers inventory", "format": "date-time", "example": "2024-02-05T14:30:00Z", "x-discordVariable": "revoked_at" }, "revoke_reason": { "type": [ "null", "string" ], "description": "Indicates the reason the delivery item was revoked from the customers inventory", "x-discordVariable": "revoke_reason" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_ORDER_COMPLETED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when an order is completed", "description": "Webhook for ON_ORDER_COMPLETED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_ORDER_COMPLETED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "customer", "checkout_id", "checkout", "applied_coupons", "applied_giftcards", "coupon_id", "type", "currency", "tax_inclusive", "tax_amount", "discount_amount", "subtotal_amount", "total_amount", "created_at", "completed_at", "billing_name", "billing_email", "billing_address_country", "customer_ip", "giftcard_usage_amount", "lines", "product_names", "product_tags", "product_gameservers", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Order", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the store associated with the order", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer": { "$ref": "#/components/schemas/CustomerDTO" }, "checkout_id": { "type": "string", "description": "The Flake ID of the Checkout associated with the order", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "checkout": { "$ref": "#/components/schemas/CheckoutDTO" }, "subscription_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Subscription associated with the order", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "subscription_id" }, "applied_coupons": { "type": "array", "items": { "$ref": "#/components/schemas/OrderCouponUsageDTO" }, "description": "Applied coupons to this order", "x-discordVariable": "applied_coupons" }, "applied_giftcards": { "type": "array", "items": { "$ref": "#/components/schemas/OrderGiftCardUsageDTO" }, "description": "Applied gift cards to this order", "x-discordVariable": "applied_giftcards" }, "coupon_id": { "type": "string", "description": "The Flake ID of the Coupon associated with the order", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "coupon_id" }, "type": { "type": "string", "description": "The type of the order", "example": "one_time", "x-discordVariable": "type" }, "currency": { "type": "string", "description": "The ISO-4217 Currency Code of the order", "example": "USD", "x-discordVariable": "currency" }, "tax_inclusive": { "type": "boolean", "description": "Indicates if the order value was inclusive of tax", "example": true, "x-discordVariable": "tax_inclusive" }, "tax_amount": { "type": "integer", "description": "The tax amount, represented as cents", "example": 1500, "x-discordVariable": "tax_amount" }, "discount_amount": { "type": "integer", "description": "The discount amount, represented as cents", "example": 500, "x-discordVariable": "discount_amount" }, "subtotal_amount": { "type": "integer", "description": "The subtotal amount, represented as cents", "example": 10000, "x-discordVariable": "subtotal_amount" }, "total_amount": { "type": "integer", "description": "The total amount, represented as cents", "example": 11000, "x-discordVariable": "total_amount" }, "created_at": { "type": "string", "description": "Indicates when the order was created", "format": "date-time", "example": "2024-01-15T10:30:00Z", "x-discordVariable": "created_at" }, "completed_at": { "type": "string", "description": "Indicates when the order was completed", "format": "date-time", "example": "2024-01-15T10:35:00Z", "x-discordVariable": "completed_at" }, "billing_name": { "type": "string", "description": "The billing name of the customer associated with the order", "example": "John Doe", "x-discordVariable": "billing_name" }, "billing_email": { "type": "string", "description": "The billing email address of the customer associated with the order", "example": "john@doe.com", "x-discordVariable": "billing_email" }, "billing_address_country": { "type": "string", "description": "The ISO-3316 Country Code of the customer associated with the order", "example": "US", "x-discordVariable": "billing_address_country" }, "customer_ip": { "type": "string", "description": "The IPv4 or IPv6 Address of the associated customer when creating the order", "example": "127.0.0.1/24", "x-discordVariable": "customer_ip" }, "giftcard_usage_amount": { "type": "integer", "description": "The total amount of giftcard usage associated with the order, represented in cents", "example": 0, "x-discordVariable": "giftcard_usage_amount" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineDTO" }, "description": "The order lines associated with the order", "x-discordVariable": "lines" }, "product_names": { "type": "string", "description": "A comma-seperated string of the names of the product associated with the order", "example": "Product A, Product B", "x-discordVariable": "product_names" }, "product_tags": { "type": "string", "description": "A comma-seperated string of the tags of the products associated with the order", "example": "ranks, perks", "x-discordVariable": "product_tags" }, "product_gameservers": { "type": "string", "description": "A comma-seperated string of the gameservers of the product associated with the order", "example": "game server one, game server two", "x-discordVariable": "product_gameservers" }, "status": { "type": "string", "description": "The status of the Order. Possbile options: created, completed, canceled", "example": "created", "x-discordVariable": "status" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_PAYMENT_COMPLETED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a payment is completed", "description": "Webhook for ON_PAYMENT_COMPLETED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_PAYMENT_COMPLETED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "order_id", "gateway", "currency", "tax_inclusive", "amount", "gateway_fee_amount", "tax_amount", "platform_fee_amount", "store_net_amount", "status", "created_at", "completed_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Payment", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Payment", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "order_id": { "type": "string", "description": "The Flake ID of the Order associated with the Payment", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_id" }, "customer": { "oneOf": [ { "$ref": "#/components/schemas/CustomerDTO" }, { "type": "null" } ], "x-discordVariable": "customer" }, "gateway": { "type": "string", "description": "The Payment Gateway of the Payment", "example": "stripe", "x-discordVariable": "gateway" }, "currency": { "type": "string", "description": "The ISO-4217 Currency Code of the Payment", "example": "USD", "x-discordVariable": "currency" }, "tax_inclusive": { "type": "boolean", "description": "Indicates if the payment was Tax Inclusive", "example": true, "x-discordVariable": "tax_inclusive" }, "amount": { "type": "integer", "description": "The payment amount, represented in cents", "example": 7500, "x-discordVariable": "amount" }, "gateway_fee_amount": { "type": "integer", "description": "The gateway fee amount, represented in cents", "example": 200, "x-discordVariable": "gateway_fee_amount" }, "tax_amount": { "type": "integer", "description": "The tax amount, represented in cents", "example": 1200, "x-discordVariable": "tax_amount" }, "platform_fee_amount": { "type": "integer", "description": "The platform fee amount, represented in cents", "example": 375, "x-discordVariable": "platform_fee_amount" }, "store_net_amount": { "type": "integer", "description": "The net amount recieved by the associated store, represented in cents", "example": 5925, "x-discordVariable": "store_net_amount" }, "status": { "type": "string", "description": "The status of the payment", "example": "completed", "x-discordVariable": "status" }, "billing_country": { "type": [ "null", "string" ], "description": "The ISO-3166 country code the payment was billed to", "example": "US", "x-discordVariable": "billing_country" }, "created_at": { "type": "string", "description": "Indicates when the payment was created", "format": "date-time", "example": "2024-01-20T12:00:00Z", "x-discordVariable": "created_at" }, "pending_at": { "type": [ "null", "string" ], "description": "Indicates when the payment became pending", "format": "date-time", "example": "2024-01-20T12:15:00Z", "x-discordVariable": "pending_at" }, "completed_at": { "type": "string", "description": "Indicates when the payment was completed", "format": "date-time", "example": "2024-01-20T13:00:00Z", "x-discordVariable": "completed_at" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_PAYMENT_FAILED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a payment fails", "description": "Webhook for ON_PAYMENT_FAILED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_PAYMENT_FAILED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "order_id", "gateway", "currency", "tax_inclusive", "amount", "gateway_fee_amount", "tax_amount", "platform_fee_amount", "store_net_amount", "status", "failure_code", "created_at", "failed_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Payment", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Payment", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "order_id": { "type": "string", "description": "The Flake ID of the Order associated with the Payment", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_id" }, "customer": { "oneOf": [ { "$ref": "#/components/schemas/CustomerDTO" }, { "type": "null" } ], "x-discordVariable": "customer" }, "gateway": { "type": "string", "description": "The Payment Gateway of the Payment", "example": "stripe", "x-discordVariable": "gateway" }, "currency": { "type": "string", "description": "The ISO-4217 Currency Code of the Payment", "example": "USD", "x-discordVariable": "currency" }, "tax_inclusive": { "type": "boolean", "description": "Indicates if the payment was Tax Inclusive", "example": true, "x-discordVariable": "tax_inclusive" }, "amount": { "type": "integer", "description": "The payment amount, represented in cents", "example": 7500, "x-discordVariable": "amount" }, "gateway_fee_amount": { "type": "integer", "description": "The gateway fee amount, represented in cents", "example": 200, "x-discordVariable": "gateway_fee_amount" }, "tax_amount": { "type": "integer", "description": "The tax amount, represented in cents", "example": 1200, "x-discordVariable": "tax_amount" }, "platform_fee_amount": { "type": "integer", "description": "The platform fee amount, represented in cents", "example": 375, "x-discordVariable": "platform_fee_amount" }, "store_net_amount": { "type": "integer", "description": "The net amount that would have been recieved by the associated store, represented in cents", "example": 5925, "x-discordVariable": "store_net_amount" }, "status": { "type": "string", "description": "The status of the payment", "example": "failed", "x-discordVariable": "status" }, "failure_code": { "type": "string", "description": "The reason the payment was declined", "example": "insufficient_funds", "x-discordVariable": "failure_code" }, "created_at": { "type": "string", "description": "Indicates when the payment was created", "format": "date-time", "example": "2024-01-20T12:00:00Z", "x-discordVariable": "created_at" }, "pending_at": { "type": [ "null", "string" ], "description": "Indicates when the payment became pending", "format": "date-time", "example": "2024-01-20T12:15:00Z", "x-discordVariable": "pending_at" }, "failed_at": { "type": "string", "description": "Indicates when the payment failed", "format": "date-time", "example": "2024-01-20T12:30:00Z", "x-discordVariable": "failed_at" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_REFUND": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a refund is completed", "description": "Webhook for ON_REFUND", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_REFUND" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "order_id", "payment_id", "gateway", "currency", "tax_inclusive", "amount", "gateway_fee_amount", "tax_amount", "platform_fee_amount", "store_net_amount", "store_refund_amount", "created_at", "approved_at", "pending_at", "completed_at", "billing_email", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Refund", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the store associated with the Refund", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "order_id": { "type": "string", "description": "The Flake ID of Order associated with the refund", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "order_id" }, "customer": { "oneOf": [ { "$ref": "#/components/schemas/CustomerDTO" }, { "type": "null" } ], "x-discordVariable": "customer" }, "payment_id": { "type": "string", "description": "The Flake ID of the Payment associated with the refund", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "payment_id" }, "gateway": { "type": "string", "description": "The Payment Gateway associated with the refund", "x-discordVariable": "gateway" }, "currency": { "type": "string", "description": "The ISO-4217 Currency Code of the Payment", "example": "USD", "x-discordVariable": "currency" }, "tax_inclusive": { "type": "boolean", "description": "Indicates if taxes were inclusive in the associated payment", "example": false, "x-discordVariable": "tax_inclusive" }, "amount": { "type": "integer", "description": "The initial payment amount, represented in cents", "example": 5000, "x-discordVariable": "amount" }, "gateway_fee_amount": { "type": "integer", "description": "The initial gateway fee amount, represented in cents", "example": 150, "x-discordVariable": "gateway_fee_amount" }, "tax_amount": { "type": "integer", "description": "The initial tax amount, represented in cents", "example": 800, "x-discordVariable": "tax_amount" }, "platform_fee_amount": { "type": "integer", "description": "The initial platform fee amount, represented in cents", "example": 250, "x-discordVariable": "platform_fee_amount" }, "store_net_amount": { "type": "integer", "description": "The initial store net amount, represented in cents", "example": 3800, "x-discordVariable": "store_net_amount" }, "store_refund_amount": { "type": "integer", "description": "The amount refunded to the store, represented in cents", "example": 5000, "x-discordVariable": "store_refund_amount" }, "created_at": { "type": "string", "description": "Indicates when the refund was created", "format": "date-time", "example": "2024-01-20T12:00:00Z", "x-discordVariable": "created_at" }, "approved_at": { "type": "string", "description": "Indicates when the refund was approved", "format": "date-time", "example": "2024-01-20T12:30:00Z", "x-discordVariable": "approved_at" }, "pending_at": { "type": "string", "description": "Indicates when the refund was pending", "format": "date-time", "example": "2024-01-20T12:15:00Z", "x-discordVariable": "pending_at" }, "completed_at": { "type": "string", "description": "Indicates when the refund was completed", "format": "date-time", "example": "2024-01-20T13:00:00Z", "x-discordVariable": "completed_at" }, "billing_email": { "type": "string", "description": "The email address of the intial payment customer", "example": "john@doe.com", "x-discordVariable": "billing_email" }, "status": { "type": "string", "description": "The status of the refund. Possible options: created, approved, processing, completed, canceled, failed", "example": "created", "x-discordVariable": "status" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_SUBSCRIPTION_ACTIVATED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a subscription is activated", "description": "Webhook for ON_SUBSCRIPTION_ACTIVATED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_SUBSCRIPTION_ACTIVATED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "customer_id", "customer", "checkout", "billing_cycle_sequence", "billing_email", "subtotal_amount", "tax_amount", "discount_amount", "total_amount", "currency", "interval_value", "interval_scale", "product_id", "product_version_id", "product_name", "product", "billing_country", "initial_subtotal_amount", "initial_tax_amount", "initial_discount_amount", "initial_giftcard_usage_amount", "initial_total_amount", "customer_ip", "checkout_id", "checkout_line_id", "status", "lines" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer_id": { "type": "string", "description": "The Flake ID of the Customer associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "customer_id" }, "customer": { "$ref": "#/components/schemas/CustomerDTO" }, "checkout": { "$ref": "#/components/schemas/CheckoutDTO" }, "billing_cycle_sequence": { "type": "integer", "description": "The current billing cycle number", "example": 1, "x-discordVariable": "billing_cycle_sequence" }, "billing_email": { "type": "string", "description": "The billing email address of the customer associated with the Subscription", "example": "john@doe.com", "x-discordVariable": "billing_email" }, "subtotal_amount": { "type": "integer", "description": "The subtotal amount of the Subscription represented in cents", "example": 9999, "x-discordVariable": "subtotal_amount" }, "tax_amount": { "type": "integer", "description": "The tax amount of the Subscription represented in cents", "example": 1500, "x-discordVariable": "tax_amount" }, "discount_amount": { "type": "integer", "description": "The discount amount applied to the Subscription represented in cents", "example": 1000, "x-discordVariable": "discount_amount" }, "total_amount": { "type": "integer", "description": "The total amount of the Subscription represented in cents", "example": 10499, "x-discordVariable": "total_amount" }, "currency": { "type": "string", "description": "The currency code of the Subscription", "example": "USD", "x-discordVariable": "currency" }, "interval_value": { "type": "integer", "description": "The interval value of the billing cycle", "example": 1, "x-discordVariable": "interval_value" }, "interval_scale": { "type": "string", "description": "The interval scale of the billing cycle", "example": "month", "x-discordVariable": "interval_scale" }, "product_id": { "type": "string", "description": "The Flake ID of the Product associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The Flake ID of the Product Version associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product_name": { "type": "string", "description": "The name of the Product associated with the Subscription", "example": "Example Product", "x-discordVariable": "product_name" }, "product_image_url": { "type": [ "null", "string" ], "description": "The image URL of the Product associated with the Subscription", "example": "https://example.com/image.jpg", "x-discordVariable": "product_image_url" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "billing_country": { "type": "string", "description": "The ISO-3166 Country Code of the customer associated with the Subscription", "example": "US", "x-discordVariable": "billing_country" }, "initial_subtotal_amount": { "type": "integer", "description": "The initial subtotal amount of the Subscription represented in cents", "example": 9999, "x-discordVariable": "initial_subtotal_amount" }, "initial_tax_amount": { "type": "integer", "description": "The initial tax amount of the Subscription represented in cents", "example": 1500, "x-discordVariable": "initial_tax_amount" }, "initial_discount_amount": { "type": "integer", "description": "The initial discount amount applied to the Subscription represented in cents", "example": 2000, "x-discordVariable": "initial_discount_amount" }, "initial_giftcard_usage_amount": { "type": "integer", "description": "The initial gift card usage amount applied to the Subscription represented in cents", "example": 0, "x-discordVariable": "initial_giftcard_usage_amount" }, "initial_total_amount": { "type": "integer", "description": "The initial total amount of the Subscription represented in cents", "example": 9499, "x-discordVariable": "initial_total_amount" }, "customer_ip": { "type": "string", "description": "The IP address of the Customer", "example": "127.0.0.1/24", "x-discordVariable": "customer_ip" }, "current_period_start": { "type": [ "null", "string" ], "description": "The start date of the current billing period", "format": "date-time", "example": "2024-02-01T00:00:00Z", "x-discordVariable": "current_period_start" }, "current_period_end": { "type": [ "null", "string" ], "description": "The end date of the current billing period", "format": "date-time", "example": "2024-03-01T00:00:00Z", "x-discordVariable": "current_period_end" }, "created_at": { "type": [ "null", "string" ], "description": "The date and time when the Subscription was created", "format": "date-time", "example": "2024-02-01T10:15:00Z", "x-discordVariable": "created_at" }, "active_at": { "type": [ "null", "string" ], "description": "Indicates when the subscription was active", "format": "date-time", "example": "2024-02-01T10:20:00Z", "x-discordVariable": "active_at" }, "checkout_id": { "type": "string", "description": "The Flake ID of the Checkout associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "checkout_line_id": { "type": "string", "description": "The Flake ID of the Checkout Line associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_line_id" }, "status": { "type": "string", "description": "The current status of the Subscription. Possible options: created, active, canceled", "example": "created", "x-discordVariable": "status" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionLineDTO" }, "description": "The lines of the Subscription", "x-discordVariable": "lines" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_SUBSCRIPTION_CANCELED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a subscription is canceled", "description": "Webhook for ON_SUBSCRIPTION_CANCELED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_SUBSCRIPTION_CANCELED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "customer_id", "customer", "checkout", "billing_cycle_sequence", "billing_email", "subtotal_amount", "tax_amount", "discount_amount", "total_amount", "currency", "interval_value", "interval_scale", "product_id", "product_version_id", "product_name", "product", "billing_country", "initial_subtotal_amount", "initial_tax_amount", "initial_discount_amount", "initial_giftcard_usage_amount", "initial_total_amount", "customer_ip", "checkout_id", "checkout_line_id", "status", "lines" ], "type": "object", "properties": { "canceled_at": { "type": [ "null", "string" ], "description": "Indicates when the subscription was canceled", "format": "date-time", "example": "2024-05-15T14:20:00Z", "x-discordVariable": "canceled_at" }, "cancel_reason": { "type": [ "null", "string" ], "description": "The reason for the subscription cancellation", "example": "customer_request", "x-discordVariable": "cancel_reason" }, "id": { "type": "string", "description": "The Flake ID of the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer_id": { "type": "string", "description": "The Flake ID of the Customer associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "customer_id" }, "customer": { "$ref": "#/components/schemas/CustomerDTO" }, "checkout": { "$ref": "#/components/schemas/CheckoutDTO" }, "billing_cycle_sequence": { "type": "integer", "description": "The current billing cycle number", "example": 1, "x-discordVariable": "billing_cycle_sequence" }, "billing_email": { "type": "string", "description": "The billing email address of the customer associated with the Subscription", "example": "john@doe.com", "x-discordVariable": "billing_email" }, "subtotal_amount": { "type": "integer", "description": "The subtotal amount of the Subscription represented in cents", "example": 9999, "x-discordVariable": "subtotal_amount" }, "tax_amount": { "type": "integer", "description": "The tax amount of the Subscription represented in cents", "example": 1500, "x-discordVariable": "tax_amount" }, "discount_amount": { "type": "integer", "description": "The discount amount applied to the Subscription represented in cents", "example": 1000, "x-discordVariable": "discount_amount" }, "total_amount": { "type": "integer", "description": "The total amount of the Subscription represented in cents", "example": 10499, "x-discordVariable": "total_amount" }, "currency": { "type": "string", "description": "The currency code of the Subscription", "example": "USD", "x-discordVariable": "currency" }, "interval_value": { "type": "integer", "description": "The interval value of the billing cycle", "example": 1, "x-discordVariable": "interval_value" }, "interval_scale": { "type": "string", "description": "The interval scale of the billing cycle", "example": "month", "x-discordVariable": "interval_scale" }, "product_id": { "type": "string", "description": "The Flake ID of the Product associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The Flake ID of the Product Version associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product_name": { "type": "string", "description": "The name of the Product associated with the Subscription", "example": "Example Product", "x-discordVariable": "product_name" }, "product_image_url": { "type": [ "null", "string" ], "description": "The image URL of the Product associated with the Subscription", "example": "https://example.com/image.jpg", "x-discordVariable": "product_image_url" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "billing_country": { "type": "string", "description": "The ISO-3166 Country Code of the customer associated with the Subscription", "example": "US", "x-discordVariable": "billing_country" }, "initial_subtotal_amount": { "type": "integer", "description": "The initial subtotal amount of the Subscription represented in cents", "example": 9999, "x-discordVariable": "initial_subtotal_amount" }, "initial_tax_amount": { "type": "integer", "description": "The initial tax amount of the Subscription represented in cents", "example": 1500, "x-discordVariable": "initial_tax_amount" }, "initial_discount_amount": { "type": "integer", "description": "The initial discount amount applied to the Subscription represented in cents", "example": 2000, "x-discordVariable": "initial_discount_amount" }, "initial_giftcard_usage_amount": { "type": "integer", "description": "The initial gift card usage amount applied to the Subscription represented in cents", "example": 0, "x-discordVariable": "initial_giftcard_usage_amount" }, "initial_total_amount": { "type": "integer", "description": "The initial total amount of the Subscription represented in cents", "example": 9499, "x-discordVariable": "initial_total_amount" }, "customer_ip": { "type": "string", "description": "The IP address of the Customer", "example": "127.0.0.1/24", "x-discordVariable": "customer_ip" }, "current_period_start": { "type": [ "null", "string" ], "description": "The start date of the current billing period", "format": "date-time", "example": "2024-02-01T00:00:00Z", "x-discordVariable": "current_period_start" }, "current_period_end": { "type": [ "null", "string" ], "description": "The end date of the current billing period", "format": "date-time", "example": "2024-03-01T00:00:00Z", "x-discordVariable": "current_period_end" }, "created_at": { "type": [ "null", "string" ], "description": "The date and time when the Subscription was created", "format": "date-time", "example": "2024-02-01T10:15:00Z", "x-discordVariable": "created_at" }, "active_at": { "type": [ "null", "string" ], "description": "Indicates when the subscription was active", "format": "date-time", "example": "2024-02-01T10:20:00Z", "x-discordVariable": "active_at" }, "checkout_id": { "type": "string", "description": "The Flake ID of the Checkout associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "checkout_line_id": { "type": "string", "description": "The Flake ID of the Checkout Line associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_line_id" }, "status": { "type": "string", "description": "The current status of the Subscription. Possible options: created, active, canceled", "example": "created", "x-discordVariable": "status" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionLineDTO" }, "description": "The lines of the Subscription", "x-discordVariable": "lines" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_SUBSCRIPTION_RENEWED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a subscription is renewed", "description": "Webhook for ON_SUBSCRIPTION_RENEWED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_SUBSCRIPTION_RENEWED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "customer_id", "customer", "checkout", "billing_cycle_sequence", "billing_email", "subtotal_amount", "tax_amount", "discount_amount", "total_amount", "currency", "interval_value", "interval_scale", "product_id", "product_version_id", "product_name", "product", "billing_country", "initial_subtotal_amount", "initial_tax_amount", "initial_discount_amount", "initial_giftcard_usage_amount", "initial_total_amount", "customer_ip", "checkout_id", "checkout_line_id", "status", "lines" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer_id": { "type": "string", "description": "The Flake ID of the Customer associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "customer_id" }, "customer": { "$ref": "#/components/schemas/CustomerDTO" }, "checkout": { "$ref": "#/components/schemas/CheckoutDTO" }, "billing_cycle_sequence": { "type": "integer", "description": "The current billing cycle number", "example": 1, "x-discordVariable": "billing_cycle_sequence" }, "billing_email": { "type": "string", "description": "The billing email address of the customer associated with the Subscription", "example": "john@doe.com", "x-discordVariable": "billing_email" }, "subtotal_amount": { "type": "integer", "description": "The subtotal amount of the Subscription represented in cents", "example": 9999, "x-discordVariable": "subtotal_amount" }, "tax_amount": { "type": "integer", "description": "The tax amount of the Subscription represented in cents", "example": 1500, "x-discordVariable": "tax_amount" }, "discount_amount": { "type": "integer", "description": "The discount amount applied to the Subscription represented in cents", "example": 1000, "x-discordVariable": "discount_amount" }, "total_amount": { "type": "integer", "description": "The total amount of the Subscription represented in cents", "example": 10499, "x-discordVariable": "total_amount" }, "currency": { "type": "string", "description": "The currency code of the Subscription", "example": "USD", "x-discordVariable": "currency" }, "interval_value": { "type": "integer", "description": "The interval value of the billing cycle", "example": 1, "x-discordVariable": "interval_value" }, "interval_scale": { "type": "string", "description": "The interval scale of the billing cycle", "example": "month", "x-discordVariable": "interval_scale" }, "product_id": { "type": "string", "description": "The Flake ID of the Product associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The Flake ID of the Product Version associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product_name": { "type": "string", "description": "The name of the Product associated with the Subscription", "example": "Example Product", "x-discordVariable": "product_name" }, "product_image_url": { "type": [ "null", "string" ], "description": "The image URL of the Product associated with the Subscription", "example": "https://example.com/image.jpg", "x-discordVariable": "product_image_url" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "billing_country": { "type": "string", "description": "The ISO-3166 Country Code of the customer associated with the Subscription", "example": "US", "x-discordVariable": "billing_country" }, "initial_subtotal_amount": { "type": "integer", "description": "The initial subtotal amount of the Subscription represented in cents", "example": 9999, "x-discordVariable": "initial_subtotal_amount" }, "initial_tax_amount": { "type": "integer", "description": "The initial tax amount of the Subscription represented in cents", "example": 1500, "x-discordVariable": "initial_tax_amount" }, "initial_discount_amount": { "type": "integer", "description": "The initial discount amount applied to the Subscription represented in cents", "example": 2000, "x-discordVariable": "initial_discount_amount" }, "initial_giftcard_usage_amount": { "type": "integer", "description": "The initial gift card usage amount applied to the Subscription represented in cents", "example": 0, "x-discordVariable": "initial_giftcard_usage_amount" }, "initial_total_amount": { "type": "integer", "description": "The initial total amount of the Subscription represented in cents", "example": 9499, "x-discordVariable": "initial_total_amount" }, "customer_ip": { "type": "string", "description": "The IP address of the Customer", "example": "127.0.0.1/24", "x-discordVariable": "customer_ip" }, "current_period_start": { "type": [ "null", "string" ], "description": "The start date of the current billing period", "format": "date-time", "example": "2024-02-01T00:00:00Z", "x-discordVariable": "current_period_start" }, "current_period_end": { "type": [ "null", "string" ], "description": "The end date of the current billing period", "format": "date-time", "example": "2024-03-01T00:00:00Z", "x-discordVariable": "current_period_end" }, "created_at": { "type": [ "null", "string" ], "description": "The date and time when the Subscription was created", "format": "date-time", "example": "2024-02-01T10:15:00Z", "x-discordVariable": "created_at" }, "active_at": { "type": [ "null", "string" ], "description": "Indicates when the subscription was active", "format": "date-time", "example": "2024-02-01T10:20:00Z", "x-discordVariable": "active_at" }, "checkout_id": { "type": "string", "description": "The Flake ID of the Checkout associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "checkout_line_id": { "type": "string", "description": "The Flake ID of the Checkout Line associated with the Subscription", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_line_id" }, "status": { "type": "string", "description": "The current status of the Subscription. Possible options: created, active, canceled", "example": "created", "x-discordVariable": "status" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionLineDTO" }, "description": "The lines of the Subscription", "x-discordVariable": "lines" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_TRIAL_ACTIVATED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a trial is activated", "description": "Webhook for ON_TRIAL_ACTIVATED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_TRIAL_ACTIVATED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "customer_id", "customer", "product_id", "product_version_id", "product_name", "period_value", "period_scale", "status", "created_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer_id": { "type": "string", "description": "The Flake ID of the Customer associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "customer_id" }, "customer": { "$ref": "#/components/schemas/CustomerDTO" }, "checkout_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Checkout associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "checkout_line_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Checkout Line associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_line_id" }, "product_id": { "type": "string", "description": "The Flake ID of the Product associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The Flake ID of the Product Version associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product_name": { "type": "string", "description": "The name of the Product associated with the Trial", "example": "Example Product", "x-discordVariable": "product_name" }, "product_image_url": { "type": [ "null", "string" ], "description": "The image URL of the Product associated with the Trial", "example": "https://example.com/image.jpg", "x-discordVariable": "product_image_url" }, "period_value": { "type": "integer", "description": "The period value of the Trial", "example": 1, "x-discordVariable": "period_value" }, "period_scale": { "type": "string", "description": "The period scale of the Trial", "example": "month", "x-discordVariable": "period_scale" }, "starts_at": { "type": [ "null", "string" ], "description": "The start date of the Trial", "format": "date-time", "example": "2024-06-10T00:00:00Z", "x-discordVariable": "starts_at" }, "ends_at": { "type": [ "null", "string" ], "description": "The end date of the Trial", "format": "date-time", "example": "2024-06-17T23:59:59Z", "x-discordVariable": "ends_at" }, "status": { "type": "string", "description": "The current status of the Trial. Possible options: created, active, canceled, completed", "example": "created", "x-discordVariable": "status" }, "created_at": { "type": "string", "description": "The date and time when the Trial was created", "format": "date-time", "example": "2024-06-10T08:30:00Z", "x-discordVariable": "created_at" }, "canceled_at": { "type": [ "null", "string" ], "description": "Indicates when the Trial was canceled", "format": "date-time", "example": "2024-06-15T10:15:00Z", "x-discordVariable": "canceled_at" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_TRIAL_COMPLETED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a trial is completed", "description": "Webhook for ON_TRIAL_COMPLETED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_TRIAL_COMPLETED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "customer_id", "customer", "product_id", "product_version_id", "product_name", "period_value", "period_scale", "status", "created_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer_id": { "type": "string", "description": "The Flake ID of the Customer associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "customer_id" }, "customer": { "$ref": "#/components/schemas/CustomerDTO" }, "checkout_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Checkout associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "checkout_line_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Checkout Line associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_line_id" }, "product_id": { "type": "string", "description": "The Flake ID of the Product associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The Flake ID of the Product Version associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product_name": { "type": "string", "description": "The name of the Product associated with the Trial", "example": "Example Product", "x-discordVariable": "product_name" }, "product_image_url": { "type": [ "null", "string" ], "description": "The image URL of the Product associated with the Trial", "example": "https://example.com/image.jpg", "x-discordVariable": "product_image_url" }, "period_value": { "type": "integer", "description": "The period value of the Trial", "example": 1, "x-discordVariable": "period_value" }, "period_scale": { "type": "string", "description": "The period scale of the Trial", "example": "month", "x-discordVariable": "period_scale" }, "starts_at": { "type": [ "null", "string" ], "description": "The start date of the Trial", "format": "date-time", "example": "2024-06-10T00:00:00Z", "x-discordVariable": "starts_at" }, "ends_at": { "type": [ "null", "string" ], "description": "The end date of the Trial", "format": "date-time", "example": "2024-06-17T23:59:59Z", "x-discordVariable": "ends_at" }, "status": { "type": "string", "description": "The current status of the Trial. Possible options: created, active, canceled, completed", "example": "created", "x-discordVariable": "status" }, "created_at": { "type": "string", "description": "The date and time when the Trial was created", "format": "date-time", "example": "2024-06-10T08:30:00Z", "x-discordVariable": "created_at" }, "canceled_at": { "type": [ "null", "string" ], "description": "Indicates when the Trial was canceled", "format": "date-time", "example": "2024-06-15T10:15:00Z", "x-discordVariable": "canceled_at" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } }, "ON_TRIAL_CANCELED": { "post": { "tags": [ "Webhooks" ], "summary": "Triggered when a trial is canceled", "description": "Webhook for ON_TRIAL_CANCELED", "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_type", "event_id", "body" ], "type": "object", "properties": { "event_type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of webhook event", "example": "ON_TRIAL_CANCELED" }, "event_id": { "type": "string", "description": "The ID of the Webhook Event", "format": "flake-id", "example": "411486491630370816" }, "body": { "required": [ "id", "store_id", "customer_id", "customer", "product_id", "product_version_id", "product_name", "period_value", "period_scale", "status", "created_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Flake ID of the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "id" }, "store_id": { "type": "string", "description": "The Flake ID of the Store associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "store_id" }, "customer_id": { "type": "string", "description": "The Flake ID of the Customer associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "customer_id" }, "customer": { "$ref": "#/components/schemas/CustomerDTO" }, "checkout_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Checkout associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_id" }, "checkout_line_id": { "type": [ "null", "string" ], "description": "The Flake ID of the Checkout Line associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "checkout_line_id" }, "product_id": { "type": "string", "description": "The Flake ID of the Product associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_id" }, "product_version_id": { "type": "string", "description": "The Flake ID of the Product Version associated with the Trial", "format": "flake-id", "example": "411486491630370816", "x-discordVariable": "product_version_id" }, "product_name": { "type": "string", "description": "The name of the Product associated with the Trial", "example": "Example Product", "x-discordVariable": "product_name" }, "product_image_url": { "type": [ "null", "string" ], "description": "The image URL of the Product associated with the Trial", "example": "https://example.com/image.jpg", "x-discordVariable": "product_image_url" }, "period_value": { "type": "integer", "description": "The period value of the Trial", "example": 1, "x-discordVariable": "period_value" }, "period_scale": { "type": "string", "description": "The period scale of the Trial", "example": "month", "x-discordVariable": "period_scale" }, "starts_at": { "type": [ "null", "string" ], "description": "The start date of the Trial", "format": "date-time", "example": "2024-06-10T00:00:00Z", "x-discordVariable": "starts_at" }, "ends_at": { "type": [ "null", "string" ], "description": "The end date of the Trial", "format": "date-time", "example": "2024-06-17T23:59:59Z", "x-discordVariable": "ends_at" }, "status": { "type": "string", "description": "The current status of the Trial. Possible options: created, active, canceled, completed", "example": "created", "x-discordVariable": "status" }, "created_at": { "type": "string", "description": "The date and time when the Trial was created", "format": "date-time", "example": "2024-06-10T08:30:00Z", "x-discordVariable": "created_at" }, "canceled_at": { "type": [ "null", "string" ], "description": "Indicates when the Trial was canceled", "format": "date-time", "example": "2024-06-15T10:15:00Z", "x-discordVariable": "canceled_at" } } } } } } }, "required": true }, "responses": { "200": { "description": "Webhook processed successfully" }, "400": { "description": "Bad request" }, "500": { "description": "Internal server error" } } } } } }