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>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}

Activate benefit

⚠️ BETA endpoint

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.

Moves a benefit from DRAFT to ACTIVE status. No request body. Only the DRAFT -> ACTIVE transition is allowed; activating from any other state returns 400 invalid_state_transition. A points-based benefit cannot be activated when its connected card definition does not exist or is not ACTIVE (423 resource_locked).

POST

loyalties

benefits

{benefitId}

activate

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>"
}

{
  "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

string

required

Unique benefit ID, prefixed with lben_.

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

Response

The activated 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.

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.

Show child attributes

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

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

Delete benefit Move benefit to draft

⌘I