---
title: "Credit Note refund failure."
method: POST
path: "usage-billing.credit-note.refund.failed"
tags: ["Credit Notes"]
---

# Credit Note refund failure.

`POST usage-billing.credit-note.refund.failed` (webhook)

Webhook for credit note refund failure.

## Headers

- `paypal-transmission-id` string
- `paypal-transmission-time` string

## Payload

- object
  - `id` string, required: Unique identifier for the webhook event.
  - `create_time` string, date-time, required: Date and time in ISO 8601 format.
  - `event_version` string: Version of the event schema.
  - `summary` string: Brief description of the event.
  - `resource_version` string: Version of the resource schema.
  - `links` Link[]: HATEOAS links for the webhook event.
    - `href` string, uri, required: URL for the action.
    - `rel` string, required: Relation type of the link.
    - `method` string, required: HTTP method to use with the URL.
  - `resource_type` 'subscription-alert' | 'wallet' | 'wallet-transaction' | 'credit-note' | 'invoice' | 'subscription', required: Type of resource that triggered the webhook.
  - `event_type` 'USAGE-BILLING.SUBSCRIPTION-ALERT.TRIGGERED' | 'USAGE-BILLING.WALLET.CREATED' | 'USAGE-BILLING.WALLET.UPDATED' | 'USAGE-BILLING.WALLET.NET-BALANCE-DEPLETED' | 'USAGE-BILLING.WALLET.TERMINATED' | 'USAGE-BILLING.WALLET-TRANSACTION.CREATED' | 'USAGE-BILLING.WALLET-TRANSACTION.UPDATED' | 'USAGE-BILLING.CREDIT-NOTE.CREATED' | 'USAGE-BILLING.CREDIT-NOTE.REFUND.FAILED' | 'USAGE-BILLING.INVOICE.CREATED' | 'USAGE-BILLING.INVOICE.PAYMENT.OVERDUE' | 'USAGE-BILLING.INVOICE.PAYMENT.SUCCEEDED' | 'USAGE-BILLING.INVOICE.PAYMENT.FAILED' | 'USAGE-BILLING.SUBSCRIPTION.UPDATED' | 'USAGE-BILLING.SUBSCRIPTION.TERMINATED' | 'USAGE-BILLING.SUBSCRIPTION.TRIAL.ENDED', required: Type of event that occurred in webhooks.
  - `resource` CreditNoteWithId, required
    - `billing_entity_code` string, required: Unique code used to identify the billing entity. Must contain only alphanumeric characters, underscores, and hyphens.
    - `sequential_id` integer, required: The sequential identifier of the credit note, specifically scoped on the associated invoice. It provides a unique numerical identifier for the credit note within the context of the invoice.
    - `number` string, required: The credit note unique number.
    - `invoice_id` string, uuid, required: Unique identifier assigned to the invoice that the credit note belongs to
    - `invoice_number` string, required: The invoice unique number, related to the credit note.
    - `issuing_date` string, date, required: Date in ISO 8601 format (YYYY-MM-DD).
    - `credit_status` 'AVAILABLE' | 'CONSUMED' | 'VOIDED': The status of the credit portion of the credit note
    - `refund_status` 'PENDING' | 'SUCCEEDED' | 'FAILED': The status of the refund portion of the credit note
    - `reason` 'DUPLICATED_CHARGE' | 'PRODUCT_UNSATISFACTORY' | 'ORDER_CHANGE' | 'ORDER_CANCELLATION' | 'FRAUDULENT_CHARGE' | 'OTHER', required: The reason for credit note creation
    - `description` string, nullable: The description of the credit note.
    - `total_amount` Amount, required
      - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
      - `currency_code` string, required: Currency code in ISO 4217 format.
    - `taxes_amount` Amount, required
      - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
      - `currency_code` string, required: Currency code in ISO 4217 format.
    - `taxes_rate` number, required: The tax rate associated with this specific credit note.
    - `sub_total_excluding_taxes_amount` Amount, required
      - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
      - `currency_code` string, required: Currency code in ISO 4217 format.
    - `balance_amount` Amount, required
      - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
      - `currency_code` string, required: Currency code in ISO 4217 format.
    - `credit_amount` Amount, required
      - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
      - `currency_code` string, required: Currency code in ISO 4217 format.
    - `refund_amount` Amount, required
      - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
      - `currency_code` string, required: Currency code in ISO 4217 format.
    - `created_at` string, date-time, required: Date and time in ISO 8601 format.
    - `updated_at` string, date-time, required: Date and time in ISO 8601 format.
    - `items` CreditNoteItemObject[]: Array of credit note's items.
      - `id` string, uuid, required: The credit note's item unique identifier.
      - `amount` Amount, required
        - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
        - `currency_code` string, required: Currency code in ISO 4217 format.
      - `fee` FeeObject, required
        - `id` string, uuid, nullable: Unique identifier assigned to the fee. This ID is exclusively and serves as a unique identifier for the fee's record.
        - `total_amount` Amount
          - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
          - `currency_code` string, required: Currency code in ISO 4217 format.
        - `name` string, nullable: The the name of the fee associated to any one of the charge, the credit, the subscription or the commitment
    - `applied_taxes` CreditNoteAppliedTaxObject[]
      - `id` string, uuid: Unique identifier of the applied tax.
      - `tax_id` string, uuid: Unique identifier of the tax.
      - `tax_name` string: Name of the tax.
      - `tax_code` string: Unique code used to identify the tax associated with the API request.
      - `tax_rate` number: The percentage rate of the tax
      - `tax_description` string: Internal description of the taxes
      - `amount` Amount
        - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
        - `currency_code` string, required: Currency code in ISO 4217 format.
      - `created_at` string, date-time: Date and time in ISO 8601 format.
    - `id` string

## Acknowledgement `204`

Return a 204 status to indicate that the data was received successfully.

---

[API](https://skmtc.dev/paypal/apis/usage-based-billing-api.md) - [All operations](https://skmtc.dev/paypal/apis/usage-based-billing-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paypal/apis/usage-based-billing-api/revisions/22fb46514ac4?raw)