Documentation

Developers

Configuration

Sales Events

checkout.createdcheckout.updatedorder.createdsubscription.activesubscription.canceledsubscription.createdsubscription.revokedsubscription.updatedbenefit_grant.createdbenefit_grant.revokedbenefit_grant.updated

Store Events

product.createdproduct.updatedbenefit.createdbenefit.updatedorganization.updated

checkout.updated

Sent when a checkout is updated.

Discord & Slack support: Basic

Raw format payload

{
  "type": "checkout.updated",
  "data": {
    "created_at": "2024-12-02T00:00:00.000Z",
    "modified_at": "2024-12-02T00:00:00.000Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "custom_field_data": {},
    "payment_processor": "stripe",
    "status": "open",
    "client_secret": "string",
    "url": "string",
    "expires_at": "2024-12-02T00:00:00.000Z",
    "success_url": "string",
    "embed_origin": "string",
    "amount": 0,
    "tax_amount": 0,
    "currency": "string",
    "subtotal_amount": 0,
    "total_amount": 0,
    "product_id": "00000000-0000-0000-0000-000000000000",
    "product_price_id": "00000000-0000-0000-0000-000000000000",
    "discount_id": "00000000-0000-0000-0000-000000000000",
    "allow_discount_codes": false,
    "is_discount_applicable": false,
    "is_free_product_price": false,
    "is_payment_required": false,
    "is_payment_setup_required": false,
    "is_payment_form_required": false,
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "customer_name": "string",
    "customer_email": "string",
    "customer_ip_address": "string",
    "customer_billing_address": {
      "line1": "string",
      "line2": "string",
      "postal_code": "string",
      "city": "string",
      "state": "string",
      "country": "string"
    },
    "customer_tax_id": "string",
    "payment_processor_metadata": {},
    "metadata": {},
    "product": {
      "created_at": "2024-12-02T00:00:00.000Z",
      "modified_at": "2024-12-02T00:00:00.000Z",
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "description": "string",
      "is_recurring": false,
      "is_archived": false,
      "organization_id": "00000000-0000-0000-0000-000000000000",
      "prices": [
        {
          "created_at": "2024-12-02T00:00:00.000Z",
          "modified_at": "2024-12-02T00:00:00.000Z",
          "id": "00000000-0000-0000-0000-000000000000",
          "amount_type": "fixed",
          "is_archived": false,
          "product_id": "00000000-0000-0000-0000-000000000000",
          "price_currency": "string",
          "price_amount": 0,
          "type": "recurring",
          "recurring_interval": "month"
        }
      ],
      "benefits": [
        {
          "created_at": "2024-12-02T00:00:00.000Z",
          "modified_at": "2024-12-02T00:00:00.000Z",
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "custom",
          "description": "string",
          "selectable": false,
          "deletable": false,
          "organization_id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "medias": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "organization_id": "00000000-0000-0000-0000-000000000000",
          "name": "string",
          "path": "string",
          "mime_type": "string",
          "size": 0,
          "storage_version": "string",
          "checksum_etag": "string",
          "checksum_sha256_base64": "string",
          "checksum_sha256_hex": "string",
          "last_modified_at": "2024-12-02T00:00:00.000Z",
          "version": "string",
          "service": "product_media",
          "is_uploaded": false,
          "created_at": "2024-12-02T00:00:00.000Z",
          "size_readable": "string",
          "public_url": "string"
        }
      ]
    },
    "product_price": {
      "created_at": "2024-12-02T00:00:00.000Z",
      "modified_at": "2024-12-02T00:00:00.000Z",
      "id": "00000000-0000-0000-0000-000000000000",
      "amount_type": "fixed",
      "is_archived": false,
      "product_id": "00000000-0000-0000-0000-000000000000",
      "price_currency": "string",
      "price_amount": 0,
      "type": "recurring",
      "recurring_interval": "month"
    },
    "discount": {
      "duration": "once",
      "type": "fixed",
      "amount": 0,
      "currency": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "code": "string"
    },
    "subscription_id": "00000000-0000-0000-0000-000000000000",
    "attached_custom_fields": [
      {
        "custom_field_id": "00000000-0000-0000-0000-000000000000",
        "custom_field": {
          "created_at": "2024-12-02T00:00:00.000Z",
          "modified_at": "2024-12-02T00:00:00.000Z",
          "id": "00000000-0000-0000-0000-000000000000",
          "metadata": {},
          "type": "text",
          "slug": "string",
          "name": "string",
          "organization_id": "00000000-0000-0000-0000-000000000000",
          "properties": {
            "form_label": "string",
            "form_help_text": "string",
            "form_placeholder": "string",
            "textarea": false,
            "min_length": 0,
            "max_length": 0
          }
        },
        "order": 0,
        "required": false
      }
    ]
  }
}