Tool to create a coupon for discounts in Payhip. Use when you need to create a new coupon code with either percentage or fixed amount discounts. Coupons can apply to single products, all products, or collections.
codeRequiredstringThe coupon code the customer is required to enter at checkout
notesstringFor administrative purposes you can remind yourself why you created this coupon by adding a note - not visible to customers
amount_offintegerA positive integer representing the amount to subtract from the cart total in cents. For example $5 off would be 500. Required if percent_off is not provided. Cannot be used together with percent_off.
coupon_typeRequiredstringSpecifies if the coupon will be applied for a single product, all your products or a single collection
percent_offnumberA positive float larger than 0, and smaller or equal to 100, that represents the discount percentage the coupon will apply. Required if amount_off is not provided. Cannot be used together with amount_off.
product_keystringThe unique product key. Required if coupon_type is set to 'single'
usage_limitintegerThe maximum number of times this coupon can be redeemed before it becomes invalid
collection_idstringThe unique collection ID. Required if coupon_type is set to 'collection'
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.