throwUnlessPaymentCollectionNotPaid - Medusa Core Workflows Reference

This documentation provides a reference to the throwUnlessPaymentCollectionNotPaid. It belongs to the @medusajs/medusa/core-flows package.

This step validates that the payment collection is not paid. If not valid, the step will throw an error.

NoteYou can retrieve a payment collection's details using Query, or useQueryGraphStep.

Example#

Code
1const data = throwUnlessPaymentCollectionNotPaid({2  paymentCollection: {3    id: "paycol_123",4    // other payment details...5  }6})

Input#

ThrowUnlessPaymentCollectionNotePaidInputThrowUnlessPaymentCollectionNotePaidInput
The details of the payment collection to validate.
paymentCollectionPaymentCollectionDTO
The payment collection to validate.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break