Represents an Account
Whether this account is the current owner of the entitlement in the distribution chain
ID of the account
The name of the account
Type of the account. Valid types are PUBLISHER, CUSTOMER, CHANNEL_PARTNER, SELF_REGISTERED, UNKNOWN
Email address of the Contact in the account
Partner tier of the account owning the entitlement. Valid values are END_CUSTOMER and PARTNER_TIER_ONE
{ "CurrentOwner": true, "accountId": "Example String", "accountName": "Example String", "accountType": "CHANNEL_PARTNER", "contactEmail": "Example String", "partnerTierName": "END_CUSTOMER" }
Represents a Custom Attribute
Name of the custom attribute
The value of the custom attribute. If the value is a date-type, use format yyyy/MM/dd
{ "name": "Example String", "value": "Example String" }
Represents an update to a custom attribute
Name of the custom attribute to be updated
Value of the custom attribute
{ "name": "Example String", "type": "LICENSE_MODEL", "value": "Example String" }
Input to create an entitlement
List of accounts associated with the entitlement. If account is not provided, the entitlement will be associated with UNKNOWN_ORG_UNIT(default account).
Whether the customer can use the entitlement ID to log into the End-User Portal after the entitlement is deployed
List of entitlement custom attributes. Note that mandatory custom attributes must be included in this list
Flag to indicate if the entitlement should be auto-deployed
Whether the entitlement ID is to be auto-generated.
Description of the entitlement
Name of the email template to be used for entitlement related emails
The ID of the entitlement. This is to be specified if you want to generate the entitlement ID yourselves. This means that the autoGenerate flag below is set to false. If the ID matches that of an existing entitlement or line item, then operation will fail.
List of line items contained in the entitlement
Address of the ship-to contact
Email address of the ship-to contact
{ "accounts": [ { "__typename": "AccountInput" } ], "allowPortalLogin": true, "attributes": [ { "__typename": "AttributeInput" } ], "autoDeploy": true, "autoGenerate": true, "description": "Example String", "emailTemplateVariation": "Example String", "entitlementId": "Example String", "lineItems": [ { "__typename": "LineItemInput" } ], "shipToAddress": "Example String", "shipToEmail": "Example String" }
Input to create a new line item
List of line item input objects
{ "lineItems": [ { "__typename": "LineItemInput" } ] }
Represents a License Model
specify who is issuing the license
specify a name that uniquely identifies this license model
This field is usually set at entitlement time and includes customer name and purchase order
specify the serial number of the license
Unique value assigned by each publisher to each license
{ "issuer": "Example String", "licenseModelName": "Example String", "notice": "Example String", "serialNumber": "Example String", "vendorString": "Example String" }
Represents a line item in the entitlement
Flag to indicate whether this line item is activatable
The activation ID associated with the line item. You may specify this while creation. If you choose to specify this then the autoGenerate flag should be set to false. If the activationID specified, matches with any existing entitlementID or activationID, then you will get an error
List of custom attributes related to the line item
Whether the Line item should be auto-deployed
Whether the activation ID should be auto-generated
End date of the line item in YYYY-MM-DD format
Type of order for the line item. The default is NEW_ORDER
Whether this line item is permanent. A permanent line item has no expiration date.
List of products entitled by this line item
Number of copies for the entitlement
Quantity per copy. Minimum value is 1
Start date of the line item in YYYY-MM-DD format
{ "activatable": true, "activationId": "Example String", "attributes": [ { "__typename": "AttributeInput" } ], "autoDeploy": true, "autoGenerate": true, "expiryDate": "Example String", "orderType": "INVALID_ORDER", "permanent": true, "product": [ { "__typename": "ProductInput" } ], "quantity": 40, "quantityPerCopy": 40, "startDate": "Example String" }
Represents the properties of a line item that can be updated
Activation ID of the line item for which attributes has to be updated.
List of custom attributes related to the line item and license model
Whether the line item is to be deployed or not. This is used to update the deployment status of the line item
Order type can have values like 'New_Order', 'Renewal_Order', 'Upgrade_Order' and Upsell_Order This is used to identify the type of order for the line item.
Parent Line Item Activation ID. This is used to update the parent line item when the line item is a child of another line item.
Product related to the line item
{ "activationId": "Example String", "attributes": [ { "__typename": "AttributeUpdateInput" } ], "deploy": true, "orderType": "INVALID_ORDER", "parentActivationId": "Example String", "product": { "__typename": "UpdateProductInput" } }