Milestone Automations

Retrieve milestone rules created via Automations

Get Merchant Milestone Configurations

Returns all milestone automation configurations for the authenticated merchant, grouped by milestone type.

Returns a paginated list of milestone configurations grouped by type.

Response Body

{
  "total": 3,
  "total_pages": 1,
  "page": 1,
  "merchant_milestones": {
    "spend": [
      {
        "id": 944,
        "status": "active",
        "name": "Gold Member",
        "created_at": "2025-03-21T15:22:56Z",
        "updated_at": "2026-02-05T21:48:34Z",
        "start_date_type": "absolute",
        "start_date": "2026-02-26T05:00:00Z",
        "threshold": 5000.0,
        "timeframe_days": 50
      }
    ],
    "visit": [
      {
        "id": 1192,
        "status": "active",
        "name": "Visit Gold",
        "created_at": "2026-02-05T21:46:06Z",
        "updated_at": "2026-02-05T21:46:58Z",
        "start_date_type": "all-time",
        "start_date": "2022-05-13T17:39:24Z",
        "threshold": 5.0,
        "timeframe_days": 10
      }
    ],
    "points": [
      {
        "id": 1194,
        "status": "active",
        "name": "Points Gold",
        "created_at": "2026-02-05T21:48:57Z",
        "updated_at": "2026-02-05T21:49:30Z",
        "start_date_type": "all-time",
        "start_date": "2022-05-13T17:39:24Z",
        "threshold": 400.0
      }
    ]
  }
}

Response Fields

Top-Level

Field	Type	Description
`total`	Integer	Total number of milestone configurations
`total_pages`	Integer	Total number of pages available
`page`	Integer	Current page
`merchant_milestones`	Object	Milestones grouped by type

`merchant_milestones`

Field	Type	Description
`spend`	Array	Spend-based milestone configurations
`visit`	Array	Visit-based milestone configurations
`points`	Array	Points-based milestone configurations

Milestone Object

Field	Type	Description
`id`	Integer	Unique milestone identifier
`status`	String	Milestone status (`active`) Disabled automations are not returned.
`name`	String	Display name of the milestone
`created_at`	String (ISO-8601)	Timestamp when the milestone was created
`updated_at`	String (ISO-8601)	Timestamp when the milestone was last updated
`start_date_type`	String	Determines how the start date is calculated
`start_date`	String (ISO-8601)	Effective start date used for milestone calculations
`threshold`	Number	Value required to complete the milestone
`timeframe_days`	Integer	Optional rolling timeframe (in days)

`start_date_type` Behavior

Value	Description
`absolute`	`start_date` reflects the date explicitly configured for the milestone
`all-time`	`start_date` reflects the merchant account creation date

Note: The start_date field always returns the effective date used for milestone calculations, regardless of start_date_type.

Error Responses

Status	Description
`401 Unauthorized`	Authentication required or invalid
`403 Forbidden`	Merchant context not permitted