Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Earning Rules

Create earning rule

<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 earning rule. When status is omitted the rule is created as DRAFT. When validity_hours is omitted it defaults to { "type": "ANY_TIME" }. When trigger_limits is omitted it defaults to { "cooldown": { "type": "NO_COOLDOWN" }, "frequency": { "type": "NO_LIMIT" } }.

post/v2/loyalties/earning-rules

Request body

namestring required

Earning rule name.

status'DRAFT' | 'ACTIVE'

Initial status. Only DRAFT and ACTIVE are allowed at creation. Defaults to DRAFT.

start_datestring date-time

Date-time from which the rule is active. Nullable.

end_datestring date-time

Date-time until which the rule is active. Nullable.

metadataEarningRuleMetadata

Arbitrary key-value metadata; any JSON object is accepted.

Response

Earning rule created

idstring

Earning rule ID (lern_...).

namestring

Earning rule name.

status'DRAFT' | 'ACTIVE' | 'INACTIVE'

Current status. DELETED also exists internally but deleted rules are excluded from API reads.

start_datestring date-time

Date-time from which the rule is active. Nullable.

end_datestring date-time

Date-time until which the rule is active. Nullable.

metadataEarningRuleMetadata

Arbitrary key-value metadata; any JSON object is accepted.

created_atstring date-time

Creation timestamp (ISO 8601).

updated_atstring date-time

Last update timestamp (ISO 8601). Null when never updated.

objectstring

Object type marker. Always earning_rule.