class Stripe::CreditNote

• Stripe::CreditNote
• Reference
• Object

Overview

Issue a credit note to adjust an invoice's amount after the invoice is finalized. Related guide: Credit notes

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [post_payment, pre_payment]."

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [credit_note]."

ERROR_MESSAGE_FOR_REASON = "invalid value for \"reason\", must be one of [duplicate, fraudulent, order_change, product_unsatisfactory]."

ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [issued, void]."

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_MEMO = 5000

MAX_LENGTH_FOR_NUMBER = 5000

MAX_LENGTH_FOR_PDF = 5000

VALID_VALUES_FOR__TYPE = String.static_array("post_payment", "pre_payment")

VALID_VALUES_FOR_OBJECT = String.static_array("credit_note")

VALID_VALUES_FOR_REASON = String.static_array("duplicate", "fraudulent", "order_change", "product_unsatisfactory")

VALID_VALUES_FOR_STATUS = String.static_array("issued", "void")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, amount : Int64 | Nil = nil, amount_shipping : Int64 | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, customer : Stripe::CreditNoteCustomer | Nil = nil, customer_balance_transaction : Stripe::CreditNoteCustomerBalanceTransaction | Nil = nil, discount_amount : Int64 | Nil = nil, discount_amounts : Array(Stripe::DiscountsResourceDiscountAmount) | Nil = nil, effective_at : Int64 | Nil = nil, id : String | Nil = nil, invoice : Stripe::CreditNoteInvoice | Nil = nil, lines : Stripe::CreditNoteLinesList | Nil = nil, livemode : Bool | Nil = nil, memo : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, number : String | Nil = nil, object : String | Nil = nil, out_of_band_amount : Int64 | Nil = nil, pdf : String | Nil = nil, reason : String | Nil = nil, refund : Stripe::CreditNoteRefund | Nil = nil, shipping_cost : Stripe::CreditNoteShippingCost1 | Nil = nil, status : String | Nil = nil, subtotal : Int64 | Nil = nil, subtotal_excluding_tax : Int64 | Nil = nil, tax_amounts : Array(Stripe::CreditNoteTaxAmount) | Nil = nil, total : Int64 | Nil = nil, total_excluding_tax : Int64 | Nil = nil, _type : String | Nil = nil, voided_at : Int64 | Nil = nil)

  Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance Method Summary

• #==(other : self)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #_type : String | Nil
• #_type=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #amount : Int64 | Nil
• #amount=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #amount_shipping : Int64 | Nil
• #amount_shipping=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #currency : String | Nil
• #currency=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #customer : Stripe::CreditNoteCustomer | Nil
• #customer=(new_value : Stripe::CreditNoteCustomer | Nil)

  Custom attribute writer method checking allowed values (enum).

• #customer_balance_transaction : Stripe::CreditNoteCustomerBalanceTransaction | Nil
• #customer_balance_transaction=(new_value : Stripe::CreditNoteCustomerBalanceTransaction | Nil)

  Custom attribute writer method checking allowed values (enum).

• #discount_amount : Int64 | Nil
• #discount_amount=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #discount_amounts : Array(Stripe::DiscountsResourceDiscountAmount) | Nil
• #discount_amounts=(new_value : Array(Stripe::DiscountsResourceDiscountAmount) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #effective_at : Int64 | Nil
• #effective_at=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #invoice : Stripe::CreditNoteInvoice | Nil
• #invoice=(new_value : Stripe::CreditNoteInvoice | Nil)

  Custom attribute writer method checking allowed values (enum).

• #lines : Stripe::CreditNoteLinesList | Nil
• #lines=(new_value : Stripe::CreditNoteLinesList | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #memo : String | Nil
• #memo=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #metadata : Hash(String, String) | Nil
• #metadata=(new_value : Hash(String, String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #number : String | Nil
• #number=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #out_of_band_amount : Int64 | Nil
• #out_of_band_amount=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #pdf : String | Nil
• #pdf=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #reason : String | Nil
• #reason=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #refund : Stripe::CreditNoteRefund | Nil
• #refund=(new_value : Stripe::CreditNoteRefund | Nil)

  Custom attribute writer method checking allowed values (enum).

• #shipping_cost : Stripe::CreditNoteShippingCost1 | Nil
• #shipping_cost=(new_value : Stripe::CreditNoteShippingCost1 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #status : String | Nil
• #status=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #subtotal : Int64 | Nil
• #subtotal=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #subtotal_excluding_tax : Int64 | Nil
• #subtotal_excluding_tax=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #tax_amounts : Array(Stripe::CreditNoteTaxAmount) | Nil
• #tax_amounts=(new_value : Array(Stripe::CreditNoteTaxAmount) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #total : Int64 | Nil
• #total=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #total_excluding_tax : Int64 | Nil
• #total_excluding_tax=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

  Check to see if the all the properties in the model are valid @return true if the model is valid

• #voided_at : Int64 | Nil
• #voided_at=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

Constructor Detail

Instance Method Detail