PATCH
/
billableMetrics
/
{id}
curl --request PATCH \
  --url https://api.sulu.sh/v0/billableMetrics/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "unit": "<string>"
}'
{
  "id": "<string>",
  "object": "billableMetric",
  "name": "<string>",
  "description": "<string>",
  "merchantId": "<string>",
  "unit": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "aggregation": "SUM",
  "productId": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Unique identifier for a billable metric

Body

application/json
name
string
description
string
unit
string

Response

200
application/json
Billable metric updated successfully
id
string
object
enum<string>
default:billableMetric
Available options:
billableMetric
name
string
description
string
merchantId
string

Unique identifier for an organization

unit
string
createdAt
string
updatedAt
string
aggregation
enum<string>
Available options:
SUM,
MAX,
COUNT,
COUNT_UNIQUE
productId
string

Unique identifier for a product