Payhip

Learn how to use Payhip with Composio

Overview

SLUG: PAYHIP

Description

Payhip is an e-commerce platform that enables individuals and businesses to sell digital products, memberships, and physical goods directly to their audience.

Authentication Details

generic_api_key
stringRequired

Connecting to Payhip

Create an auth config

Use the dashboard to create an auth config for the Payhip toolkit. This allows you to connect multiple Payhip accounts to Composio for agents to use.

1

Select App

Navigate to Payhip.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Payhip Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4payhip_auth_config_id = "ac_YOUR_PAYHIP_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": user_api_key}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Payhip for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, payhip_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Payhip toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["PAYHIP"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Webhook Event - Paid

Description

Tool to process payhip's paid webhook event. use when handling a purchase completion webhook from payhip.

Action Parameters

currency
stringRequired
date
integerRequired
email
Required
id
stringRequired
ip_address
Required
is_gift
booleanRequired
items
arrayRequired
payhip_fee
integerRequired
payment_type
stringRequired
price
integerRequired
signature
stringRequired
stripe_fee
integerRequired
type
stringRequired
unconsented_from_emails
booleanRequired
vat_applied
booleanRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Webhook Event - Refunded Payment

Description

Tool to process payhip's refunded webhook event. use when handling a payment refund event from payhip.

Action Parameters

amount_refunded
integerRequired
currency
stringRequired
date_created
integerRequired
date_refunded
integerRequired
email
Required
id
stringRequired
ip_address
stringRequired
is_gift
booleanRequired
items
arrayRequired
payhip_fee
integerRequired
payment_type
stringRequired
price
integerRequired
signature
stringRequired
stripe_fee
integerRequired
type
stringRequired
unconsented_from_emails
booleanRequired
vat_applied
booleanRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Webhook Event - Subscription Created

Description

Tool to process payhip's subscription.created webhook event. use when handling a subscription start event from payhip.

Action Parameters

customer_email
Required
customer_first_name
stringRequired
customer_id
stringRequired
customer_last_name
stringRequired
date_subscription_started
integerRequired
gdpr_consent
stringRequired
plan_name
stringRequired
product_link
stringRequired
product_name
stringRequired
signature
stringRequired
status
stringRequired
subscription_id
stringRequired
type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Webhook Event - Subscription Deleted

Description

Tool to process payhip's 'subscription.deleted' webhook event. use when handling a subscription cancellation event from payhip.

Action Parameters

customer_email
Required
customer_first_name
stringRequired
customer_id
stringRequired
customer_last_name
stringRequired
date_subscription_deleted
integerRequired
date_subscription_started
integerRequired
gdpr_consent
stringRequired
plan_name
stringRequired
product_link
stringRequired
product_name
stringRequired
signature
stringRequired
status
stringRequired
subscription_id
stringRequired
type
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired