Skip to main content
POST
/
v2
/
loyalties
/
examine
Examine Earnings
curl --request POST \
  --url https://api.voucherify.io/v2/loyalties/examine \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "event": "customer.order.paid",
  "customer_identification": {
    "type": "customer_id",
    "customer_id": "<string>",
    "customer_source_id": "<string>",
    "member_id": "<string>"
  },
  "customer_order_paid": {
    "customer": {
      "metadata": {}
    },
    "member": {
      "metadata": {}
    },
    "order": {
      "amount": 123,
      "initial_amount": 123,
      "discount_amount": 123,
      "metadata": {},
      "items": [
        {
          "id": "<string>",
          "source_id": "<string>",
          "product_id": "<string>",
          "sku_id": "<string>",
          "related_object": "product",
          "amount": 123,
          "discount_amount": 123,
          "quantity": 123,
          "price": 123,
          "product": {
            "id": "<string>",
            "source_id": "<string>",
            "price": 123
          },
          "sku": {
            "id": "<string>",
            "source_id": "<string>",
            "price": 123
          },
          "metadata": {}
        }
      ]
    }
  }
}
'
{
  "event": "<string>",
  "memberships": [
    {
      "member": {
        "id": "<string>",
        "customer_id": "<string>",
        "program_id": "<string>",
        "status": "ACTIVE",
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "object": "<string>"
      },
      "program": {
        "id": "<string>",
        "name": "<string>",
        "status": "DRAFT",
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "object": "<string>"
      },
      "cards": [
        {
          "card": {
            "id": "<string>",
            "card_definition_id": "<string>",
            "card_type": "<string>",
            "code": "<string>",
            "object": "<string>"
          },
          "points_estimation": 123
        }
      ],
      "incentives": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "DIGITAL",
          "status": "<string>",
          "object": "incentive"
        }
      ],
      "object": "member_earning_opportunity"
    }
  ],
  "object": "earnings_examine_result"
}

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

Body

application/json
​
event
string
required

Trigger event. Currently supported: customer.order.paid or order.paid.

Example:

"customer.order.paid"

​
customer_identification
object
required

Discriminated union identifying who is being evaluated.

​
customer_order_paid
object

Event-specific payload for customer.order.paid containing context for rule evaluation.

Response

Successful dry-run estimation.

​
event
string

The trigger event that was examined.

​
memberships
object[]

List of earning opportunities per active membership.

​
object
string
Example:

"earnings_examine_result"

Last modified on May 11, 2026