API Reference

Example JSON Response for the payment.succeeded response:

{
  "action": "payment.succeeded",
  "data": {
    "id": "pay_6dWDN0kA5QW2hm",
    "product": {
      "id": "pass_nTBNZkZbvGII9",
      "name": "1 GB",
      "visibility": "visible",
      "created_at": 1655004106,
      "experiences": [
        "exp_LQk5IgYwjlNwNj"
      ],
      "plans": [
        "plan_hvYOAfuitb44D",
        "plan_zqw00TkN6zFGh"
      ]
    },
    "membership": "mem_nePhZvdqdLOKsZ",
    "plan": {
      "id": "plan_hvYOAfuitb44D",
      "plan_type": "one_time",
      "release_method": "buy_now",
      "visibility": "visible",
      "billing_period": null,
      "internal_notes": "1 GB Monthly Expiration Plan",
      "metadata": {},
      "direct_link": "https://whop.com/checkout/plan_hvYOAfuitb44D?d2c=true",
      "renewal_price": "0.0",
      "initial_price": "10.5",
      "base_currency": "usd",
      "requirements": {},
      "release_method_settings": {},
      "accepted_payment_methods": [
        "stripe"
      ],
      "stock": 0,
      "unlimited_stock": true,
      "created_at": 1655004107,
      "card_payments": true
    },
    "user": {
      "id": "user_q61ixyl8cVGff",
      "username": "whopinc",
      "email": "[email protected]",
      "profile_pic_url": "https://cdn.discordapp.com/avatars/781784956044574751/",
      "social_accounts": [
        {
          "service": "discord",
          "username": "Rodger#6128",
          "id": "781784956044574751"
        }
      ]
    },
    "final_amount": 10,
    "subtotal": 10,
    "currency": "usd",
    "last4": "9971",
    "payments_failed": 1,
    "payment_processor": "stripe",
    "refunded_amount": 0,
    "status": "paid",
    "crypto_tx_hash": null,
    "wallet_address": null,
    "refunded_at": null,
    "last_payment_attempt": null,
    "next_payment_attempt": null,
    "access_pass": {
      "id": "pass_nTBNZkZbvGII9",
      "name": "1 GB",
      "visibility": "visible",
      "created_at": 1655004106
    }
  }
}