Recurly Get Orders
Retrieve Recurly orders by a supported search field with optional status, limit, and deleted-line filters.
Recurly Get Orders
Retrieve Recurly orders by searching with a supported field and optional filters.
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| Search By | String | Yes | Field to search by. Supported values: subscriptionId, subscriptionExternalId, subscriberId, subscriberEmail, subscriberExternalId, orderExternalId. |
| Search Value | String | Yes | Value of the field you are searching by. |
| Limit | Optional String | No | Maximum number of results to return. |
| Status | Optional String | No | Order status filter. Supported values: PROCESSED, REFUNDED, PARTIALLY_REFUNDED. |
| Include Deleted | Optional Boolean | No | If True, deleted lines are included. Defaults to False. |
| Safe Mode | Optional Boolean | No | If set to True, errors are logged in the action outputs instead of stopping the Flow. Defaults to False. |
Outputs
| Name | Type | Description |
|---|---|---|
| Success | Boolean | Whether the orders were retrieved successfully. |
| Orders | List | List of matching orders. |
Run the action
- Select the field to query in Search By.
- Enter the value to match in Search Value.
- Optional: Enter Limit to restrict how many orders the action returns.
- Optional: Enter Status to return only orders in a specific status.
- Optional: Set Include Deleted to
Trueif you want deleted lines included in the results. - Set Safe Mode to
Trueif you want the Flow to continue when the action encounters an error. - Run the action.
- Check Success to confirm whether the search completed successfully.
- Use Orders in the next step of your Flow.
Optional: Handle errors with Safe Mode
If Safe Mode is False or not provided, an error stops the Flow.
If Safe Mode is True, the action logs the error in the outputs instead of stopping the Flow.
Notes
- Use Search By and Search Value together to control how the action finds orders.
- Use Limit when you only need a smaller set of matching results.
- Use Status to narrow the results before passing Orders to later Flow steps.
- Check Success before using Orders in later steps.
Updated 5 days ago