get_address
Retrieve a customer's address from Paddle Billing using customer ID and address ID to access shipping or billing information.
Instructions
This tool will retrieve an address for a customer from Paddle using its ID and related customer ID.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| customerId | Yes | Paddle ID of the customer. | |
| addressId | Yes | Paddle ID of the address. |
Implementation Reference
- src/functions.ts:322-330 (handler)The handler function that implements the core logic of the 'get_address' tool by calling paddle.addresses.get(customerId, addressId) to retrieve the address.
export const getAddress = async (paddle: Paddle, params: z.infer<typeof Parameters.getAddressParameters>) => { try { const { customerId, addressId } = params; const address = await paddle.addresses.get(customerId, addressId); return address; } catch (error) { return error; } }; - src/tools.ts:300-311 (registration)Registers the 'get_address' tool in the MCP tools array, including method name, description, parameters schema reference, and required actions.
{ method: "get_address", name: "Get an address for a customer", description: prompts.getAddressPrompt, parameters: params.getAddressParameters, actions: { addresses: { read: true, get: true, }, }, }, - src/api.ts:35-35 (registration)Maps the TOOL_METHODS.GET_ADDRESS constant to the getAddress handler function in the toolMap for execution.
[TOOL_METHODS.GET_ADDRESS]: funcs.getAddress, - src/constants.ts:27-27 (helper)Defines the constant TOOL_METHODS.GET_ADDRESS as the string 'get_address' used across the codebase for the tool identifier.
GET_ADDRESS: "get_address",