---
title: "Get Earning Rules"
method: GET
path: "/stores/{subscriberId}/loyalty/earning_rules"
tags: ["loyalty"]
---

# Get Earning Rules

`GET /stores/{subscriberId}/loyalty/earning_rules`

## Request

- Base URL: `https://api.okendo.io/enterprise`
- URL: `https://api.okendo.io/enterprise/stores/{subscriberId}/loyalty/earning_rules`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/okendo/apis/okendo-enterprise-api/docs/stores/:subscriberId/loyalty/earning_rules/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `subscriberId` string, required

## Headers

- `okendo-api-version` '2025-02-01', required
- `okendo-partner-id` string

## Response `200`

A list of earning rules

- object
  - `earningRules` object[]
    - `earningRuleId` string, uuid, required: Unique identifier for the earning rule
    - `action` 'sign-up' | 'anniversary' | 'birthday' | 'custom-fixed' | 'custom-points-per' | 'purchase' | 'answer-question' | 'referral-invite' | 'submit-review' | 'facebook-like' | 'facebook-share' | 'instagram-follow' | 'tiktok-follow' | 'twitter-follow' | 'twitter-post' | 'submit-survey', required: The specific action that triggers this earning rule
    - `actionCategory` 'account' | 'custom' | 'order' | 'profile-question' | 'referral' | 'review' | 'social' | 'survey', required: The category of action for this earning rule
    - `actionLink` string, uri: URL link for custom actions
    - `dateComponentsToCapture` 'day-month' | 'day-month-year': The parts of the date to capture in order to complete this rule (valid on birthday action only)
    - `icon` union, required: Icon for the earning rule - either a FontAwesome icon name or custom image
      - string: FontAwesome icon name
      - object: Icon object with URL and dimensions
        - `url` string, uri, required: URL of the custom icon image
        - `width` integer, required: Width of the icon image in pixels
        - `height` integer, required: Height of the icon image in pixels
    - `imageUrl` string, uri: Image URL for the earning rule
    - `pointsPerText` string: Text description for points-per rewards. In the format 'x points per {pointsPerText}'
    - `promotion` object: Associated promotion details if applicable
      - `promotionId` string, uuid, required: Unique identifier for the promotion
      - `title` string, required: Display title for the promotion
      - `description` string, required: Description of the promotion
      - `type` 'fixed-point' | 'point-multiplier', required: Type of promotion - fixed-point adds a fixed number of points, point-multiplier multiplies earned points
      - `value` number, required: The promotion value - either fixed points to add or multiplier factor
      - `icon` union, required: Icon for the promotion - either a FontAwesome icon name or custom image
        - string: FontAwesome icon name
        - object: Icon object with URL and dimensions
          - `url` string, uri, required: URL of the custom icon image
          - `width` integer, required: Width of the icon image in pixels
          - `height` integer, required: Height of the icon image in pixels
      - `dateStart` string, date-time, required: ISO date-time string when the promotion starts
      - `dateEnd` string, date-time: ISO date-time string when the promotion ends (optional for ongoing promotions)
      - `appliesToEarningRules` string[], required: Array of earning rule IDs that this promotion applies to
      - `eligibleVipTiers` string[]: Array of VIP tier IDs that are eligible for this promotion (optional - if not specified, applies to all tiers)
    - `socialPageLink` string, uri: Social media page link for social actions
    - `title` string, required: Display title for the earning rule
    - `reward` union, required: Reward configuration for this earning rule
      - object
        - `type` 'fixed-amount', required
        - `amount` integer, required: Number of points awarded
      - object
        - `type` 'points-per', required
        - `amount` number, required: Points awarded per unit
      - object
        - `type` 'points-per-spend', required
        - `amount` number, required: Points awarded per currency unit spent
        - `waitTimeDays` integer: Waiting period in days before points are awarded
      - object
        - `type` 'submit-review', required
        - `amountForReview` integer, required: Points awarded for submitting a review
        - `amountForSocialLogin` integer, required: Points awarded for social login during review
        - `amountForImage` integer, required: Points awarded for including an image in review
        - `amountForVideo` integer, required: Points awarded for including a video in review
        - `capPerOrder` integer, required: Maximum points that can be earned per order
        - `earnEachAmountOncePer` 'order' | 'review', required: Whether each amount can be earned once per order or per review

---

[API](https://skmtc.dev/okendo/apis/okendo-enterprise-api.md) - [All operations](https://skmtc.dev/okendo/apis/okendo-enterprise-api/llms.txt) - [OpenAPI document](https://skmtc.dev/okendo/apis/okendo-enterprise-api/revisions/dd4c80ed1613?raw)