Create Benefit Grant

Authorization

HTTPBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

user_id*string

ID of the user receiving the benefit.

benefit_id*string

ID of the benefit being granted.

starts_at?|

Grant start timestamp. Defaults to current time if omitted.

expires_at?|

Configured end timestamp for the grant window. If null, never expires.

value_initial*integer

Initial meter value at grant creation.

Response Body

`application/json`

curl -X POST "https://api.members.dev/v1/grants" \  -H "Content-Type: application/json" \  -d '{    "user_id": "string",    "benefit_id": "string",    "value_initial": 0  }'

{
  "id": "bgt_01KKSMB47VYGW97GFE67VGDK7M",
  "user_id": "string",
  "benefit_id": "string",
  "status": "scheduled",
  "starts_at": null,
  "expires_at": {},
  "value_initial": 0,
  "value_current": 0,
  "value_consumed": 0,
  "parent": {
    "benefit_schedule_id": "string",
    "subscription_id": "string",
    "product_id": "string"
  },
  "state_transitions": {
    "started_at": {},
    "expired_at": {},
    "depleted_at": {},
    "revoked_at": {}
  },
  "next_update": {
    "updates_at": null,
    "update_type": "starts"
  },
  "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`