Get Trigger Items
List trigger billable items with auto-generated API samples
Returns all active trigger-type billable items for the organization. Each item includes a server-generated `api_sample` block showing exactly how to fire it, with parameters tailored to the item's trigger mode.
Requires a valid `api_key` in the JSON request body
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
api_key |
body | string |
Yes | Your Zyntro API key |
org_id |
body | string |
Yes | Your organization UUID |
brand_id |
body | string |
Yes | Your brand ID |
Code Samples
bash
curl -X POST https://app.zyntrohq.com/apis/public/edge/getItems.php \
-H "Content-Type: application/json" \
-d '{
"api_key": "your_api_key",
"org_id": "org_xxx",
"brand_id": "1"
}'Response
200
Trigger items returned
json
{
"data": [
{
"bi_id": "bi_xxx",
"bi_name": "Wallet Auto-Topup $200",
"api_sample": {
"body": {
"org_id": "org_xxx",
"api_key": "{your_api_key}",
"brand_id": "1",
"billable_item_id": "bi_xxx",
"billing_customer_id": "{bc_id}"
},
"endpoint": "POST /apis/public/edge/fire.php"
},
"bi_unit_price": 200,
"bi_capture_mode": "off_session",
"bi_trigger_mode": "fixed",
"bi_trigger_condition": "lte",
"bi_trigger_threshold": 15,
"bi_trigger_description": "When wallet balance <= $15, charge $200",
"bi_allow_amount_override": 0
}
],
"count": 4,
"status": "success"
}
Tip:
The `api_sample` block is generated server-side from the actual item record. It includes `override_amount` only if `bi_allow_amount_override` is true, and `metric_value` only if `bi_trigger_mode` is `threshold`.
