polar refunds <subcommand> [flags]
polar refunds createCreate a refund.polar refunds listList refunds.
polar refunds create
Create a refund.polar refunds create [flags]
| Flag | Type | Description |
|---|---|---|
--confirm, -c | boolean | Skip the confirmation prompt for destructive requests |
--data, -d | string | JSON object; explicitly supplied flags override its top-level keys |
--metadata | string | Key-value object allowing you to store additional information. JSON: {ā<key>ā: string | integer | number | boolean} |
--order-id | string | Required. order_id |
--reason | choice | Required. Reason for the refund. (choices: duplicate, fraudulent, customer_request, service_disruption, satisfaction_guarantee, other) |
--amount | integer | Required. Amount to refund in cents. Minimum is 1. |
--comment | string | An internal comment about the refund. |
--revoke-benefits | boolean | Should this refund trigger the associated customer benefits to be revoked? |
polar refunds list
List refunds.polar refunds list [flags]
| Flag | Type | Description |
|---|---|---|
--data, -d | string | JSON object; explicitly supplied flags override its top-level keys |
--id | string | Filter by refund ID. |
--organization-id, --org | string | Filter by organization ID. Defaults to the active organization. |
--order-id | string | Filter by order ID. |
--subscription-id | string | Filter by subscription ID. |
--customer-id | string | Filter by customer ID. |
--external-customer-id | string | Filter by customer external ID. |
--succeeded | boolean | Filter by succeeded. |
--page | integer | Page number, defaults to 1. |
--limit | integer | Size of a page, defaults to 10. Maximum is 100. |
--sorting | choice | Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order. (choices: created_at, -created_at, amount, -amount) |

