Skip to main content
GET
/
v2
/
loyalties
/
benefits
/
{benefitId}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "object": "<string>",
  "stock": {
    "limited": {
      "quantity": 4503599627370495
    }
  },
  "points": {
    "value": 4503599627370495,
    "card_definition_id": "<string>"
  },
  "points_proportional": {
    "card_definition_id": "<string>",
    "order": {
      "amount": {
        "every": 4503599627370496,
        "value": 4503599627370495.5
      },
      "total_amount": {
        "every": 4503599627370496,
        "value": 4503599627370495.5
      },
      "metadata": {
        "every": 4503599627370496,
        "value": 4503599627370495.5,
        "property": "<string>"
      }
    },
    "customer": {
      "metadata": {
        "every": 4503599627370496,
        "value": 4503599627370495.5,
        "property": "<string>"
      }
    },
    "custom_event": {
      "metadata": {
        "every": 4503599627370496,
        "value": 4503599627370495.5,
        "property": "<string>"
      }
    },
    "order_items": {
      "amount": {
        "every": 4503599627370496,
        "value": 4503599627370495.5,
        "applicable_to": [
          {
            "product": {
              "id": "<string>"
            },
            "sku": {
              "id": "<string>"
            },
            "products_collection": {
              "id": "<string>"
            }
          }
        ]
      },
      "subtotal_amount": {
        "every": 4503599627370496,
        "value": 4503599627370495.5,
        "applicable_to": [
          {
            "product": {
              "id": "<string>"
            },
            "sku": {
              "id": "<string>"
            },
            "products_collection": {
              "id": "<string>"
            }
          }
        ]
      },
      "quantity": {
        "every": 4503599627370496,
        "value": 4503599627370495.5,
        "applicable_to": [
          {
            "product": {
              "id": "<string>"
            },
            "sku": {
              "id": "<string>"
            },
            "products_collection": {
              "id": "<string>"
            }
          }
        ]
      }
    }
  },
  "material": {
    "product": {
      "id": "<string>"
    },
    "sku": {
      "product_id": "<string>",
      "id": "<string>"
    }
  },
  "digital": {
    "gift_vouchers": {
      "campaign_id": "<string>",
      "balance": 4503599627370495.5
    },
    "discount_coupons": {
      "campaign_id": "<string>"
    }
  },
  "updated_at": "2023-11-07T05:31:56Z"
}
{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}
{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}
{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}
{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<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

Path Parameters

​
id
string
required

Unique benefit ID, prefixed with lben_.

Pattern: ^lben_[a-f0-9]+$

Response

The benefit

A benefit object. Exactly one type-specific configuration object (points, points_proportional, material, or digital) is present, matching the type; the others are omitted.

​
id
string
required

Unique benefit ID, prefixed with lben_.

Pattern: ^lben_[a-f0-9]+$
​
name
string
required

Benefit name, unique within the project.

​
type
enum<string>
required

Benefit type.

Available options:
POINTS,
POINTS_PROPORTIONAL,
MATERIAL,
DIGITAL
​
status
enum<string>
required

Current benefit status. DELETED appears only in the response of the delete endpoint and in activity snapshots.

Available options:
DRAFT,
ACTIVE,
DELETED
​
created_at
string<date-time>
required

Timestamp of when the benefit was created, in ISO 8601 format.

​
object
string
required

Type of the object. Always benefit.

Allowed value: "benefit"
​
stock
object

Stock configuration. Omitted when not set.

​
points
object

Fixed points configuration. Present only when type is POINTS.

​
points_proportional
object

Proportional points configuration. Present only when type is POINTS_PROPORTIONAL.

​
material
object

Material configuration. Present only when type is MATERIAL.

​
digital
object

Digital configuration. Present only when type is DIGITAL.

​
updated_at
string<date-time> | null

Timestamp of the last update, in ISO 8601 format. Null when the benefit was never updated.

Last modified on July 9, 2026