---
title: "refund.created"
method: POST
path: "/webhook-events/refund.created"
tags: ["Webhook Events"]
---

# refund.created

`POST /webhook-events/refund.created`

## Request

- Base URL: `https://us.api.flexprice.io/v1`
- URL: `https://us.api.flexprice.io/v1/webhook-events/refund.created`
- Auth: none declared
- TypeScript: <https://skmtc.dev/flexprice/apis/flexprice-api/docs/webhook-events/refund.created/post.ts> (a function with typed inputs; its response is checked against the schema)

Fired when a refund is planned against an invoice, before the money moves. Doc-only for parsing.

## Response `200`

Webhook payload

- WebhookDtoRefundWebhookPayload
  - `event_type` 'subscription.created' | 'subscription.draft.created' | 'subscription.activated' | 'subscription.updated' | 'subscription.paused' | 'subscription.cancelled' | 'subscription.resumed' | 'subscription.plan_changed' | 'subscription.phase.created' | 'subscription.phase.updated' | 'subscription.phase.deleted' | 'feature.created' | 'feature.updated' | 'feature.deleted' | 'feature.wallet_balance.alert' | 'entitlement.created' | 'entitlement.updated' | 'entitlement.deleted' | 'commitment.created' | 'commitment.updated' | 'commitment.terminated' | 'billing_terms.created' | 'billing_terms.updated' | 'billing_instalment.created' | 'billing_instalment.updated' | 'billing_instalment.cancelled' | 'billing_instalment.invoiced' | 'wallet.created' | 'wallet.updated' | 'wallet.terminated' | 'wallet.transaction.created' | 'wallet.transaction.updated' | 'payment.created' | 'payment.updated' | 'payment.failed' | 'payment.attempt.failed' | 'payment.success' | 'payment.pending' | 'refund.created' | 'refund.succeeded' | 'refund.failed' | 'customer.created' | 'customer.updated' | 'customer.deleted' | 'invoice.update.finalized' | 'invoice.update.payment' | 'invoice.update.voided' | 'invoice.update' | 'invoice.payment.overdue' | 'invoice.sync.success' | 'invoice.sync.failed' | 'wallet.credit_balance.dropped' | 'wallet.credit_balance.recovered' | 'wallet.ongoing_balance.dropped' | 'wallet.ongoing_balance.recovered' | 'wallet.ongoing_balance.updated' | 'subscription.spend.threshold_reached' | 'subscription.spend.threshold_recovered' | 'subscription.line_item_spend.threshold_reached' | 'subscription.line_item_spend.threshold_recovered' | 'subscription.group_spend.threshold_reached' | 'subscription.group_spend.threshold_recovered' | 'entitlement.grant.exhausted' | 'subscription.renewal.due' | 'invoice.communication.triggered' | 'credit_note.created' | 'credit_note.updated' | 'checkout.session.initiated' | 'checkout.session.completed' | 'checkout.session.failed' | 'checkout.session.expired' | 'event.rejected'
  - `refund` WebhookDtoRefund
    - `amount` string
    - `attempt` integer
    - `credit_note_id` string
    - `currency` string
    - `failed_at` string, date-time
    - `failure_reason` string
    - `gateway_refund_id` string
    - `id` string
    - `invoice_id` string
    - `metadata` TypesMetadata
    - `payment_gateway` string
    - `payment_id` string
    - `refund_destination` 'GATEWAY' | 'WALLET' | 'OUT_OF_BAND'
    - `refund_destination_id` string
    - `refund_reason` 'DUPLICATE' | 'FRAUDULENT' | 'REQUESTED_BY_CUSTOMER' | 'ORDER_CHANGE' | 'SERVICE_ISSUE' | 'OTHER'
    - `refund_status` 'PENDING' | 'PROCESSING' | 'SUCCEEDED' | 'FAILED' | 'CANCELLED'
    - `settled_amount` string
    - `succeeded_at` string, date-time

## Changes

- **2026-11-06** `dee9053287c7`: 1 warning
  - removed the optional property `refund/billing_entity_id` from the response with the `200` status
- **2026-11-06** `6f29a774b471`: 1 info
  - added the optional property `refund/billing_entity_id` to the response with the `200` status
- **2026-11-03** `b8c7fed9a59f`: 1 warning
  - added the new `payment.attempt.failed` enum value to the `event_type` response property for the response status `200`
- **2026-11-03** `026540133fdf`: 6 warning
  - added the new `billing_instalment.cancelled` enum value to the `event_type` response property for the response status `200`
  - added the new `billing_instalment.created` enum value to the `event_type` response property for the response status `200`
  - added the new `billing_instalment.invoiced` enum value to the `event_type` response property for the response status `200`
  - added the new `billing_instalment.updated` enum value to the `event_type` response property for the response status `200`
  - …2 more
- **2026-10-25** `9b4083f46c66`: 3 warning
  - added the new `commitment.created` enum value to the `event_type` response property for the response status `200`
  - added the new `commitment.terminated` enum value to the `event_type` response property for the response status `200`
  - added the new `commitment.updated` enum value to the `event_type` response property for the response status `200`

[Operation history](https://skmtc.dev/flexprice/apis/flexprice-api/changes/webhook-events/refund.created/post.md)

---

[API](https://skmtc.dev/flexprice/apis/flexprice-api.md) - [All operations](https://skmtc.dev/flexprice/apis/flexprice-api/llms.txt) - [OpenAPI document](https://skmtc.dev/flexprice/apis/flexprice-api/revisions/2f63c3087bc7?raw)