Skip to main content
POST
/
contracts
/
{id}
/
profit-shares
Create Profit Share
curl --request POST \
  --url https://v1.api.flux-os.com/contracts/{id}/profit-shares \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>' \
  --data '
{
  "paid_by": "<unknown>",
  "paid_to": "<unknown>",
  "settlement_currency": "<unknown>",
  "measurement_unit": "<unknown>",
  "value": 123
}
'
{
  "data": {
    "value": 123,
    "id": "<string>",
    "paid_by": {
      "name": "<string>",
      "id": "<string>",
      "image_url": null
    },
    "paid_to": {
      "name": "<string>",
      "id": "<string>",
      "image_url": null
    },
    "contract": {
      "external_id": "<string>",
      "id": "<string>"
    },
    "settlement_currency": {
      "name": "<string>",
      "symbol": "<string>",
      "id": "<string>"
    },
    "measurement_unit": {
      "name": "<string>",
      "abbreviation": "<string>",
      "id": "<string>",
      "html_symbol": null
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

x-api-key
string
header
required
x-user-id
string
header
required

Path Parameters

id
integer
required

The contract ID.

Body

application/json
paid_by
any
required
paid_to
any
required
settlement_currency
any
required
measurement_unit
any
required
value
number
required

Response

Profit share successfully created.

data
object