Commission

What you earn, where to see it, and what the API does not tell you.

Where to see it

Your rates and your earnings are in your dashboard, not in this API:

  • Earnings lists what each settled order earned you, with totals for accrued, settled and reversed.
  • The same page shows your current rate per product.

There is no public API endpoint for either. Commission is a commercial arrangement between you and us, so your dashboard is the record and your agreement is the contract.

How it works

Rates are set per product: per distribution company for electricity, and per provider for airtime, data and cable TV. They are not one flat number across everything, and they can differ between two discos.

Commission accrues on an order that settles successfully. An order that fails or is refunded earns nothing, and a reversal appears against the original order rather than as a separate line.

Note

A rate can change. When it does, it applies to orders placed after the change, not retrospectively to ones already settled. If you cache rates in your own product to show a margin, re-read them rather than treating them as fixed.

What the order object does not carry

An order carries amount, which is what the order cost. It does not carry your commission, and neither does the order.settled webhook. If you need to show a figure per order in your own product, read it from the Earnings page or keep your own calculation from your agreed rate.

When a number looks wrong

Stop and ask. Send us the order reference and the X-Request-Id, and we will check it against our records. See Support.

Important

Do not settle a discrepancy by crediting your customer out of your own pocket and reconciling later. If an amount is wrong, we would rather find out while the records still make the answer obvious.