Get benefit

Returns a single benefit by its ID.

GET /v2/loyalties/benefits/{benefitId}

Get benefit

cURL

curl --request GET \
  --url https://{cluster}.voucherify.io/v2/loyalties/benefits/{benefitId} \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "id": "lben_128f4bba81947c8542",
  "name": "Coffee sample Ethiopia",
  "type": "MATERIAL",
  "status": "ACTIVE",
  "stock": {
    "type": "LIMITED",
    "limited": {
      "quantity": 495
    }
  },
  "material": {
    "type": "PRODUCT",
    "product": {
      "id": "prod_128f4baa45547c8530"
    }
  },
  "created_at": "2026-06-11T10:34:24.645Z",
  "updated_at": "2026-09-02T15:05:31.533Z",
  "object": "benefit"
}

Authorizations

X-App-Id & X-App-TokenbearerAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

benefitId · string · required

Unique benefit ID, prefixed with lben_.

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

Response

200

application/json

The benefit

Response body schema for GET /v2/loyalties/benefits/{benefitId}.

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

stock · object · required

Stock configuration. Always present. Null stock is returned as UNLIMITED with limited omitted.

Show child attributes

created_at · string<date-time> · required

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

updated_at · string<date-time> | null · required

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

object · string · required

Type of the object. Always benefit.

Allowed value: "benefit"

points · object

Fixed points configuration. Present only when type is POINTS.

Show child attributes

points_proportional · object

Proportional points configuration. Present only when type is POINTS_PROPORTIONAL.

Show child attributes

material · object

Material configuration. Present only when type is MATERIAL.

Show child attributes

digital · object

Digital configuration. Present only when type is DIGITAL.

Show child attributes