Enroll in Trigger Item
Link a billing customer to a trigger item for condition-driven charges
Creates a trigger enrollment linking a billing customer to a trigger billable item. Once enrolled, the trigger can be fired against this customer. Returns existing enrollment if already enrolled.
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 |
billing_customer_id |
body | string |
Yes | The billing customer to enroll |
billable_item_id |
body | string |
Yes | The trigger billable item to enroll in |
contact_id |
body | string |
Yes | The CRM contact UUID |
Code Samples
bash
curl -X POST https://app.zyntrohq.com/apis/public/edge/enroll.php \
-H "Content-Type: application/json" \
-d '{
"api_key": "your_api_key",
"org_id": "org_xxx",
"brand_id": "1",
"billing_customer_id": "bc_xxx",
"billable_item_id": "bi_xxx",
"contact_id": "cont_xxx"
}'Response
200
Enrollment created or existing returned
json
{
"data": {
"ts_dt": "2026-03-30 10:22:00",
"ts_id": "ts_xxx",
"ts_contid": "cont_xxx",
"ts_status": "active",
"ts_billable_item_id": "bi_xxx",
"ts_billing_customer_id": "bc_xxx",
"ts_consecutive_failures": 0
},
"ts_id": "ts_xxx",
"status": "success",
"existing": false
}
Info:
One active enrollment per billing customer per billable item. If already enrolled, the existing enrollment is returned with `existing: true`. To switch items, cancel the current enrollment and create a new one.
