get_customer
Retrieve customer details from Paddle Billing using their unique customer ID to access account information and manage billing data.
Instructions
This tool will retrieve a customer from Paddle by its ID.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| customerId | Yes | Paddle ID of the customer. |
Implementation Reference
- src/functions.ts:280-288 (handler)The main handler function for the 'get_customer' tool. It takes a Paddle SDK instance and parameters, extracts the customerId, calls paddle.customers.get(customerId), and returns the customer or error.export const getCustomer = async (paddle: Paddle, params: z.infer<typeof Parameters.getCustomerParameters>) => { try { const { customerId } = params; const customer = await paddle.customers.get(customerId); return customer; } catch (error) { return error; } };
- src/tools.ts:253-263 (schema)The tool definition object in the tools array, specifying the method name 'get_customer', human-readable name, description prompt, Zod parameters schema reference, and required permissions/actions for customers (read/get).method: "get_customer", name: "Get a customer", description: prompts.getCustomerPrompt, parameters: params.getCustomerParameters, actions: { customers: { read: true, get: true, }, }, },
- src/api.ts:31-31 (registration)Registration of the getCustomer handler function in the toolMap object, mapping the GET_CUSTOMER constant to the function for execution in PaddleAPI.run().[TOOL_METHODS.GET_CUSTOMER]: funcs.getCustomer,
- src/constants.ts:23-23 (registration)Constant definition for the tool method key 'GET_CUSTOMER' mapping to the string 'get_customer', used in tool definitions and mappings.GET_CUSTOMER: "get_customer",