Webhooks

Triggered when a subscription is renewed

Webhook for ON_SUBSCRIPTION_RENEWED

Payload

application/json

event_typeall ofRequired

The type of webhook event

Example: ON_SUBSCRIPTION_RENEWED

string · enumOptional

The type of webhook event

Possible values:

event_idstring · flake-idRequired

The ID of the Webhook Event

Example: 411486491630370816

Responses

200

Webhook processed successfully

400

Bad request

500

Internal server error

Payload

{
  "event_type": "ON_SUBSCRIPTION_RENEWED",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "name": "John",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "text"
      },
      "minecraft": {
        "id": "text",
        "name": "Notch",
        "avatar_url": "text"
      },
      "profile": {
        "id": "text",
        "platform": "text",
        "name": "John",
        "avatar_url": "text"
      }
    },
    "checkout": {
      "id": "411486491630370816",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "lines": [
        {
          "id": "411486491630370816",
          "product_id": "411486491630370816",
          "product_version_id": "411486491630370816",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ]
    },
    "billing_cycle_sequence": 2,
    "billing_email": "[email protected]",
    "subtotal_amount": 8999,
    "tax_amount": 1350,
    "discount_amount": 0,
    "total_amount": 10349,
    "currency": "USD",
    "interval_value": 1,
    "interval_scale": "month",
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product_name": "Example Product",
    "product_image_url": "https://example.com/biz.jpg",
    "product": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "version_id": "411486491630370816",
      "image_url": null,
      "slug": "text",
      "name": "text",
      "description": "text",
      "enabled": true,
      "label": null,
      "sort_order": 1,
      "price": 1,
      "single_game_server_only": true,
      "allow_one_time_purchase": true,
      "allow_subscription": true,
      "subscription_interval_value": 1,
      "subscription_interval_scale": "month",
      "remove_after_enabled": true,
      "remove_after_time_value": 1,
      "remove_after_time_scale": "month",
      "tags": [
        {
          "id": "411486491630370816",
          "slug": "text",
          "name": "text"
        }
      ],
      "tag_names": "text",
      "gameservers": [
        {
          "id": "411486491630370816",
          "name": "text",
          "enabled": true
        }
      ],
      "gameserver_names": "text",
      "commands": [
        {
          "stage": "on_purchase",
          "content": "text",
          "online_only": true
        }
      ],
      "created_at": null,
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "billing_country": "US",
    "initial_subtotal_amount": 8999,
    "initial_tax_amount": 1350,
    "initial_discount_amount": 1500,
    "initial_giftcard_usage_amount": 0,
    "initial_total_amount": 8849,
    "customer_ip": "127.0.0.1/24",
    "current_period_start": "2024-03-01T00:00:00Z",
    "current_period_end": "2024-06-01T00:00:00Z",
    "created_at": "2024-03-01T11:00:00Z",
    "active_at": "2024-03-01T11:05:00Z",
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "status": "created"
  }
}

Triggered when a Discord account is successfully linked to a checkout.

Webhook for ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT

Payload

application/json

event_typeall ofRequired

The type of webhook event

Example: ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT

string · enumOptional

The type of webhook event

Possible values:

event_idstring · flake-idRequired

The ID of the Webhook Event

Example: 411486491630370816

Responses

200

Webhook processed successfully

400

Bad request

500

Internal server error

Payload

{
  "event_type": "ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT",
  "event_id": "411486491630370816",
  "body": {
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "name": "John",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "text"
      },
      "minecraft": {
        "id": "text",
        "name": "Notch",
        "avatar_url": "text"
      },
      "profile": {
        "id": "text",
        "platform": "text",
        "name": "John",
        "avatar_url": "text"
      }
    },
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "customer": {
        "id": "411486491630370816",
        "name": "John",
        "steam": {
          "id": "76561197960287930",
          "name": "John",
          "avatar_url": "text"
        },
        "minecraft": {
          "id": "text",
          "name": "Notch",
          "avatar_url": "text"
        },
        "profile": {
          "id": "text",
          "platform": "text",
          "name": "John",
          "avatar_url": "text"
        }
      },
      "checkout_id": "411486491630370816",
      "checkout": {
        "id": "411486491630370816",
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "lines": [
          {
            "id": "411486491630370816",
            "product_id": "411486491630370816",
            "product_version_id": "411486491630370816",
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        ]
      },
      "subscription_id": "411486491630370816",
      "coupon_id": "411486491630370816",
      "currency": "USD",
      "tax_inclusive": true,
      "tax_amount": 1500,
      "discount_amount": 500,
      "subtotal_amount": 10000,
      "total_amount": 11000,
      "created_at": "2024-01-15T10:30:00Z",
      "completed_at": "2024-01-15T10:35:00Z",
      "billing_name": "John Doe",
      "billing_email": "[email protected]",
      "billing_address_country": "US",
      "customer_ip": "127.0.0.1/24",
      "giftcard_usage_amount": 0,
      "lines": [
        {
          "id": "411486491630370816",
          "checkout_line_id": "411486491630370816",
          "product_id": "411486491630370816",
          "product_version_id": "411486491630370816",
          "product": {
            "id": "411486491630370816",
            "store_id": "411486491630370816",
            "version_id": "411486491630370816",
            "image_url": null,
            "slug": "text",
            "name": "text",
            "description": "text",
            "enabled": true,
            "label": null,
            "sort_order": 1,
            "price": 1,
            "single_game_server_only": true,
            "allow_one_time_purchase": true,
            "allow_subscription": true,
            "subscription_interval_value": 1,
            "subscription_interval_scale": "month",
            "remove_after_enabled": true,
            "remove_after_time_value": 1,
            "remove_after_time_scale": "month",
            "tags": [
              {
                "id": "411486491630370816",
                "slug": "text",
                "name": "text"
              }
            ],
            "tag_names": "text",
            "gameservers": [
              {
                "id": "411486491630370816",
                "name": "text",
                "enabled": true
              }
            ],
            "gameserver_names": "text",
            "commands": [
              {
                "stage": "on_purchase",
                "content": "text",
                "online_only": true
              }
            ],
            "created_at": null,
            "updated_at": null,
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          },
          "product_name": "text",
          "product_image_url": null,
          "subscription_id": "411486491630370816",
          "subscription_interval_value": 1,
          "subscription_interval_scale": "month",
          "trial_id": "411486491630370816",
          "gift_to_customer": {
            "id": "411486491630370816",
            "name": "John",
            "steam": {
              "id": "76561197960287930",
              "name": "John",
              "avatar_url": "text"
            },
            "minecraft": {
              "id": "text",
              "name": "Notch",
              "avatar_url": "text"
            },
            "profile": {
              "id": "text",
              "platform": "text",
              "name": "John",
              "avatar_url": "text"
            }
          },
          "price": 1000,
          "quantity": 1,
          "discount_amount": 0,
          "subtotal_amount": 1000,
          "tax_amount": 100,
          "total_amount": 1100,
          "selected_gameserver_id": "411486491630370816"
        }
      ],
      "product_names": "Product A, Product B",
      "product_tags": "ranks, perks",
      "product_gameservers": "game server one, game server two",
      "status": "created"
    },
    "discord_user_id": "123456789012345678",
    "discord_user_name": "john_doe",
    "discord_user_avatar_hash": "a1b2c3d4e5f6g7h8i9j0",
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "version_id": "411486491630370816",
      "image_url": null,
      "slug": "text",
      "name": "text",
      "description": "text",
      "enabled": true,
      "label": null,
      "sort_order": 1,
      "price": 1,
      "single_game_server_only": true,
      "allow_one_time_purchase": true,
      "allow_subscription": true,
      "subscription_interval_value": 1,
      "subscription_interval_scale": "month",
      "remove_after_enabled": true,
      "remove_after_time_value": 1,
      "remove_after_time_scale": "month",
      "tags": [
        {
          "id": "411486491630370816",
          "slug": "text",
          "name": "text"
        }
      ],
      "tag_names": "text",
      "gameservers": [
        {
          "id": "411486491630370816",
          "name": "text",
          "enabled": true
        }
      ],
      "gameserver_names": "text",
      "commands": [
        {
          "stage": "on_purchase",
          "content": "text",
          "online_only": true
        }
      ],
      "created_at": null,
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "enqueued_at": "2024-01-15T10:30:00Z"
  }
}

Triggered when a delivery item is added to the customers inventory

Webhook for ON_DELIVERY_ITEM_ADDED

Payload

application/json

event_typeall ofRequired

The type of webhook event

Example: ON_DELIVERY_ITEM_ADDED

string · enumOptional

The type of webhook event

Possible values:

event_idstring · flake-idRequired

The ID of the Webhook Event

Example: 411486491630370816

Responses

200

Webhook processed successfully

400

Bad request

500

Internal server error

Payload

{
  "event_type": "ON_DELIVERY_ITEM_ADDED",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "name": "John",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "text"
      },
      "minecraft": {
        "id": "text",
        "name": "Notch",
        "avatar_url": "text"
      },
      "profile": {
        "id": "text",
        "platform": "text",
        "name": "John",
        "avatar_url": "text"
      }
    },
    "order_customer_id": "411486491630370816",
    "checkout_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "execute_on_gameserver": {
      "id": "411486491630370816",
      "name": "John",
      "enabled": true
    },
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "version_id": "411486491630370816",
      "image_url": null,
      "slug": "text",
      "name": "text",
      "description": "text",
      "enabled": true,
      "label": null,
      "sort_order": 1,
      "price": 1,
      "single_game_server_only": true,
      "allow_one_time_purchase": true,
      "allow_subscription": true,
      "subscription_interval_value": 1,
      "subscription_interval_scale": "month",
      "remove_after_enabled": true,
      "remove_after_time_value": 1,
      "remove_after_time_scale": "month",
      "tags": [
        {
          "id": "411486491630370816",
          "slug": "text",
          "name": "text"
        }
      ],
      "tag_names": "text",
      "gameservers": [
        {
          "id": "411486491630370816",
          "name": "text",
          "enabled": true
        }
      ],
      "gameserver_names": "text",
      "commands": [
        {
          "stage": "on_purchase",
          "content": "text",
          "online_only": true
        }
      ],
      "created_at": null,
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "state": "usable",
    "added_at": "2024-01-10T08:00:00Z",
    "active_at": "2024-01-10T09:00:00Z",
    "expires_at": "2024-12-31T23:59:59Z",
    "removed_at": "2024-02-01T10:00:00Z",
    "revoked_at": "2024-02-05T14:30:00Z",
    "revoke_reason": null
  }
}

Triggered when a delivery item in the customers inventory activates

Webhook for ON_DELIVERY_ITEM_ACTIVATED

Payload

application/json

event_typeall ofRequired

The type of webhook event

Example: ON_DELIVERY_ITEM_ACTIVATED

string · enumOptional

The type of webhook event

Possible values:

event_idstring · flake-idRequired

The ID of the Webhook Event

Example: 411486491630370816

Responses

200

Webhook processed successfully

400

Bad request

500

Internal server error

Payload

{
  "event_type": "ON_DELIVERY_ITEM_ACTIVATED",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "name": "John",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "text"
      },
      "minecraft": {
        "id": "text",
        "name": "Notch",
        "avatar_url": "text"
      },
      "profile": {
        "id": "text",
        "platform": "text",
        "name": "John",
        "avatar_url": "text"
      }
    },
    "order_customer_id": "411486491630370816",
    "checkout_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "execute_on_gameserver": {
      "id": "411486491630370816",
      "name": "John",
      "enabled": true
    },
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "version_id": "411486491630370816",
      "image_url": null,
      "slug": "text",
      "name": "text",
      "description": "text",
      "enabled": true,
      "label": null,
      "sort_order": 1,
      "price": 1,
      "single_game_server_only": true,
      "allow_one_time_purchase": true,
      "allow_subscription": true,
      "subscription_interval_value": 1,
      "subscription_interval_scale": "month",
      "remove_after_enabled": true,
      "remove_after_time_value": 1,
      "remove_after_time_scale": "month",
      "tags": [
        {
          "id": "411486491630370816",
          "slug": "text",
          "name": "text"
        }
      ],
      "tag_names": "text",
      "gameservers": [
        {
          "id": "411486491630370816",
          "name": "text",
          "enabled": true
        }
      ],
      "gameserver_names": "text",
      "commands": [
        {
          "stage": "on_purchase",
          "content": "text",
          "online_only": true
        }
      ],
      "created_at": null,
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "state": "usable",
    "added_at": "2024-01-10T08:00:00Z",
    "active_at": "2024-01-10T09:00:00Z",
    "expires_at": "2024-12-31T23:59:59Z",
    "removed_at": "2024-02-01T10:00:00Z",
    "revoked_at": "2024-02-05T14:30:00Z",
    "revoke_reason": null
  }
}

Triggered when a delivery item in the customers inventory becomes used

Webhook for ON_DELIVERY_ITEM_USED

Payload

application/json

event_typeall ofRequired

The type of webhook event

Example: ON_DELIVERY_ITEM_USED

string · enumOptional

The type of webhook event

Possible values:

event_idstring · flake-idRequired

The ID of the Webhook Event

Example: 411486491630370816

Responses

200

Webhook processed successfully

400

Bad request

500

Internal server error

Payload

{
  "event_type": "ON_DELIVERY_ITEM_USED",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "name": "John",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "text"
      },
      "minecraft": {
        "id": "text",
        "name": "Notch",
        "avatar_url": "text"
      },
      "profile": {
        "id": "text",
        "platform": "text",
        "name": "John",
        "avatar_url": "text"
      }
    },
    "order_customer_id": "411486491630370816",
    "checkout_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "execute_on_gameserver": {
      "id": "411486491630370816",
      "name": "John",
      "enabled": true
    },
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "version_id": "411486491630370816",
      "image_url": null,
      "slug": "text",
      "name": "text",
      "description": "text",
      "enabled": true,
      "label": null,
      "sort_order": 1,
      "price": 1,
      "single_game_server_only": true,
      "allow_one_time_purchase": true,
      "allow_subscription": true,
      "subscription_interval_value": 1,
      "subscription_interval_scale": "month",
      "remove_after_enabled": true,
      "remove_after_time_value": 1,
      "remove_after_time_scale": "month",
      "tags": [
        {
          "id": "411486491630370816",
          "slug": "text",
          "name": "text"
        }
      ],
      "tag_names": "text",
      "gameservers": [
        {
          "id": "411486491630370816",
          "name": "text",
          "enabled": true
        }
      ],
      "gameserver_names": "text",
      "commands": [
        {
          "stage": "on_purchase",
          "content": "text",
          "online_only": true
        }
      ],
      "created_at": null,
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "state": "usable",
    "added_at": "2024-01-10T08:00:00Z",
    "active_at": "2024-01-10T09:00:00Z",
    "expires_at": "2024-12-31T23:59:59Z",
    "removed_at": "2024-02-01T10:00:00Z",
    "revoked_at": "2024-02-05T14:30:00Z",
    "revoke_reason": null
  }
}

Triggered when a delivery item is revoked from the customers inventory

Webhook for ON_DELIVERY_ITEM_REVOKED

Payload

application/json

event_typeall ofRequired

The type of webhook event

Example: ON_DELIVERY_ITEM_REVOKED

string · enumOptional

The type of webhook event

Possible values:

event_idstring · flake-idRequired

The ID of the Webhook Event

Example: 411486491630370816

Responses

200

Webhook processed successfully

400

Bad request

500

Internal server error

Payload

{
  "event_type": "ON_DELIVERY_ITEM_REVOKED",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "name": "John",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "text"
      },
      "minecraft": {
        "id": "text",
        "name": "Notch",
        "avatar_url": "text"
      },
      "profile": {
        "id": "text",
        "platform": "text",
        "name": "John",
        "avatar_url": "text"
      }
    },
    "order_customer_id": "411486491630370816",
    "checkout_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "execute_on_gameserver": {
      "id": "411486491630370816",
      "name": "John",
      "enabled": true
    },
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "version_id": "411486491630370816",
      "image_url": null,
      "slug": "text",
      "name": "text",
      "description": "text",
      "enabled": true,
      "label": null,
      "sort_order": 1,
      "price": 1,
      "single_game_server_only": true,
      "allow_one_time_purchase": true,
      "allow_subscription": true,
      "subscription_interval_value": 1,
      "subscription_interval_scale": "month",
      "remove_after_enabled": true,
      "remove_after_time_value": 1,
      "remove_after_time_scale": "month",
      "tags": [
        {
          "id": "411486491630370816",
          "slug": "text",
          "name": "text"
        }
      ],
      "tag_names": "text",
      "gameservers": [
        {
          "id": "411486491630370816",
          "name": "text",
          "enabled": true
        }
      ],
      "gameserver_names": "text",
      "commands": [
        {
          "stage": "on_purchase",
          "content": "text",
          "online_only": true
        }
      ],
      "created_at": null,
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "state": "usable",
    "added_at": "2024-01-10T08:00:00Z",
    "active_at": "2024-01-10T09:00:00Z",
    "expires_at": "2024-12-31T23:59:59Z",
    "removed_at": "2024-02-01T10:00:00Z",
    "revoked_at": "2024-02-05T14:30:00Z",
    "revoke_reason": null
  }
}

Triggered when an order is completed

Webhook for ON_ORDER_COMPLETED

Payload

application/json

event_typeall ofRequired

The type of webhook event

Example: ON_ORDER_COMPLETED

string · enumOptional

The type of webhook event

Possible values:

event_idstring · flake-idRequired

The ID of the Webhook Event

Example: 411486491630370816

Responses

200

Webhook processed successfully

400

Bad request

500

Internal server error

Payload

{
  "event_type": "ON_ORDER_COMPLETED",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "name": "John",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "text"
      },
      "minecraft": {
        "id": "text",
        "name": "Notch",
        "avatar_url": "text"
      },
      "profile": {
        "id": "text",
        "platform": "text",
        "name": "John",
        "avatar_url": "text"
      }
    },
    "checkout_id": "411486491630370816",
    "checkout": {
      "id": "411486491630370816",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "lines": [
        {
          "id": "411486491630370816",
          "product_id": "411486491630370816",
          "product_version_id": "411486491630370816",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ]
    },
    "subscription_id": "411486491630370816",
    "coupon_id": "411486491630370816",
    "currency": "USD",
    "tax_inclusive": true,
    "tax_amount": 1500,
    "discount_amount": 500,
    "subtotal_amount": 10000,
    "total_amount": 11000,
    "created_at": "2024-01-15T10:30:00Z",
    "completed_at": "2024-01-15T10:35:00Z",
    "billing_name": "John Doe",
    "billing_email": "[email protected]",
    "billing_address_country": "US",
    "customer_ip": "127.0.0.1/24",
    "giftcard_usage_amount": 0,
    "lines": [
      {
        "id": "411486491630370816",
        "checkout_line_id": "411486491630370816",
        "product_id": "411486491630370816",
        "product_version_id": "411486491630370816",
        "product": {
          "id": "411486491630370816",
          "store_id": "411486491630370816",
          "version_id": "411486491630370816",
          "image_url": null,
          "slug": "text",
          "name": "text",
          "description": "text",
          "enabled": true,
          "label": null,
          "sort_order": 1,
          "price": 1,
          "single_game_server_only": true,
          "allow_one_time_purchase": true,
          "allow_subscription": true,
          "subscription_interval_value": 1,
          "subscription_interval_scale": "month",
          "remove_after_enabled": true,
          "remove_after_time_value": 1,
          "remove_after_time_scale": "month",
          "tags": [
            {
              "id": "411486491630370816",
              "slug": "text",
              "name": "text"
            }
          ],
          "tag_names": "text",
          "gameservers": [
            {
              "id": "411486491630370816",
              "name": "text",
              "enabled": true
            }
          ],
          "gameserver_names": "text",
          "commands": [
            {
              "stage": "on_purchase",
              "content": "text",
              "online_only": true
            }
          ],
          "created_at": null,
          "updated_at": null,
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "product_name": "text",
        "product_image_url": null,
        "subscription_id": "411486491630370816",
        "subscription_interval_value": 1,
        "subscription_interval_scale": "month",
        "trial_id": "411486491630370816",
        "gift_to_customer": {
          "id": "411486491630370816",
          "name": "John",
          "steam": {
            "id": "76561197960287930",
            "name": "John",
            "avatar_url": "text"
          },
          "minecraft": {
            "id": "text",
            "name": "Notch",
            "avatar_url": "text"
          },
          "profile": {
            "id": "text",
            "platform": "text",
            "name": "John",
            "avatar_url": "text"
          }
        },
        "price": 1000,
        "quantity": 1,
        "discount_amount": 0,
        "subtotal_amount": 1000,
        "tax_amount": 100,
        "total_amount": 1100,
        "selected_gameserver_id": "411486491630370816"
      }
    ],
    "product_names": "Product A, Product B",
    "product_tags": "ranks, perks",
    "product_gameservers": "game server one, game server two",
    "status": "created"
  }
}

Triggered when a chargeback is created

Webhook for ON_CHARGEBACK

Payload

application/json

event_typeall ofRequired

The type of webhook event

Example: ON_CHARGEBACK

string · enumOptional

The type of webhook event

Possible values:

event_idstring · flake-idRequired

The ID of the Webhook Event

Example: 411486491630370816

Responses

200

Webhook processed successfully

400

Bad request

500

Internal server error

Payload

{
  "event_type": "ON_CHARGEBACK",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "order_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "name": "John",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "text"
      },
      "minecraft": {
        "id": "text",
        "name": "Notch",
        "avatar_url": "text"
      },
      "profile": {
        "id": "text",
        "platform": "text",
        "name": "John",
        "avatar_url": "text"
      }
    },
    "gateway": "stripe",
    "currency": "USD",
    "tax_inclusive": true,
    "amount": 7500,
    "gateway_fee_amount": 200,
    "tax_amount": 1200,
    "platform_fee_amount": 375,
    "store_net_amount": 5925,
    "status": "text",
    "chargeback_at": "2024-01-25T14:45:00Z"
  }
}

Triggered when a refund is completed

Webhook for ON_REFUND

Payload

application/json

event_typeall ofRequired

The type of webhook event

Example: ON_REFUND

string · enumOptional

The type of webhook event

Possible values:

event_idstring · flake-idRequired

The ID of the Webhook Event

Example: 411486491630370816

Responses

200

Webhook processed successfully

400

Bad request

500

Internal server error

Payload

{
  "event_type": "ON_REFUND",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "order_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "name": "John",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "text"
      },
      "minecraft": {
        "id": "text",
        "name": "Notch",
        "avatar_url": "text"
      },
      "profile": {
        "id": "text",
        "platform": "text",
        "name": "John",
        "avatar_url": "text"
      }
    },
    "payment_id": "411486491630370816",
    "gateway": "text",
    "currency": "USD",
    "tax_inclusive": false,
    "amount": 5000,
    "gateway_fee_amount": 150,
    "tax_amount": 800,
    "platform_fee_amount": 250,
    "store_net_amount": 3800,
    "store_refund_amount": 5000,
    "created_at": "2024-01-20T12:00:00Z",
    "approved_at": "2024-01-20T12:30:00Z",
    "pending_at": "2024-01-20T12:15:00Z",
    "completed_at": "2024-01-20T13:00:00Z",
    "billing_email": "[email protected]",
    "status": "created"
  }
}

Triggered when a subscription is activated

Webhook for ON_SUBSCRIPTION_ACTIVATED

Payload

application/json

event_typeall ofRequired

The type of webhook event

Example: ON_SUBSCRIPTION_ACTIVATED

string · enumOptional

The type of webhook event

Possible values:

event_idstring · flake-idRequired

The ID of the Webhook Event

Example: 411486491630370816

Responses

200

Webhook processed successfully

400

Bad request

500

Internal server error

Payload

{
  "event_type": "ON_SUBSCRIPTION_ACTIVATED",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "name": "John",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "text"
      },
      "minecraft": {
        "id": "text",
        "name": "Notch",
        "avatar_url": "text"
      },
      "profile": {
        "id": "text",
        "platform": "text",
        "name": "John",
        "avatar_url": "text"
      }
    },
    "checkout": {
      "id": "411486491630370816",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "lines": [
        {
          "id": "411486491630370816",
          "product_id": "411486491630370816",
          "product_version_id": "411486491630370816",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ]
    },
    "billing_cycle_sequence": 1,
    "billing_email": "[email protected]",
    "subtotal_amount": 9999,
    "tax_amount": 1500,
    "discount_amount": 1000,
    "total_amount": 10499,
    "currency": "USD",
    "interval_value": 1,
    "interval_scale": "month",
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product_name": "Example Product",
    "product_image_url": "https://example.com/image.jpg",
    "product": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "version_id": "411486491630370816",
      "image_url": null,
      "slug": "text",
      "name": "text",
      "description": "text",
      "enabled": true,
      "label": null,
      "sort_order": 1,
      "price": 1,
      "single_game_server_only": true,
      "allow_one_time_purchase": true,
      "allow_subscription": true,
      "subscription_interval_value": 1,
      "subscription_interval_scale": "month",
      "remove_after_enabled": true,
      "remove_after_time_value": 1,
      "remove_after_time_scale": "month",
      "tags": [
        {
          "id": "411486491630370816",
          "slug": "text",
          "name": "text"
        }
      ],
      "tag_names": "text",
      "gameservers": [
        {
          "id": "411486491630370816",
          "name": "text",
          "enabled": true
        }
      ],
      "gameserver_names": "text",
      "commands": [
        {
          "stage": "on_purchase",
          "content": "text",
          "online_only": true
        }
      ],
      "created_at": null,
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "billing_country": "US",
    "initial_subtotal_amount": 9999,
    "initial_tax_amount": 1500,
    "initial_discount_amount": 2000,
    "initial_giftcard_usage_amount": 0,
    "initial_total_amount": 9499,
    "customer_ip": "127.0.0.1/24",
    "current_period_start": "2024-02-01T00:00:00Z",
    "current_period_end": "2024-03-01T00:00:00Z",
    "created_at": "2024-02-01T10:15:00Z",
    "active_at": "2024-02-01T10:20:00Z",
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "status": "created"
  }
}

Triggered when a subscription is canceled

Webhook for ON_SUBSCRIPTION_CANCELED

Payload

application/json

event_typeall ofRequired

The type of webhook event

Example: ON_SUBSCRIPTION_CANCELED

string · enumOptional

The type of webhook event

Possible values:

event_idstring · flake-idRequired

The ID of the Webhook Event

Example: 411486491630370816

Responses

200

Webhook processed successfully

400

Bad request

500

Internal server error

Payload

{
  "event_type": "ON_SUBSCRIPTION_CANCELED",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "name": "John",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "text"
      },
      "minecraft": {
        "id": "text",
        "name": "Notch",
        "avatar_url": "text"
      },
      "profile": {
        "id": "text",
        "platform": "text",
        "name": "John",
        "avatar_url": "text"
      }
    },
    "checkout": {
      "id": "411486491630370816",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "lines": [
        {
          "id": "411486491630370816",
          "product_id": "411486491630370816",
          "product_version_id": "411486491630370816",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ]
    },
    "billing_cycle_sequence": 1,
    "billing_email": "[email protected]",
    "subtotal_amount": 4999,
    "tax_amount": 750,
    "discount_amount": 0,
    "total_amount": 5749,
    "currency": "USD",
    "interval_value": 1,
    "interval_scale": "annually",
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product_name": "Starter Plan",
    "product_image_url": "https://example.com/starter.jpg",
    "product": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "version_id": "411486491630370816",
      "image_url": null,
      "slug": "text",
      "name": "text",
      "description": "text",
      "enabled": true,
      "label": null,
      "sort_order": 1,
      "price": 1,
      "single_game_server_only": true,
      "allow_one_time_purchase": true,
      "allow_subscription": true,
      "subscription_interval_value": 1,
      "subscription_interval_scale": "month",
      "remove_after_enabled": true,
      "remove_after_time_value": 1,
      "remove_after_time_scale": "month",
      "tags": [
        {
          "id": "411486491630370816",
          "slug": "text",
          "name": "text"
        }
      ],
      "tag_names": "text",
      "gameservers": [
        {
          "id": "411486491630370816",
          "name": "text",
          "enabled": true
        }
      ],
      "gameserver_names": "text",
      "commands": [
        {
          "stage": "on_purchase",
          "content": "text",
          "online_only": true
        }
      ],
      "created_at": null,
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "billing_country": "US",
    "initial_subtotal_amount": 4999,
    "initial_tax_amount": 750,
    "initial_discount_amount": 500,
    "initial_giftcard_usage_amount": 0,
    "initial_total_amount": 5249,
    "customer_ip": "127.0.0.1/24",
    "current_period_start": "2024-04-01T00:00:00Z",
    "current_period_end": "2025-04-01T00:00:00Z",
    "created_at": "2024-04-01T09:30:00Z",
    "active_at": "2024-04-01T09:35:00Z",
    "canceled_at": "2024-05-15T14:20:00Z",
    "cancel_reason": "customer_request",
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "status": "created"
  }
}

Triggered when a trial is activated

Webhook for ON_TRIAL_ACTIVATED

Payload

application/json

event_typeall ofRequired

The type of webhook event

Example: ON_TRIAL_ACTIVATED

string · enumOptional

The type of webhook event

Possible values:

event_idstring · flake-idRequired

The ID of the Webhook Event

Example: 411486491630370816

Responses

200

Webhook processed successfully

400

Bad request

500

Internal server error

Payload

{
  "event_type": "ON_TRIAL_ACTIVATED",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "name": "John",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "text"
      },
      "minecraft": {
        "id": "text",
        "name": "Notch",
        "avatar_url": "text"
      },
      "profile": {
        "id": "text",
        "platform": "text",
        "name": "John",
        "avatar_url": "text"
      }
    },
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product_name": "Example Product",
    "product_image_url": "https://example.com/image.jpg",
    "period_value": 1,
    "period_scale": "month",
    "starts_at": "2024-06-10T00:00:00Z",
    "ends_at": "2024-06-17T23:59:59Z",
    "status": "created",
    "created_at": "2024-06-10T08:30:00Z",
    "canceled_at": "2024-06-15T10:15:00Z"
  }
}

Triggered when a trial is completed

Webhook for ON_TRIAL_COMPLETED

Payload

application/json

event_typeall ofRequired

The type of webhook event

Example: ON_TRIAL_COMPLETED

string · enumOptional

The type of webhook event

Possible values:

event_idstring · flake-idRequired

The ID of the Webhook Event

Example: 411486491630370816

Responses

200

Webhook processed successfully

400

Bad request

500

Internal server error

Payload

{
  "event_type": "ON_TRIAL_COMPLETED",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "name": "John",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "text"
      },
      "minecraft": {
        "id": "text",
        "name": "Notch",
        "avatar_url": "text"
      },
      "profile": {
        "id": "text",
        "platform": "text",
        "name": "John",
        "avatar_url": "text"
      }
    },
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product_name": "Example Product",
    "product_image_url": "https://example.com/image.jpg",
    "period_value": 1,
    "period_scale": "month",
    "starts_at": "2024-06-10T00:00:00Z",
    "ends_at": "2024-06-17T23:59:59Z",
    "status": "created",
    "created_at": "2024-06-10T08:30:00Z",
    "canceled_at": "2024-06-15T10:15:00Z"
  }
}

Triggered when a trial is canceled

Webhook for ON_TRIAL_CANCELED

Payload

application/json

event_typeall ofRequired

The type of webhook event

Example: ON_TRIAL_CANCELED

string · enumOptional

The type of webhook event

Possible values:

event_idstring · flake-idRequired

The ID of the Webhook Event

Example: 411486491630370816

Responses

200

Webhook processed successfully

400

Bad request

500

Internal server error

Payload

{
  "event_type": "ON_TRIAL_CANCELED",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "name": "John",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "text"
      },
      "minecraft": {
        "id": "text",
        "name": "Notch",
        "avatar_url": "text"
      },
      "profile": {
        "id": "text",
        "platform": "text",
        "name": "John",
        "avatar_url": "text"
      }
    },
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product_name": "Example Product",
    "product_image_url": "https://example.com/image.jpg",
    "period_value": 1,
    "period_scale": "month",
    "starts_at": "2024-06-10T00:00:00Z",
    "ends_at": "2024-06-17T23:59:59Z",
    "status": "created",
    "created_at": "2024-06-10T08:30:00Z",
    "canceled_at": "2024-06-15T10:15:00Z"
  }
}