Create benefit usage

Authorization

HTTPBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

timestamp?|

Unix timestamp in seconds. If omitted, defaults to ingestion current time.

external_id?|

Optional idempotency key provided by external systems.

user_id?|

Internal user ID for this usage. At least one of user_id and external_user_id must be set. Only one may be set (not both).

external_user_id?|

External user ID for this usage. At least one of user_id and external_user_id must be set. Only one may be set (not both).

benefit_usage_kind*string

Discriminator: record meter (numeric) consumption against grants.

benefit_id?|

Benefit ID. For meter, provide this and/or meter_event_name.

meter_event_name?|

Resolves the meter benefit when benefit_id is omitted (must match benefits.meter_event_name).

benefit_grant_id?|

Prefer allocation against this open grant before other grants.

value*integer

Meter amount consumed (integer).

Response Body

`application/json`

curl -X POST "https://api.members.dev/v1/benefit-usages" \  -H "Content-Type: application/json" \  -d '{    "benefit_usage_kind": "meter",    "value": 0  }'

{
  "id": "string",
  "timestamp": 0,
  "benefit_id": "string",
  "benefit_grant_id": "string",
  "payload": {
    "value": 0
  },
  "external_id": "string",
  "user_id": "string",
  "external_user_id": "string",
  "amount_allocated": 0,
  "allocation_status": "unallocated",
  "created_at": null,
  "updated_at": null
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Authorization

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`