> For the complete documentation index, see [llms.txt](https://developers.spiffy.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.spiffy.co/api/events.md).

# Events

Account event log

## List events

> List audit events — the account activity log. Each event records an action taken by a user (dashboard staff), a customer, or the system (automated billing): subscription changes, payments, card updates, notes, and more. \`name\` identifies the action (see the name filter for valid values), \`data\` carries action-specific detail, and the \*\_id fields link to the related customer, order, subscription, payment plan, or payment.

```json
{"openapi":"3.0.3","info":{"title":"Spiffy API","version":"2.0.0"},"tags":[{"name":"events","description":"Account event log"}],"servers":[{"url":"https://api.spiffy.co","description":"Production"}],"security":[{"ApiKeyAuth":[]},{"OAuth2":["account"]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Account API key authentication. Pass an API key as a Bearer token in the `Authorization` header. An account may have multiple named keys; any of them grants full access to all endpoints — equivalent to all OAuth scopes."},"OAuth2":{"type":"oauth2","description":"OAuth 2.0 authentication for third-party integrations. Access is limited to the scopes granted by the merchant during authorization.","flows":{"authorizationCode":{"authorizationUrl":"https://app.spiffy.co/oauth/authorize","tokenUrl":"https://api.spiffy.co/oauth/token","refreshUrl":"https://api.spiffy.co/oauth/token","scopes":{"account":"Access account details and settings","users":"Manage users","customers":"Read and manage customers","checkouts":"Read and manage checkouts","subscriptions":"Read and manage subscriptions","subscription_metered_billing":"Manage metered billing for subscriptions","integrations":"Manage integrations","orders":"Read and manage orders","payments":"Read and manage payments","paymentplans":"Read and manage payment plans","webhooks":"Manage webhook endpoints and view event logs","promos":"Read and manage promotions and their codes","affiliates":"Read and manage affiliates and programs","products":"Read and manage products","analytics":"Read analytics data (revenue, orders, subscriptions, MRR)","reports":"Create, run, and read saved reports and their results"}}}}},"schemas":{"Error401":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["unauthorized"]},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"]},"Error403":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["forbidden"]},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"]},"Error500":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["internal_error"]},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"]}}},"paths":{"/v2/events":{"get":{"tags":["events"],"summary":"List events","description":"List audit events — the account activity log. Each event records an action taken by a user (dashboard staff), a customer, or the system (automated billing): subscription changes, payments, card updates, notes, and more. `name` identifies the action (see the name filter for valid values), `data` carries action-specific detail, and the *_id fields link to the related customer, order, subscription, payment plan, or payment.","parameters":[{"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Page number"},"required":false,"description":"Page number","name":"page","in":"query"},{"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":100,"description":"Items per page (max 100)"},"required":false,"description":"Items per page (max 100)","name":"per_page","in":"query"},{"schema":{"type":"string","description":"Filter by id (exact match)."},"required":false,"description":"Filter by id (exact match).","name":"filter[id]","in":"query"},{"schema":{"type":"string","description":"Filter by id (greater than or equal)"},"required":false,"description":"Filter by id (greater than or equal)","name":"filter[id.gte]","in":"query"},{"schema":{"type":"string","description":"Filter by id (less than or equal)"},"required":false,"description":"Filter by id (less than or equal)","name":"filter[id.lte]","in":"query"},{"schema":{"type":"string","description":"Filter by id (comma-separated list). Fetches many records in one request instead of one request per id."},"required":false,"description":"Filter by id (comma-separated list). Fetches many records in one request instead of one request per id.","name":"filter[id.in]","in":"query"},{"schema":{"type":"string","description":"Filter by id (excluding a comma-separated list)"},"required":false,"description":"Filter by id (excluding a comma-separated list)","name":"filter[id.nin]","in":"query"},{"schema":{"type":"string","description":"Filter by type (exact match). Valid values: user, customer, system."},"required":false,"description":"Filter by type (exact match). Valid values: user, customer, system.","name":"filter[type]","in":"query"},{"schema":{"type":"string","description":"Filter by type (comma-separated list). Fetches many records in one request instead of one request per id."},"required":false,"description":"Filter by type (comma-separated list). Fetches many records in one request instead of one request per id.","name":"filter[type.in]","in":"query"},{"schema":{"type":"string","description":"Filter by type (excluding a comma-separated list)"},"required":false,"description":"Filter by type (excluding a comma-separated list)","name":"filter[type.nin]","in":"query"},{"schema":{"type":"string","description":"Filter by name (exact match). Valid values: notes, login, update_account_whop_fee, general_notes, change_customer_email, update_customer, merge_customer, customer_magic_link, change_subscription_card, auto_change_subscription_card, cancel_subscription, uncancel_subscription, pause_subscription, resume_subscription, swap_subscription, order_placed, start_subscription, trialing_subscription, update_subscription, retire_subscription_leg, early_renewal_subscription, change_paymentplan_card, auto_change_paymentplan_card, update_paymentplan, update_paymentplan_terms, cancel_paymentplan, payment_upcoming, complete_paymentplan, payoff_paymentplan, defaulted_paymentplan, payment_failed, payment_success, payment_disputed, payment_dispute_refunded, payment_reinstated, payment_action_required, payment_action_resolved, payment_action_denied, create_payment, delete_payment, refund_payment, send_payment_receipt, resend_order_confirmation, manual_payment, retry_payment, skip_payment, create_adjustment, cancel_order_item, change_card, delete_card, hotswap_card, card_expired, card_expiring, affiliate_magic_link, affiliate_signup, update_order, update_order_affiliate, remove_order_affiliate, update_template, apply_subscription_discount, remove_subscription_discount, update_subscription_discount, create_oauth_client, update_oauth_client, delete_oauth_client, regenerate_oauth_client_secret, add_oauth_redirect_uri, remove_oauth_redirect_uri, add_oauth_scope, remove_oauth_scope, create_webhook_endpoint, update_webhook_endpoint, delete_webhook_endpoint, rotate_webhook_secret, oauth_app_connected, oauth_app_disconnected, create_api_key, delete_api_key, regenerate_api_key."},"required":false,"description":"Filter by name (exact match). Valid values: notes, login, update_account_whop_fee, general_notes, change_customer_email, update_customer, merge_customer, customer_magic_link, change_subscription_card, auto_change_subscription_card, cancel_subscription, uncancel_subscription, pause_subscription, resume_subscription, swap_subscription, order_placed, start_subscription, trialing_subscription, update_subscription, retire_subscription_leg, early_renewal_subscription, change_paymentplan_card, auto_change_paymentplan_card, update_paymentplan, update_paymentplan_terms, cancel_paymentplan, payment_upcoming, complete_paymentplan, payoff_paymentplan, defaulted_paymentplan, payment_failed, payment_success, payment_disputed, payment_dispute_refunded, payment_reinstated, payment_action_required, payment_action_resolved, payment_action_denied, create_payment, delete_payment, refund_payment, send_payment_receipt, resend_order_confirmation, manual_payment, retry_payment, skip_payment, create_adjustment, cancel_order_item, change_card, delete_card, hotswap_card, card_expired, card_expiring, affiliate_magic_link, affiliate_signup, update_order, update_order_affiliate, remove_order_affiliate, update_template, apply_subscription_discount, remove_subscription_discount, update_subscription_discount, create_oauth_client, update_oauth_client, delete_oauth_client, regenerate_oauth_client_secret, add_oauth_redirect_uri, remove_oauth_redirect_uri, add_oauth_scope, remove_oauth_scope, create_webhook_endpoint, update_webhook_endpoint, delete_webhook_endpoint, rotate_webhook_secret, oauth_app_connected, oauth_app_disconnected, create_api_key, delete_api_key, regenerate_api_key.","name":"filter[name]","in":"query"},{"schema":{"type":"string","description":"Filter by name (comma-separated list). Fetches many records in one request instead of one request per id."},"required":false,"description":"Filter by name (comma-separated list). Fetches many records in one request instead of one request per id.","name":"filter[name.in]","in":"query"},{"schema":{"type":"string","description":"Filter by name (excluding a comma-separated list)"},"required":false,"description":"Filter by name (excluding a comma-separated list)","name":"filter[name.nin]","in":"query"},{"schema":{"type":"string","description":"Filter by user_id (exact match)."},"required":false,"description":"Filter by user_id (exact match).","name":"filter[user_id]","in":"query"},{"schema":{"type":"string","description":"Filter by user_id (greater than or equal)"},"required":false,"description":"Filter by user_id (greater than or equal)","name":"filter[user_id.gte]","in":"query"},{"schema":{"type":"string","description":"Filter by user_id (less than or equal)"},"required":false,"description":"Filter by user_id (less than or equal)","name":"filter[user_id.lte]","in":"query"},{"schema":{"type":"string","description":"Filter by user_id (comma-separated list). Fetches many records in one request instead of one request per id."},"required":false,"description":"Filter by user_id (comma-separated list). Fetches many records in one request instead of one request per id.","name":"filter[user_id.in]","in":"query"},{"schema":{"type":"string","description":"Filter by user_id (excluding a comma-separated list)"},"required":false,"description":"Filter by user_id (excluding a comma-separated list)","name":"filter[user_id.nin]","in":"query"},{"schema":{"type":"string","description":"Filter by customer_id (exact match)."},"required":false,"description":"Filter by customer_id (exact match).","name":"filter[customer_id]","in":"query"},{"schema":{"type":"string","description":"Filter by customer_id (greater than or equal)"},"required":false,"description":"Filter by customer_id (greater than or equal)","name":"filter[customer_id.gte]","in":"query"},{"schema":{"type":"string","description":"Filter by customer_id (less than or equal)"},"required":false,"description":"Filter by customer_id (less than or equal)","name":"filter[customer_id.lte]","in":"query"},{"schema":{"type":"string","description":"Filter by customer_id (comma-separated list). Fetches many records in one request instead of one request per id."},"required":false,"description":"Filter by customer_id (comma-separated list). Fetches many records in one request instead of one request per id.","name":"filter[customer_id.in]","in":"query"},{"schema":{"type":"string","description":"Filter by customer_id (excluding a comma-separated list)"},"required":false,"description":"Filter by customer_id (excluding a comma-separated list)","name":"filter[customer_id.nin]","in":"query"},{"schema":{"type":"string","description":"Filter by order_id (exact match)."},"required":false,"description":"Filter by order_id (exact match).","name":"filter[order_id]","in":"query"},{"schema":{"type":"string","description":"Filter by order_id (greater than or equal)"},"required":false,"description":"Filter by order_id (greater than or equal)","name":"filter[order_id.gte]","in":"query"},{"schema":{"type":"string","description":"Filter by order_id (less than or equal)"},"required":false,"description":"Filter by order_id (less than or equal)","name":"filter[order_id.lte]","in":"query"},{"schema":{"type":"string","description":"Filter by order_id (comma-separated list). Fetches many records in one request instead of one request per id."},"required":false,"description":"Filter by order_id (comma-separated list). Fetches many records in one request instead of one request per id.","name":"filter[order_id.in]","in":"query"},{"schema":{"type":"string","description":"Filter by order_id (excluding a comma-separated list)"},"required":false,"description":"Filter by order_id (excluding a comma-separated list)","name":"filter[order_id.nin]","in":"query"},{"schema":{"type":"string","description":"Filter by order_item_id (exact match)."},"required":false,"description":"Filter by order_item_id (exact match).","name":"filter[order_item_id]","in":"query"},{"schema":{"type":"string","description":"Filter by order_item_id (greater than or equal)"},"required":false,"description":"Filter by order_item_id (greater than or equal)","name":"filter[order_item_id.gte]","in":"query"},{"schema":{"type":"string","description":"Filter by order_item_id (less than or equal)"},"required":false,"description":"Filter by order_item_id (less than or equal)","name":"filter[order_item_id.lte]","in":"query"},{"schema":{"type":"string","description":"Filter by order_item_id (comma-separated list). Fetches many records in one request instead of one request per id."},"required":false,"description":"Filter by order_item_id (comma-separated list). Fetches many records in one request instead of one request per id.","name":"filter[order_item_id.in]","in":"query"},{"schema":{"type":"string","description":"Filter by order_item_id (excluding a comma-separated list)"},"required":false,"description":"Filter by order_item_id (excluding a comma-separated list)","name":"filter[order_item_id.nin]","in":"query"},{"schema":{"type":"string","description":"Filter by subscription_id (exact match)."},"required":false,"description":"Filter by subscription_id (exact match).","name":"filter[subscription_id]","in":"query"},{"schema":{"type":"string","description":"Filter by subscription_id (greater than or equal)"},"required":false,"description":"Filter by subscription_id (greater than or equal)","name":"filter[subscription_id.gte]","in":"query"},{"schema":{"type":"string","description":"Filter by subscription_id (less than or equal)"},"required":false,"description":"Filter by subscription_id (less than or equal)","name":"filter[subscription_id.lte]","in":"query"},{"schema":{"type":"string","description":"Filter by subscription_id (comma-separated list). Fetches many records in one request instead of one request per id."},"required":false,"description":"Filter by subscription_id (comma-separated list). Fetches many records in one request instead of one request per id.","name":"filter[subscription_id.in]","in":"query"},{"schema":{"type":"string","description":"Filter by subscription_id (excluding a comma-separated list)"},"required":false,"description":"Filter by subscription_id (excluding a comma-separated list)","name":"filter[subscription_id.nin]","in":"query"},{"schema":{"type":"string","description":"Filter by paymentplan_id (exact match)."},"required":false,"description":"Filter by paymentplan_id (exact match).","name":"filter[paymentplan_id]","in":"query"},{"schema":{"type":"string","description":"Filter by paymentplan_id (greater than or equal)"},"required":false,"description":"Filter by paymentplan_id (greater than or equal)","name":"filter[paymentplan_id.gte]","in":"query"},{"schema":{"type":"string","description":"Filter by paymentplan_id (less than or equal)"},"required":false,"description":"Filter by paymentplan_id (less than or equal)","name":"filter[paymentplan_id.lte]","in":"query"},{"schema":{"type":"string","description":"Filter by paymentplan_id (comma-separated list). Fetches many records in one request instead of one request per id."},"required":false,"description":"Filter by paymentplan_id (comma-separated list). Fetches many records in one request instead of one request per id.","name":"filter[paymentplan_id.in]","in":"query"},{"schema":{"type":"string","description":"Filter by paymentplan_id (excluding a comma-separated list)"},"required":false,"description":"Filter by paymentplan_id (excluding a comma-separated list)","name":"filter[paymentplan_id.nin]","in":"query"},{"schema":{"type":"string","description":"Filter by payment_id (exact match)."},"required":false,"description":"Filter by payment_id (exact match).","name":"filter[payment_id]","in":"query"},{"schema":{"type":"string","description":"Filter by payment_id (greater than or equal)"},"required":false,"description":"Filter by payment_id (greater than or equal)","name":"filter[payment_id.gte]","in":"query"},{"schema":{"type":"string","description":"Filter by payment_id (less than or equal)"},"required":false,"description":"Filter by payment_id (less than or equal)","name":"filter[payment_id.lte]","in":"query"},{"schema":{"type":"string","description":"Filter by payment_id (comma-separated list). Fetches many records in one request instead of one request per id."},"required":false,"description":"Filter by payment_id (comma-separated list). Fetches many records in one request instead of one request per id.","name":"filter[payment_id.in]","in":"query"},{"schema":{"type":"string","description":"Filter by payment_id (excluding a comma-separated list)"},"required":false,"description":"Filter by payment_id (excluding a comma-separated list)","name":"filter[payment_id.nin]","in":"query"},{"schema":{"type":"string","description":"Filter by notification_id (exact match)."},"required":false,"description":"Filter by notification_id (exact match).","name":"filter[notification_id]","in":"query"},{"schema":{"type":"string","description":"Filter by notification_id (greater than or equal)"},"required":false,"description":"Filter by notification_id (greater than or equal)","name":"filter[notification_id.gte]","in":"query"},{"schema":{"type":"string","description":"Filter by notification_id (less than or equal)"},"required":false,"description":"Filter by notification_id (less than or equal)","name":"filter[notification_id.lte]","in":"query"},{"schema":{"type":"string","description":"Filter by notification_id (comma-separated list). Fetches many records in one request instead of one request per id."},"required":false,"description":"Filter by notification_id (comma-separated list). Fetches many records in one request instead of one request per id.","name":"filter[notification_id.in]","in":"query"},{"schema":{"type":"string","description":"Filter by notification_id (excluding a comma-separated list)"},"required":false,"description":"Filter by notification_id (excluding a comma-separated list)","name":"filter[notification_id.nin]","in":"query"},{"schema":{"type":"string","description":"Filter by created_at (exact match)."},"required":false,"description":"Filter by created_at (exact match).","name":"filter[created_at]","in":"query"},{"schema":{"type":"string","description":"Filter by created_at (greater than or equal)"},"required":false,"description":"Filter by created_at (greater than or equal)","name":"filter[created_at.gte]","in":"query"},{"schema":{"type":"string","description":"Filter by created_at (less than or equal)"},"required":false,"description":"Filter by created_at (less than or equal)","name":"filter[created_at.lte]","in":"query"},{"schema":{"type":"string","description":"Sort field (prefix with - for descending)"},"required":false,"description":"Sort field (prefix with - for descending)","name":"sort","in":"query"}],"responses":{"200":{"description":"Successful response with paginated list","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string","enum":["user","customer","system"]},"user_id":{"type":"integer","nullable":true},"account_id":{"type":"integer","nullable":true},"customer_id":{"type":"integer","nullable":true},"order_id":{"type":"integer","nullable":true},"subscription_id":{"type":"integer","nullable":true},"order_paymentplan_id":{"type":"integer","nullable":true},"order_item_id":{"type":"integer","nullable":true},"payment_id":{"type":"integer","nullable":true},"adjustment_id":{"type":"integer","nullable":true},"old_card_id":{"type":"integer","nullable":true},"new_card_id":{"type":"integer","nullable":true},"integration_id":{"type":"integer","nullable":true},"name":{"type":"string","nullable":true,"maxLength":255},"data":{"nullable":true},"notes":{"type":"string","nullable":true},"api_request_id":{"type":"integer","nullable":true},"notification_id":{"type":"integer","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time"},"updated_at":{"type":"string","nullable":true,"format":"date-time"},"name_label":{"type":"string","nullable":true}},"required":["id","type"]}},"pagination":{"type":"object","properties":{"page":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Current page number"},"limit":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Items per page"},"total":{"type":"integer","description":"Total number of items"},"pages":{"type":"integer","description":"Total number of pages"}},"required":["page","limit","total","pages"]}},"required":["data","pagination"]}}}},"401":{"description":"Unauthorized - Authentication is required or has failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"403":{"description":"Forbidden - You do not have permission to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403"}}}},"500":{"description":"Internal Server Error - An unexpected error occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}}}}}}}}
```
