Create Contract Line Item Mutation

CreateContractLineItem mutation request

curl -X POST \
  -H "Content-Type: application/json" \
  -H "X-CUSTOMER-OS-API-KEY: <MY_API_KEY_HERE>" \
  -d '{
    "query": "mutation CreateContractLineItem { 
      contractLineItem_Create(input: { 
        contractId: \"96d699a8-b986-4dae-9f10-a23196f30c90\", 
        description: "My Fantastic Product",
        quantity: 10,
        price: 100.00,
        billingCycle: "MONTHLY",
        serviceEnded: "2024-01-26T00:00:00Z",
        serviceStarted: "2024-01-26T00:00:00Z",
        tax: {
          vat: true,
          salesTax: false,
          taxRate: 0.20
        }
      }) {
        metadata {
          id
        } 
      } 
    }"
  }' 
  https://cos.customeros.ai/query

The contractLineItem mutation request requires that you pass the contract contractId as a query parameter.

As this is a graphQL request, you are able to specify the exact payload you would like returned in the response. In the example above, we’ve specified that only id is returned, but you can choose from any of the response parameters defined in the contractLineItem object

CreateContractLineItem mutation response

"data": {
    "contractLineItem_Update": {
        "metadata": {
            "id": "96d699a8-b986-4dae-9f10-a23196f30c90",
        }
    }
}