Retrieve proposal commission

  • Proposals
  • Booking
  • 1 route
How can I retrieve the seller commission linked to a proposal?

This scenario explains how to retrieve the commission amount associated with a proposal before the booking is finalized. It helps expose the commercial margin attached to the current proposal state.

The response is intentionally concise and returns the commission total with its currency, which makes the route easy to integrate into seller dashboards or proposal review screens.

Overview

Use this scenario when you need to display or verify the commission attached to an existing proposal. The route is useful in seller contexts where proposal profitability must be checked before the next commercial action.

The scenario focuses on a direct read operation and does not modify the proposal.

Prerequisites

  • Have a valid x-api-key.
  • Have a valid bearer token.
  • Know the proposal_id returned by a previous proposal creation or proposal retrieval flow.

Functional notes

  • This scenario retrieves the commission attached to the current state of the proposal.
  • The response can be used as-is in a commercial summary card because it returns total and currency.
  • If the proposal does not exist anymore or is not visible in the current context, the route returns a not found or forbidden response.
1

Get proposal commission

Mandatory

This route returns the seller commission calculated for the targeted proposal.

Prerequisites

Use the proposal identifier and a valid authorization token. You may add filter if your implementation relies on filtered views.

Calling CURL

curl -X GET \
  -H "x-api-key: $API_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  "https://api.clubmed.com/v0/proposals/{proposal_id}/sales_commission?filter[status][_eq]=ACTIVE"

Example answer

{
  "total": 846,
  "currency": "EUR"
}

info: The returned amount is useful for a back-office display or a final commercial check before validation.

Response codes

  • 200 OK: the commission is returned.
  • 400 Bad Request: invalid parameters.
  • 401 Unauthorized: missing or invalid token.
  • 403 Forbidden: access denied.
  • 404 Not Found: proposal not found.
GET/v0/proposals/{proposal_id}/sales_commission
See more