Skip to main content
GET
/
v2
/
loyalties
/
earning-rules
List Earning Rules
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>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "DRAFT",
      "earnings": [
        {
          "name": "<string>",
          "rules": {
            "logic": "<string>"
          },
          "effects": [
            {
              "type": "POINTS",
              "points": {
                "value": 123,
                "card_definition_id": "<string>",
                "points_expiration": {
                  "type": "NO_EXPIRATION",
                  "rolling_expiration": {
                    "period": {
                      "value": 2,
                      "unit": "DAY"
                    },
                    "rounding": {
                      "type": "END_OF_MONTH",
                      "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,
                      "unit": "DAY"
                    }
                  }
                }
              },
              "points_proportional": {
                "calculation_type": "PRE_DISCOUNT_ORDER_AMOUNT",
                "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": [
                      {
                        "type": "product",
                        "product": {
                          "id": "<string>"
                        },
                        "sku": {
                          "id": "<string>"
                        },
                        "products_collection": {
                          "id": "<string>"
                        }
                      }
                    ]
                  },
                  "subtotal_amount": {
                    "every": 123,
                    "value": 123,
                    "applicable_to": [
                      {
                        "type": "product",
                        "product": {
                          "id": "<string>"
                        },
                        "sku": {
                          "id": "<string>"
                        },
                        "products_collection": {
                          "id": "<string>"
                        }
                      }
                    ]
                  },
                  "quantity": {
                    "every": 123,
                    "value": 123,
                    "applicable_to": [
                      {
                        "type": "product",
                        "product": {
                          "id": "<string>"
                        },
                        "sku": {
                          "id": "<string>"
                        },
                        "products_collection": {
                          "id": "<string>"
                        }
                      }
                    ]
                  }
                },
                "points_expiration": {
                  "type": "NO_EXPIRATION",
                  "rolling_expiration": {
                    "period": {
                      "value": 2,
                      "unit": "DAY"
                    },
                    "rounding": {
                      "type": "END_OF_MONTH",
                      "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,
                      "unit": "DAY"
                    }
                  }
                }
              },
              "incentive": {
                "id": "<string>"
              }
            }
          ]
        }
      ],
      "trigger": {
        "event": "customer.order.paid",
        "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": {
          "type": "NO_COOLDOWN",
          "fixed_cooldown": {
            "period": {
              "value": 123,
              "unit": "HOUR"
            }
          }
        },
        "frequency": {
          "type": "NO_LIMIT",
          "limits": [
            {
              "type": "TIME_BASED",
              "period": {
                "type": "CURRENT_PERIOD",
                "current_period": {
                  "unit": "DAY"
                }
              },
              "triggers": {
                "max": 123
              }
            }
          ]
        }
      },
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "object": "<string>",
  "cursor": {
    "next": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt

Use this file to discover all available pages before exploring further.

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

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

List of earning rules.

​
data
object[]
required
​
object
string
required
Allowed value: "list"
​
cursor
object

Cursor for fetching the next page of results.

Last modified on May 11, 2026