Chargebee

Get Chargebee Subscription

Checks the status and renewal date of one subscription by its ID.

Unverified

What the model is told

Look up a Chargebee subscription by its ID. Use it when the customer asks about their plan status, next billing date or renewal. Report the status (active, paused, non_renewing, cancelled and so on) and next_billing_at. Confirm the customer is who they say they are before sharing details. The response also includes customer and card objects. Never read out card details, addresses or any contact information.

Request

GEThttps://YOUR_CHARGEBEE_SITE.chargebee.com/api/v2/subscriptions/{{subscriptionId}}

Headers

  • AuthorizationBasic YOUR_BASE64_CHARGEBEE_API_KEY

Parameters

  • subscriptionId stringThe Chargebee subscription ID.

Engage payload

{
  "source": "VOICE_AI",
  "tool": {
    "id": "0dc063e6-74b8-432d-8945-4502b5b542ee",
    "type": "HTTP_REQUEST",
    "label": "Get Chargebee Subscription",
    "name": "get_chargebee_subscription",
    "customName": false,
    "description": "Look up a Chargebee subscription by its ID. Use it when the customer asks about their plan status, next billing date or renewal. Report the status (active, paused, non_renewing, cancelled and so on) and next_billing_at. Confirm the customer is who they say they are before sharing details. The response also includes customer and card objects. Never read out card details, addresses or any contact information.",
    "parameters": [
      {
        "name": "subscriptionId",
        "type": "string",
        "description": "The Chargebee subscription ID."
      }
    ],
    "config": {
      "endpoint": {
        "method": "GET",
        "url": "https://YOUR_CHARGEBEE_SITE.chargebee.com/api/v2/subscriptions/{{subscriptionId}}"
      },
      "headers": [
        {
          "name": "Authorization",
          "value": "Basic YOUR_BASE64_CHARGEBEE_API_KEY"
        }
      ],
      "body": null,
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.