Get Coupon

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

READghl.get_coupon

• Contract tier: agent_ready
• Risk: read
• Catalog version: 2026-07-12.2
• Descriptor hash: 7d2147805ce23548a727ff96921b566924ff7129c1bcb6434c00dc8bee5173bd

Get coupon details by ID or code for the authenticated GHL location. Provide either id or code. GHL category: Payments. This is a read-only GHL API operation.

Request Body

{
  "jsonrpc": "2.0",
  "id": "ghl-get-coupon-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.get_coupon",
    "arguments": {
      "id": "id_123",
      "code": "code_example",
      "altId": "altId_123",
      "altType": "location",
      "tenantId": "tenantId_123"
    }
  }
}

Arguments Schema

{
  "type": "object",
  "anyOf": [
    {
      "required": [
        "id"
      ]
    },
    {
      "required": [
        "code"
      ]
    }
  ],
  "required": [],
  "properties": {
    "id": {
      "type": "string",
      "description": "Coupon ID"
    },
    "code": {
      "type": "string",
      "description": "Coupon code. GHL only accepts letters and numbers; do not use spaces, hyphens, or underscores."
    },
    "altId": {
      "type": "string",
      "description": "Optional location ID. If provided, it must match the authenticated runtime location."
    },
    "altType": {
      "enum": [
        "location"
      ],
      "type": "string",
      "description": "Alt Type. Defaults to location."
    },
    "tenantId": {
      "type": "string",
      "description": "Tenant ID from list_tenants."
    }
  }
}

Output Schema

{
  "type": "object",
  "required": [
    "ok",
    "data",
    "error",
    "meta"
  ],
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the GHL MCP operation completed successfully."
    },
    "data": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "Tool-specific GHL or local navigation result when ok is true."
    },
    "meta": {
      "type": "object",
      "description": "Safe execution, routing, and timing metadata.",
      "additionalProperties": true
    },
    "error": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "description": "Safe error details when ok is false; credential values are never returned."
    }
  },
  "description": "Normalized GHL MCP response envelope.",
  "additionalProperties": false
}

Code Examples

cURL

curl -X POST 'https://portal.madpanda3d.com/api/mcp' \
  -H 'Authorization: Bearer mad_live_***' \
  -H 'Content-Type: application/json' \
  -d '{
  "jsonrpc": "2.0",
  "id": "ghl-get-coupon-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.get_coupon",
    "arguments": {
      "id": "id_123",
      "code": "code_example",
      "altId": "altId_123",
      "altType": "location",
      "tenantId": "tenantId_123"
    }
  }
}'

Node.js

const response = await fetch('https://portal.madpanda3d.com/api/mcp', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mad_live_***',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "jsonrpc": "2.0",
  "id": "ghl-get-coupon-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.get_coupon",
    "arguments": {
      "id": "id_123",
      "code": "code_example",
      "altId": "altId_123",
      "altType": "location",
      "tenantId": "tenantId_123"
    }
  }
}),
});
const data = await response.json();
console.log(data);

Python

import requests

url = 'https://portal.madpanda3d.com/api/mcp'
headers = {
    'Authorization': 'Bearer mad_live_***',
    'Content-Type': 'application/json',
}
payload = {
  "jsonrpc": "2.0",
  "id": "ghl-get-coupon-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.get_coupon",
    "arguments": {
      "id": "id_123",
      "code": "code_example",
      "altId": "altId_123",
      "altType": "location",
      "tenantId": "tenantId_123"
    }
  }
}
response = requests.post(url, headers=headers, json=payload, timeout=60)
print(response.json())

Example Responses

200 Success

{
  "ok": true,
  "message": "Tool ghl.get_coupon executed successfully.",
  "note": "Response shape varies by MCP tool. Inspect live responses for exact fields."
}

502 Upstream Error

{
  "ok": false,
  "classification": "upstream_http_error",
  "message": "Upstream MCP returned a non-success status."
}