POST

Apply Coupon


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Applies a coupon to a join application's payment order to reduce the payment amount.

paymentStatus must be PAYMENT_IN_PROGRESS, PAYMENT_FAILED, or PAYMENT_CANCELED. The last two let a member apply or change a coupon when retrying after a failed or canceled payment.

Returns the order totals with the discount applied. An order supports a single coupon, so remove the current coupon before applying a different one.

To remove the coupon, call Remove Coupon. If the coupon covers the full amount, call Complete Free Coupon Payment to finish without a paid checkout.

Permissions
Manage Online Programs
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/online-programs/participants/v3/join-applications/{joinApplicationId}/apply-coupon

Errors
428Failed Precondition

There are 4 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?