Skip to main content
POST
Create commission

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
amount
integer
required

The amount of the commission, in the currency's smaller unit (eg. cents).

currency
string
required

The currency ISO code of the commission

customer_id
string
required

The ID of the organization for which this commission will be billed. It must have a billing schedule attached

tax_inclusive
boolean
required

Whether the amount is tax inclusive or not

Response

successful

A billing cycle defines how and when commissions or purchase orders are aggregated and invoices are generated. You can subscribe multiple suppliers and customers to a given billing cycle

id
string
livemode
boolean
object
enum<string>
Available options:
commission
amount
integer

The amount of the commission, in the currency's smaller unit (eg. cents).

billing_schedule_id
string

The ID of the billing_schedule this commission is part of

currency
string

The currency ISO code of the commission

customer_id
string

The ID of the organization to which this commission is billed

document_id
string | null

The ID of the invoice or the credit note this commission is part of. Null if the commission has not been billed yet. See status for more information

status
enum<string>

The status of the commission

Available options:
pending,
billed
supplier_id
string

The ID of the organization that bills this commission

tax_inclusive
boolean

Whether the amount is tax inclusive or not

created_at
string<date-time>
updated_at
string<date-time>