Prepare Payment

Prepares payment for a join application, or resolves an existing Pricing Plans entitlement.

Before creating or refreshing checkout details, the method checks whether the member already has an eligible Pricing Plans entitlement for the program. If so, it returns the join application with paymentStatus set to PAYMENT_SUCCESSFUL and the eligible plan IDs in paymentInfo.paidPlanIds. No checkout is needed, even when the application was previously in PAYMENT_PENDING.

If no eligible entitlement exists, paymentStatus must be PAYMENT_PENDING, PAYMENT_FAILED, or PAYMENT_CANCELED. Calling the method for PAYMENT_FAILED or PAYMENT_CANCELED retries payment by replacing stale payment details with newly prepared ones.

Specify paymentType to choose the flow:

• SINGLE_PAYMENT: Creates a Wix Payments order and sets paymentStatus to PAYMENT_IN_PROGRESS.
• PAID_PLANS: Validates that pricing plans are connected to the program and sets paymentStatus to PAYMENT_IN_PROGRESS.

Check the returned paymentStatus before starting checkout, and direct the member to checkout only when it's PAYMENT_IN_PROGRESS. To apply a discount before the member completes a Wix Payments checkout, call Apply Coupon.