Sign in
latestOpenAPI 3.1.02026-08-163864115.7 MB

c363cb2feb95

Memberships

Membership Deactivated

Sent when a membership is deactivated

Required permissions:

  • member:basic:read
  • member:email:read
  • webhook_receive:memberships
postWebhookmembership.deactivated

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'membership.deactivated' 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",
      "logo_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "route": "shine-time-auto-detailing",
      "title": "Shine Time Auto Detailing"
    },
    "created_at": "2026-01-01T12:00:00.000Z",
    "current_period_end": "2026-01-01T12:00:00.000Z",
    "id": "mem_xxxxxxxxxxxxxx",
    "license_key": "WHOP-XXXX-XXXX-XXXX",
    "member": {
      "access_level": "customer",
      "last_accessed_at": "2026-01-01T12:00:00.000Z",
      "position": 1767268800000
    },
    "metadata": {},
    "plan_id": "plan_xxxxxxxxxxxxxx",
    "product_id": "prod_xxxxxxxxxxxxxx",
    "status": "active",
    "user_id": "user_xxxxxxxxxxxxxx"
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "membership.deactivated"
}

Response

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