← Tools Reference

Payhip

Payhip integration (Finance). Imported from open-connector.

API key5 toolshttps://payhip.com/api/v2
POST
payhip_create_coupon
Create a Payhip coupon for a fixed amount or percentage discount.

/coupons

8 parameters
ParamTypeRequiredDescription
codestringrequiredThe coupon code customers enter at checkout.
couponTypestringrequiredHow Payhip applies the coupon.
notesstringoptionalAdministrative notes for the coupon. These notes are not visible to customers.
amountOffintegeroptionalThe fixed discount amount in cents.
percentOffnumberoptionalThe percentage discount to apply.
productKeystringoptionalThe unique Payhip product key for a single-product coupon.
collectionIdstringoptionalThe unique Payhip collection ID.
usageLimitintegeroptionalThe maximum number of times the coupon can be redeemed.
GET
payhip_get_coupon
Retrieve a Payhip coupon by ID.

/coupons/{couponId}

1 parameter
ParamTypeRequiredDescription
couponIdintegerrequiredThe unique Payhip coupon ID.
GET
payhip_list_coupons
List Payhip coupons, optionally starting from a specific results page.

/coupons

1 parameter
ParamTypeRequiredDescription
pageintegeroptionalThe Payhip results page to request.
PUT
payhip_update_coupon
Update a Payhip coupon using the same fields accepted by coupon creation.

/coupons/{couponId}

9 parameters
ParamTypeRequiredDescription
couponIdintegerrequiredThe unique Payhip coupon ID.
codestringrequiredThe coupon code customers enter at checkout.
couponTypestringrequiredHow Payhip applies the coupon.
notesstringoptionalAdministrative notes for the coupon. These notes are not visible to customers.
amountOffintegeroptionalThe fixed discount amount in cents.
percentOffnumberoptionalThe percentage discount to apply.
productKeystringoptionalThe unique Payhip product key for a single-product coupon.
collectionIdstringoptionalThe unique Payhip collection ID.
usageLimitintegeroptionalThe maximum number of times the coupon can be redeemed.
DELETE
payhip_delete_coupon
Delete a Payhip coupon by ID.

/coupons/{couponId}

1 parameter
ParamTypeRequiredDescription
couponIdintegerrequiredThe unique Payhip coupon ID.