FRfrontegg
Entitlements

Create Entitlement

Create a new entitlement

post/resources/entitlements/v2

Request

Request body

planIdstring required

UUID string that represents the plan ID

tenantIdstring required

UUID string that represents the tenant ID

userIdstring

UUID string that represents the user ID

expirationDatestring date-time

Date of entitlement expiration

Example request

{
  "planId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "tenantId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "userId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "expirationDate": "2022-01-01T12:00:00"
}

Response

idstring required

UUID string that represents the entitlement ID

planIdstring required

UUID string that represents the plan ID

tenantIdstring required

UUID string that represents the tenant ID

userIdstring

UUID string that represents the user ID

expirationDatestring date-time

Date of entitlement expiration

createdAtstring date-time required

Date when entitlement was created

updatedAtstring date-time

Date when entitlement was last updated

Example response

{
  "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "planId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "tenantId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "userId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "expirationDate": "2022-01-01T12:00:00",
  "createdAt": "2022-01-01T12:00:00",
  "updatedAt": "2022-01-01T12:00:00",
  "plan": {
    "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
    "vendorId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
    "name": "Test Plan",
    "description": "This is a test plan",
    "createdAt": "2022-01-01T00:00:00",
    "updatedAt": "2022-01-01T00:00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.