New to Corsair? See API access, authentication, and error handling.
Coupons
create
coupons.create
Create a discount coupon for one product, all products or a collection
Risk: write
Exactly one of percent_off (0-100) or amount_off (cents) is required; coupon_type single needs product_key, collection needs collection_id. Subscriptions priced with a recurring amount cannot be discounted through the API yet.
Output
data full type
data full type
get
coupons.get
Read one coupon by id
Risk: read
Output
data full type
data full type
list
coupons.list
List the coupons of the account, paged by limit and offset
Risk: read
Paged with limit and offset.
Output
data full type
data full type
License
decreaseUsage
license.decreaseUsage
Decrease the usage count of a license key (a deactivation)
Risk: write
Decrements the uses counter (a deactivation). The docs’ endpoint list names /license/decrease while the example reuses /license/usage; see the overview note.
Output
data full type
data full type
disable
license.disable
Disable a license key so it stops validating
Risk: write
Payhip disables a license key automatically when a purchase is refunded.
Output
data full type
data full type
enable
license.enable
Enable a license key that was disabled
Risk: write
Output
data full type
data full type
increaseUsage
license.increaseUsage
Increase the usage count of a license key (an activation)
Risk: write
Increments the uses counter (an activation).
Output
data full type
data full type
verify
license.verify
Verify a license key against a product secret; read-only check
Risk: read
Answers the license key with enabled, uses, buyer_email and product fields.
Output
data full type
data full type