Skip to main content
PATCH
/
contracts
/
{id}
/
premiums
/
{premium_id}
Update Premium
curl --request PATCH \
  --url https://v1.api.flux-os.com/contracts/{id}/premiums/{premium_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>' \
  --data '
{
  "amount": 123,
  "currency": "<unknown>",
  "paid_by": "<unknown>",
  "paid_to": "<unknown>",
  "name": "Premium",
  "measurement_unit": "<unknown>"
}
'
{
  "amount": 123,
  "id": "<string>",
  "contract": {
    "external_id": "<string>",
    "id": "<string>"
  },
  "name": "Premium",
  "currency": {
    "name": "<string>",
    "symbol": "<string>",
    "id": "<string>"
  },
  "measurement_unit": {
    "name": "<string>",
    "abbreviation": "<string>",
    "id": "<string>",
    "html_symbol": null
  },
  "paid_by": {
    "name": "<string>",
    "id": "<string>",
    "image_url": null
  },
  "paid_to": {
    "name": "<string>",
    "id": "<string>",
    "image_url": 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.

premium_id
integer
required

The premium ID.

Body

application/json
amount
number
required
currency
any
required
paid_by
any
required
paid_to
any
required
name
string
default:Premium
Maximum string length: 255
measurement_unit
any

Response

Premium updated.

amount
number
required
id
string
contract
object
name
string
default:Premium
Maximum string length: 255
currency
object
measurement_unit
object
paid_by
object
paid_to
object
created_at
string<date-time>
updated_at
string<date-time>