# Create a line item

Endpoint: POST /v1/entitlement/{entitlementId}/line-items
Version: 1.0.0_Beta

## Path parameters:

  - `entitlementId` (string, required)

## Request fields (application/json):

  - `lineItems` (array, required)

  - `lineItems.activationId` (string)
    Activation ID of the line item. If you specify the activation ID, then it must be unique across all entitlements and line items. If you specify the activation ID here, then the autoGenerate flag must be set to false
    Example: "act-id-1234"

  - `lineItems.product` (array, required)
    List of products entitled by this line item

  - `lineItems.product.productName` (string, required)
    Name of the product
    Example: "SampleProduct"

  - `lineItems.product.productVersion` (string, required)
    Version of the product
    Example: "SampleVersion-1.0"

  - `lineItems.product.licenseModel` (object)
    License model associated with the product

  - `lineItems.product.licenseModel.licenseModelName` (string, required)
    specify a name that uniquely identifies this license model
    Example: "LicenseModelName"

  - `lineItems.product.licenseModel.issuer` (string)
    specify who is issuing the license
    Example: "SampleLicenseIssuer"

  - `lineItems.product.licenseModel.serialNumber` (string)
    specify the serial number of the license
    Example: "SampleSerialno"

  - `lineItems.product.licenseModel.vendorString` (string)
    Unique value assigned by each publisher to each license
    Example: "uniqueVendorString"

  - `lineItems.product.licenseModel.notice` (string)
    This field is usually set at entitlement time and includes customer name and purchase order
    Example: "Premium Feature A"

  - `lineItems.quantity` (integer)
    Number of copies for the entitlement
    Example: 1

  - `lineItems.quantityPerCopy` (integer)

  - `lineItems.isActivatable` (boolean)
    Whether this line item is activatable

  - `lineItems.isPermanent` (boolean)
    Whether this line item is permanent. A permanent line item has no expiration date.

  - `lineItems.expiryDate` (string)
    End date of the line item in YYYY-MM-DD format
    Example: "2025-01-01"

  - `lineItems.startDate` (string, required)
    Start date of the line item in YYYY-MM-DD format
    Example: "2025-01-01"

  - `lineItems.attributes` (array)
    List of custom attributes related to the line item

  - `lineItems.attributes.name` (string)
    Name of the custom attribute
    Example: "REGION"

  - `lineItems.attributes.value` (object)
    Value assigned to the custom attribute. If the value is of type Date, then it should use yyyy/MM/dd format. Similarly, appropriate value corresponding to the type of custom attribute must be provided.
    Example: "EMEA"

  - `lineItems.autoGenerate` (boolean)
    Whether the activation ID should be auto-generated

  - `lineItems.autoDeploy` (boolean)
    Whether the Line item should be auto-deployed

  - `lineItems.orderType` (string)
    Type of order for the line item. The default is NEW_ORDER
    Enum: "new_order", "renewal_order", "upgrade_order", "upsell_order", "invalid_order"

  - `lineItems.lineItemStatus` (string)
    Enum: "draft", "deployed", "obsolete"

## Response 201 fields (application/json):

  - `status` (string)

## Response 400 fields (application/json):

  - `status` (string)

  - `message` (string)

## Response 500 fields (application/json):

  - `status` (string)

  - `message` (string)