a84d4905fdbb

latestOpenAPI 3.1.02026-08-143874115.7 MB
Plans

Plan Deleted

Sent when a plan is deleted

Required permissions:

  • webhook_receive:plans
postWebhookplan.deleted

Headers

webhook-idstring required

A unique identifier for this webhook request

Example:msg_xxxxxxxxxxxxxxxxxxxxxxxx
webhook-signaturestring required

The signature of the webhook request with the webhook version prepended

Example:v1,BASE64ENCODEDSIGNATURE
webhook-timestampstring required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:1727606400

Payload

api_version'v1' required

The API version for this webhook

api_version_datestring nullable required

The dated API version (Api-Version-Date) the payload is serialized to

company_idstring nullable

The account ID that this webhook event is associated with

idstring required

A unique ID for every single webhook request

timestampstring date-time required

The timestamp in ISO 8601 format that the webhook was sent at on the server

type'plan.deleted' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "account": {
      "id": "biz_xxxxxxxxxxxxxx",
      "title": "Shine Time Auto Detailing"
    },
    "adaptive_pricing_enabled": true,
    "billing_period": 30,
    "cancel_discount_intervals": 3,
    "cancel_discount_percentage": 20,
    "checkout_styling": {
      "background_color": "#0f172a",
      "border_style": "rounded",
      "button_color": "#f59e0b",
      "font_family": "roboto"
    },
    "created_at": "2026-01-01T12:00:00.000Z",
    "currency": "usd",
    "custom_fields": [
      {
        "field_type": "text",
        "id": "field_xxxxxxxxxxxxxx",
        "name": "Vehicle make and model",
        "placeholder": "2021 Audi S5",
        "required": true
      }
    ],
    "deletable": true,
    "description": "Two hand washes a month, interior vacuum, and a quarterly sealant top-up.",
    "expiration_days": 365,
    "formatted_price": "$59.00 / month",
    "id": "plan_xxxxxxxxxxxxxx",
    "image": {
      "blurhash": "LA6bDXT$E3b:R6i+RibEIWbp%ej1",
      "url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "internal_notes": "Maintenance tier. Upsell the interior shampoo add-on at renewal.",
    "invoice": {
      "id": "inv_xxxxxxxxxxxxxx"
    },
    "metadata": {},
    "offer_cancel_discount": true,
    "payment_method_configuration": {
      "disabled": [
        "crypto"
      ],
      "enabled": [
        "card"
      ],
      "include_platform_defaults": true
    },
    "plan_type": "renewal",
    "product": {
      "id": "prod_xxxxxxxxxxxxxx",
      "title": "Ceramic Coating Package"
    },
    "purchase_url": "http://whop.com/checkout/plan_xxxxxxxxxxxxxx",
    "release_method": "buy_now",
    "renewal_price": 59,
    "split_pay_required_payments": 4,
    "strike_through_initial_price": 99,
    "strike_through_renewal_price": 79,
    "tax_type": "unspecified",
    "three_ds_level": "frictionless",
    "title": "Unlimited Wash Club",
    "trial_period_days": 7,
    "updated_at": "2026-01-01T12:00:00.000Z",
    "visibility": "visible"
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "plan.deleted"
}

Response

Return a 200 status to indicate that the data was received successfully