Sign in
Entitlements (partner/v2)

Create an Entitlement

Early Access Request Access To Partner v2

Make a request to create an entitlement.

post/partner/v2/entitlements

Request body

api_version'partner/v2'

APIVersion defines the schema version of this representation of a resource.

kind'Entitlement'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

external_idstring required

The unique external ID of the entitlement (this should be unique to customer)

namestring required

The name of the entitlement

plan_idstring required

The plan ID the entitlement

product_idstring required

The product ID of the entitlement

usage_reporting_idstring

The usage reporting ID of the entitlement (if usage reporting uses a different ID, otherwise, same as external_id)

resource_idstring

The resource ID of the entitlement

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de",
    "resource_name": "crn://confluent.cloud/kafka=lkc-f3a90de",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "external_id": "1111-2222-3333-4444",
  "name": "Acme Prod Entitlement",
  "plan_id": "confluent-cloud-payg-prod",
  "product_id": "confluent-cloud-kafka-service-azure",
  "usage_reporting_id": "1111-2222-3333-4444",
  "resource_id": "1111-2222-3333-4444"
}

Response

An Entitlement is being created.

api_version'partner/v2'

APIVersion defines the schema version of this representation of a resource.

kind'Entitlement'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

external_idstring required

The unique external ID of the entitlement (this should be unique to customer)

namestring required

The name of the entitlement

plan_idstring required

The plan ID the entitlement

product_idstring required

The product ID of the entitlement

usage_reporting_idstring

The usage reporting ID of the entitlement (if usage reporting uses a different ID, otherwise, same as external_id)

resource_idstring

The resource ID of the entitlement

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de",
    "resource_name": "crn://confluent.cloud/kafka=lkc-f3a90de",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "external_id": "1111-2222-3333-4444",
  "name": "Acme Prod Entitlement",
  "plan_id": "confluent-cloud-payg-prod",
  "product_id": "confluent-cloud-kafka-service-azure",
  "usage_reporting_id": "1111-2222-3333-4444",
  "resource_id": "1111-2222-3333-4444"
}

Changes

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