tolt.js
Guides / How To
Customers
Clicks
Commissions
Transactions
Create Commission
This endpoint creates a commission.
curl -X POST 'https://api.tolt.com/v1/commissions' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"amount": 1999,
"customer_id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
"transaction_id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
"charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
"source": "stripe",
"status": "pending",
"revenue": 9999,
"created_at": "2025-01-15T14:30:00.000Z"
}'
{
"success": true,
"data": [
{
"id": "comm_eK9bzRGn46BhVgNFHD6fDgXW",
"revenue": null,
"charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
"charge_status": null,
"source": "stripe",
"status": "pending",
"type": null,
"currency": null,
"program_id": "prg_YRsbPDAKhWfdqJbFACheh",
"organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
"transaction_id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
"customer_id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
"payout_id": null,
"created_at": "2025-01-15T14:30:00.000Z",
"updated_at": "2025-01-15T14:30:00.000Z",
"amount": "1999",
"scheduled_approval_date": null,
"approval_type": "manual",
"flow_id": null
}
]
}
Base URL https://api.tolt.com
Body Parameters
The commission amount in cents
The ID of the customer associated with this commission
Associated transaction identifier
Associated charge identifier
Source of the commission
Commission status. Valid values are: ‘pending’, ‘approved’, ‘paid’, ‘rejected’, ‘refunded’
The revenue amount in cents
ISO 8601 timestamp of when the commission was created
Response
Whether the request was successful
Unique identifier for the commission
Commission amount in cents
ID of the associated customer
Associated transaction identifier
Associated charge identifier
Status of the related charge (e.g. “paid”, “failed”)
Source of the commission
Commission status
Type of commission (e.g. “reward”, “referral”)
Currency of the commission (ISO currency code) or null if not set
Revenue amount in cents
ISO 8601 timestamp of creation
ISO 8601 timestamp of update
ID of the partner who earned the commission
Program ID the commission belongs to
Organization ID
ID of the payout if the commission has been paid, otherwise null
Scheduled approval date if applicable, otherwise null
Approval type for the commission (e.g. “immediate”, “manual”)
ID of the flow that generated the commission
curl -X POST 'https://api.tolt.com/v1/commissions' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"amount": 1999,
"customer_id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
"transaction_id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
"charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
"source": "stripe",
"status": "pending",
"revenue": 9999,
"created_at": "2025-01-15T14:30:00.000Z"
}'
{
"success": true,
"data": [
{
"id": "comm_eK9bzRGn46BhVgNFHD6fDgXW",
"revenue": null,
"charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
"charge_status": null,
"source": "stripe",
"status": "pending",
"type": null,
"currency": null,
"program_id": "prg_YRsbPDAKhWfdqJbFACheh",
"organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
"transaction_id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
"customer_id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
"payout_id": null,
"created_at": "2025-01-15T14:30:00.000Z",
"updated_at": "2025-01-15T14:30:00.000Z",
"amount": "1999",
"scheduled_approval_date": null,
"approval_type": "manual",
"flow_id": null
}
]
}
curl -X POST 'https://api.tolt.com/v1/commissions' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"amount": 1999,
"customer_id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
"transaction_id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
"charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
"source": "stripe",
"status": "pending",
"revenue": 9999,
"created_at": "2025-01-15T14:30:00.000Z"
}'
{
"success": true,
"data": [
{
"id": "comm_eK9bzRGn46BhVgNFHD6fDgXW",
"revenue": null,
"charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
"charge_status": null,
"source": "stripe",
"status": "pending",
"type": null,
"currency": null,
"program_id": "prg_YRsbPDAKhWfdqJbFACheh",
"organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
"transaction_id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
"customer_id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
"payout_id": null,
"created_at": "2025-01-15T14:30:00.000Z",
"updated_at": "2025-01-15T14:30:00.000Z",
"amount": "1999",
"scheduled_approval_date": null,
"approval_type": "manual",
"flow_id": null
}
]
}