@type payment_record_refund() :: %{
  optional(:payment_record) => binary(),
  optional(:refund_group) => binary()
}

The PaymentRecord refund details to link to this credit note. Required when type is payment_record_refund.

@type t() :: %Stripe.CreditNote{
  amount: integer(),
  amount_shipping: integer(),
  created: integer(),
  currency: binary(),
  customer: binary() | Stripe.Customer.t() | Stripe.DeletedCustomer.t(),
  customer_balance_transaction:
    (binary() | Stripe.CustomerBalanceTransaction.t()) | nil,
  discount_amount: integer(),
  discount_amounts: term(),
  effective_at: integer() | nil,
  id: binary(),
  invoice: binary() | Stripe.Invoice.t(),
  lines: term(),
  livemode: boolean(),
  memo: binary() | nil,
  metadata: term() | nil,
  number: binary(),
  object: binary(),
  out_of_band_amount: integer() | nil,
  pdf: binary(),
  post_payment_amount: integer(),
  pre_payment_amount: integer(),
  pretax_credit_amounts: term(),
  reason: binary() | nil,
  refunds: term(),
  shipping_cost: term() | nil,
  status: binary(),
  subtotal: integer(),
  subtotal_excluding_tax: integer() | nil,
  total: integer(),
  total_excluding_tax: integer() | nil,
  total_taxes: term() | nil,
  type: binary(),
  voided_at: integer() | nil
}

The credit_note type.

• amount The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
• amount_shipping This is the sum of all the shipping amounts.
• created Time at which the object was created. Measured in seconds since the Unix epoch.
• currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
• customer ID of the customer.
• customer_balance_transaction Customer balance transaction related to this credit note.
• discount_amount The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
• discount_amounts The aggregate amounts calculated per discount for all line items.
• effective_at The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
• id Unique identifier for the object.
• invoice ID of the invoice.
• lines Line items that make up the credit note
• livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
• memo Customer-facing text that appears on the credit note PDF.
• metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
• number A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
• object String representing the object's type. Objects of the same type share the same value.
• out_of_band_amount Amount that was credited outside of Stripe.
• pdf The link to download the PDF of the credit note.
• post_payment_amount The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
• pre_payment_amount The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
• pretax_credit_amounts The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
• reason Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
• refunds Refunds related to this credit note.
• shipping_cost The details of the cost of shipping, including the ShippingRate applied to the invoice.
• status Status of this credit note, one of issued or void. Learn more about voiding credit notes.
• subtotal The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
• subtotal_excluding_tax The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
• total The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
• total_excluding_tax The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
• total_taxes The aggregate tax information for all line items.
• type Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
• voided_at The time that the credit note was voided.