Skip to main content
GET
/
companies
/
{company_id}
/
entitlements
/
{id}
Get Entitlement
curl --request GET \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/entitlements/{id} \
  --header 'Authorization: Bearer <token>'
{
  "aggregator_type": "<string>",
  "id": "<string>",
  "key": "<string>",
  "name": "<string>",
  "possible_values": [
    "<string>"
  ],
  "type": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

​
company_id
string
required

The company ID with the prefix 'cmp_'.

​
id
string
required

The resource ID

Response

200 - application/json

OK

​
aggregator_type
string

The aggregator type of the entitlement

​
id
string

The ID of the entitlement

​
key
string

The key of the entitlement

​
name
string

The name of the entitlement

​
possible_values
string[]

The possible values of the entitlement if the type is ENUM

​
type
string

The type of the entitlement that can be BOOL, TEXT, NUMBER or ENUM