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

subscription.updated

Sent when a subscription is updated. This event fires for all changes to the subscription, including renewals.

If you want more specific events, you can listen to subscription.active, subscription.canceled, and subscription.revoked.

To listen specifically for renewals, you can listen to order.created events and check the billing_reason field.

Discord & Slack support: On cancellation and revocation. Renewals are skipped.

Raw format payload

{
  "type": "subscription.updated",
  "data": {
    "created_at": "2024-12-02T00:00:00.000Z",
    "modified_at": "2024-12-02T00:00:00.000Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "amount": 0,
    "currency": "string",
    "recurring_interval": "month",
    "status": "incomplete",
    "current_period_start": "2024-12-02T00:00:00.000Z",
    "current_period_end": "2024-12-02T00:00:00.000Z",
    "cancel_at_period_end": false,
    "started_at": "2024-12-02T00:00:00.000Z",
    "ended_at": "2024-12-02T00:00:00.000Z",
    "user_id": "00000000-0000-0000-0000-000000000000",
    "product_id": "00000000-0000-0000-0000-000000000000",
    "price_id": "00000000-0000-0000-0000-000000000000",
    "discount_id": "00000000-0000-0000-0000-000000000000",
    "checkout_id": "00000000-0000-0000-0000-000000000000",
    "metadata": {},
    "custom_field_data": {},
    "user": {
      "email": "string",
      "public_name": "string",
      "github_username": "string",
      "avatar_url": "string"
    },
    "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",
      "metadata": {},
      "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": "articles",
          "description": "string",
          "selectable": false,
          "deletable": false,
          "organization_id": "00000000-0000-0000-0000-000000000000",
          "properties": {
            "paid_articles": false
          }
        }
      ],
      "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"
        }
      ],
      "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
        }
      ]
    },
    "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",
      "created_at": "2024-12-02T00:00:00.000Z",
      "modified_at": "2024-12-02T00:00:00.000Z",
      "id": "00000000-0000-0000-0000-000000000000",
      "metadata": {},
      "name": "string",
      "code": "string",
      "starts_at": "2024-12-02T00:00:00.000Z",
      "ends_at": "2024-12-02T00:00:00.000Z",
      "max_redemptions": 0,
      "redemptions_count": 0,
      "organization_id": "00000000-0000-0000-0000-000000000000"
    }
  }
}