Skip to main content

Entitlement

Base path: /api/data/entitlement

All entitlement CRUD endpoints are registered but not yet implemented — handlers are empty stubs.

POST /api/data/entitlement

Create a new entitlement record.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.

Entitlement Schema Reference

FieldTypeRequiredDescription
tenantIdstringYesTenant identifier
userIdstringYesUser who owns the entitlement
orderIdstringYesAssociated order ID
productIdstringYesAssociated product ID
typeenumYesDISCORD_ROLE or DIGITAL_ITEM
roleIdstringNoDiscord role ID (for DISCORD_ROLE type)
statusenumNoPENDING (default), GRANTED, REVOKED, FAILED
metadataobjectNoArbitrary metadata (default {})
grantedAtdateNoTimestamp when the entitlement was granted
createdAtdateYesCreation timestamp
updatedAtdateYesLast update timestamp

GET /api/data/entitlement/:id

Retrieve an entitlement by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.


PATCH /api/data/entitlement/:id

Update an entitlement by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.


DELETE /api/data/entitlement/:id

Delete an entitlement by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.