POST

Complete Free Coupon Payment


Developer Preview

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

Completes payment for a join application when an applied coupon covers the full amount.

The method verifies that a coupon is applied and brings the order total to zero, then marks the payment as successful and redeems the coupon. On success, paymentStatus becomes PAYMENT_SUCCESSFUL and a participant is created.

Before calling this method:

paymentStatus must be PAYMENT_IN_PROGRESS, PAYMENT_FAILED, or PAYMENT_CANCELED. The last two let a member close out a free-coupon retry after a failed or canceled payment without calling Prepare Payment again.

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

Errors
428Failed Precondition

There are 4 errors with this status code.

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

Event TriggersThis method triggers the following events:
Did this help?