Spending Plan - MX Documentation

Spending Plan webhooks notify you when a spending plan is created, updated, or deleted in the MX system for any user in the client. The payload for this webhook includes an action field that specifies the associated value of created, updated, or deleted.

Field	Data Type	Description
`created_at`	Integer	The date and time when the spending plan was created. Given in Unix epoch time.
`current_iteration_number`	Integer	The current active associated `spending_plan_iteration` number for a given `spending_plan`.
`guid`	String	The unique identifier for the spending plan. Defined by MX.
`updated_at`	Integer	The date and time when the spending plan was last updated. Given in Unix epoch time.
`user_guid`	String	The unique identifier for the user. Defined by MX.
`user_id`	String	The unique partner-defined identifier for the user.

Example Payload

JSON

{
  "action": "created",
  "spending_plan": {
    "created_at": 1687274271,
    "current_iteration_number": 1,
    "guid": "SPL-5af2c645-11ba-4435-8d5f-a1908c75d97d",
    "updated_at": 1687274271,
    "user_guid": "USR-c7981fb7-233a-466c-bffa-87c64654eae4",
    "user_id": "usr-1234-abcd"
  }
}   