List Earning Rules

⚠️ BETA endpoint

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

Lists earning rules with optional filtering, ordering, and cursor-based pagination. Deleted earning rules are excluded.

GET /v2/loyalties/earning-rules

List Earning Rules

cURL

curl --request GET \
  --url https://api.voucherify.io/v2/loyalties/earning-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "earnings": [
        {
          "name": "<string>",
          "rules": {
            "logic": "<string>"
          },
          "effects": [
            {
              "points": {
                "value": 123,
                "card_definition_id": "<string>",
                "points_expiration": {
                  "rolling_expiration": {
                    "period": {
                      "value": 2
                    },
                    "rounding": {
                      "value": 6
                    }
                  },
                  "calendar_expiration": {
                    "expiration_dates": [
                      {
                        "day": 16,
                        "month": 6
                      }
                    ]
                  },
                  "sliding_expiration": {
                    "earning_activity": true,
                    "spending_activity": true,
                    "custom_activity": true,
                    "custom_activity_types": [
                      "<string>"
                    ],
                    "period": {
                      "value": 2
                    }
                  }
                }
              },
              "points_proportional": {
                "card_definition_id": "<string>",
                "order": {
                  "amount": {
                    "every": 123,
                    "value": 123
                  },
                  "total_amount": {
                    "every": 123,
                    "value": 123
                  },
                  "metadata": {
                    "every": 123,
                    "value": 123,
                    "property": "<string>"
                  }
                },
                "customer": {
                  "metadata": {
                    "every": 123,
                    "value": 123,
                    "property": "<string>"
                  }
                },
                "order_items": {
                  "amount": {
                    "every": 123,
                    "value": 123,
                    "applicable_to": [
                      {
                        "product": {
                          "id": "<string>"
                        },
                        "sku": {
                          "id": "<string>"
                        },
                        "products_collection": {
                          "id": "<string>"
                        }
                      }
                    ]
                  },
                  "subtotal_amount": {
                    "every": 123,
                    "value": 123,
                    "applicable_to": [
                      {
                        "product": {
                          "id": "<string>"
                        },
                        "sku": {
                          "id": "<string>"
                        },
                        "products_collection": {
                          "id": "<string>"
                        }
                      }
                    ]
                  },
                  "quantity": {
                    "every": 123,
                    "value": 123,
                    "applicable_to": [
                      {
                        "product": {
                          "id": "<string>"
                        },
                        "sku": {
                          "id": "<string>"
                        },
                        "products_collection": {
                          "id": "<string>"
                        }
                      }
                    ]
                  }
                },
                "points_expiration": {
                  "rolling_expiration": {
                    "period": {
                      "value": 2
                    },
                    "rounding": {
                      "value": 6
                    }
                  },
                  "calendar_expiration": {
                    "expiration_dates": [
                      {
                        "day": 16,
                        "month": 6
                      }
                    ]
                  },
                  "sliding_expiration": {
                    "earning_activity": true,
                    "spending_activity": true,
                    "custom_activity": true,
                    "custom_activity_types": [
                      "<string>"
                    ],
                    "period": {
                      "value": 2
                    }
                  }
                }
              },
              "incentive": {
                "id": "<string>"
              }
            }
          ]
        }
      ],
      "trigger": {
        "custom_event": {
          "schema_id": "<string>"
        },
        "segment": {
          "id": "<string>"
        }
      },
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "object": "<string>",
      "error": {
        "message": "<string>"
      },
      "validity_hours": {
        "daily": [
          {
            "days_of_week": [
              123
            ],
            "start_time": "<string>",
            "end_time": "<string>"
          }
        ]
      },
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "trigger_limits": {
        "cooldown": {
          "fixed_cooldown": {
            "period": {
              "value": 123
            }
          }
        },
        "frequency": {
          "limits": [
            {
              "type": "TIME_BASED",
              "period": {
                "type": "CURRENT_PERIOD",
                "current_period": {}
              },
              "triggers": {
                "max": 123
              }
            }
          ]
        }
      },
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "object": "<string>",
  "cursor": {
    "next": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-App-Id · string · header · required

X-App-Token · string · header · required

Query Parameters

filters[junction] · enum<string>

Logical junction for combining filter conditions.

Available options: AND, OR

filters[id][conditions][$is] · string

Filter by exact earning rule ID.

filters[id][conditions][$is_not] · string

Exclude earning rule by ID.

filters[id][conditions][$in] · string[]

Filter by earning rule IDs (up to 100).

filters[id][conditions][$not_in] · string[]

Exclude earning rule IDs (up to 100).

filters[name][conditions][$is] · string

Filter by exact name.

filters[name][conditions][$contains] · string

Filter by name containing substring.

filters[name][conditions][$starts_with] · string

Filter by name starting with prefix.

filters[status][conditions][$is] · enum<string>

Filter by exact status.

Available options: ACTIVE, INACTIVE, DRAFT

filters[status][conditions][$in] · enum<string>[]

Filter by statuses.

Available options: ACTIVE, INACTIVE, DRAFT

filters[created_at][conditions][$before] · string<date-time>

Filter by creation date before.

filters[created_at][conditions][$after] · string<date-time>

Filter by creation date after.

limit · integer · default: 10

Maximum number of results to return.

Required range: 1 <= x <= 100

order · enum<string> enum<string>[]

Sort order. Prefix with - for descending. Default is -created_at.

Available options: -created_at, created_at, name, -name

cursor · string

Cursor for pagination (obtained from previous response).

Response

200

application/json

List of earning rules.

data · object[] · required

Show child attributes

object · string · required

Allowed value: "list"

cursor · object | null

Cursor for fetching the next page of results.

Show child attributes