Skip to content

Latest commit

 

History

History
25 lines (21 loc) · 9.86 KB

File metadata and controls

25 lines (21 loc) · 9.86 KB

UpdateCommissionResponseBody

The updated commission.

Fields

Field Type Required Description Example
id str ✔️ The commission's unique ID on Dub. cm_1JVR7XRCSR0EDBAF39FZ4PMYE
type operations.UpdateCommissionType ✔️ The type of commission. Can be click, lead, sale, referral, or custom.
amount float ✔️ The associated event amount in cents. For sale commissions, this is the sale amount.
earnings float ✔️ The amount earned by the partner, in cents.
currency str ✔️ The currency of the commission, as an ISO 4217 currency code.
status operations.UpdateCommissionStatus ✔️ The current status of the commission.
invoice_id Nullable[str] ✔️ The associated invoice ID. Only set for sale commissions.
description Nullable[str] ✔️ An optional description of the commission.
quantity float ✔️ The event quantity. Used for click and lead commissions; typically 1 for sale and custom commissions.
user_id OptionalNullable[str] ➖ The user who created the manual commission.
metadata Dict[str, Any] ✔️ User-provided metadata from the associated lead or sale event (lead.metadata / sale.metadata).
created_at str ✔️ The date and time when the commission was created.
updated_at str ✔️ The date and time when the commission was last updated.
paid_at Nullable[str] ✔️ The date the commission was paid out to the partner. Null if not paid yet.
partner operations.UpdateCommissionPartner ✔️ N/A
customer OptionalNullable[operations.UpdateCommissionCustomer] ➖ N/A