Skip to main content
GET
/
signup_programs
curl https://api.thanxsandbox.com/signup_programs \
  -X GET \
  -H "Content-Type: application/json" \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "X-ClientId: ${client_id}"

{
  "programs": [
    {
      "id": "awe833ke24",
      "merchant_id": "ghwou3457f",
      "name": "Welcome Reward",
      "handle": "welcome-reward",
      "redeem": {
        "type": "manual",
        "text": "$5 off your next purchase",
        "detail": "Use this reward on your next visit",
        "window": 60,
        "venue": "all"
      }
    }
  ]
}
This endpoint returns a list of active signup programs (earn_intro_premium) that are available for the merchant. These programs are typically displayed to users during the signup flow.
This endpoint is publicly accessible and does not require authentication. Programs are filtered based on the OAuth application context.

​
Response

​
id
string
Program ID
​
merchant_id
string
Merchant ID
​
name
string
Program name (reward template name or program name)
​
handle
string
URL-friendly handle for the program
​
redeem
object
Details of how the reward can be redeemed
curl https://api.thanxsandbox.com/signup_programs \
  -X GET \
  -H "Content-Type: application/json" \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "X-ClientId: ${client_id}"

{
  "programs": [
    {
      "id": "awe833ke24",
      "merchant_id": "ghwou3457f",
      "name": "Welcome Reward",
      "handle": "welcome-reward",
      "redeem": {
        "type": "manual",
        "text": "$5 off your next purchase",
        "detail": "Use this reward on your next visit",
        "window": 60,
        "venue": "all"
      }
    }
  ]
}