Chargebee

Add Chargebee Comment

Adds a note to a subscription, customer or invoice.

Unverified

What the model is told

Add an internal note to a Chargebee record, for example to log what the customer asked for. Set entityType to subscription, customer or invoice and entityId to its ID. Confirm anything you record with the customer first. The note is not sent to the customer.

Request

POSThttps://YOUR_CHARGEBEE_SITE.chargebee.com/api/v2/comments

Headers

  • Content-Typeapplication/x-www-form-urlencoded
  • AuthorizationBasic YOUR_BASE64_CHARGEBEE_API_KEY

Body

entity_type={{entityType}}&entity_id={{entityId}}&notes={{notes}}

Parameters

  • entityType stringThe kind of record: subscription, customer or invoice.
  • entityId stringThe ID of the record.
  • notes stringThe note text.

Engage payload

{
  "source": "VOICE_AI",
  "tool": {
    "id": "8d577e3c-4166-4294-8018-6c61417e8e2b",
    "type": "HTTP_REQUEST",
    "label": "Add Chargebee Comment",
    "name": "add_chargebee_comment",
    "customName": false,
    "description": "Add an internal note to a Chargebee record, for example to log what the customer asked for. Set entityType to subscription, customer or invoice and entityId to its ID. Confirm anything you record with the customer first. The note is not sent to the customer.",
    "parameters": [
      {
        "name": "entityType",
        "type": "string",
        "description": "The kind of record: subscription, customer or invoice."
      },
      {
        "name": "entityId",
        "type": "string",
        "description": "The ID of the record."
      },
      {
        "name": "notes",
        "type": "string",
        "description": "The note text."
      }
    ],
    "config": {
      "endpoint": {
        "method": "POST",
        "url": "https://YOUR_CHARGEBEE_SITE.chargebee.com/api/v2/comments"
      },
      "headers": [
        {
          "name": "Content-Type",
          "value": "application/x-www-form-urlencoded"
        },
        {
          "name": "Authorization",
          "value": "Basic YOUR_BASE64_CHARGEBEE_API_KEY"
        }
      ],
      "body": "entity_type={{entityType}}&entity_id={{entityId}}&notes={{notes}}",
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.