Sign in

v18

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01934981.1 MB
Benefits

Create benefit

<Warning>

<Badge color="yellow">BETA endpoint</Badge>

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

</Warning>

Creates a new benefit. Exactly one type-specific configuration object (points, points_proportional, material, or digital) is required, matching the type. When status is omitted the benefit is created in DRAFT status. When stock is omitted it defaults to { "type": "UNLIMITED" }.

Referenced resources are validated: the card definition (for points-based types) must exist and - when creating with status: ACTIVE - must be ACTIVE (423 resource_locked otherwise); the product/SKU (for MATERIAL) and campaign (for DIGITAL) must exist, and the campaign type must match the digital benefit type (DISCOUNT_COUPONS or GIFT_VOUCHERS). The benefit name must be unique per project (409 duplicate_found).

post/v2/loyalties/benefits

Request body

namestring required

Benefit name. Must be unique within the project.

type'POINTS' | 'POINTS_PROPORTIONAL' | 'MATERIAL' | 'DIGITAL' required

Benefit type. Determines which configuration object is required.

status'DRAFT' | 'ACTIVE'

Initial status of the benefit. Defaults to DRAFT when omitted.

Response

The created benefit

idstring required

Unique benefit ID, prefixed with lben_.

namestring required

Benefit name, unique within the project.

type'POINTS' | 'POINTS_PROPORTIONAL' | 'MATERIAL' | 'DIGITAL' required

Benefit type.

status'DRAFT' | 'ACTIVE' | 'DELETED' required

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

created_atstring date-time required

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

updated_atstring date-time nullable

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

object'benefit' required

Type of the object. Always benefit.