Class: Stripe::CreditNote::PreviewParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/credit_note.rb

Defined Under Namespace

Classes: Line, Refund, ShippingCost

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, credit_amount: nil, effective_at: nil, email_type: nil, expand: nil, invoice: nil, lines: nil, memo: nil, metadata: nil, out_of_band_amount: nil, reason: nil, refund_amount: nil, refunds: nil, shipping_cost: nil) ⇒ PreviewParams

Returns a new instance of PreviewParams.



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/stripe/resources/credit_note.rb', line 401

def initialize(
  amount: nil,
  credit_amount: nil,
  effective_at: nil,
  email_type: nil,
  expand: nil,
  invoice: nil,
  lines: nil,
  memo: nil,
  metadata: nil,
  out_of_band_amount: nil,
  reason: nil,
  refund_amount: nil,
  refunds: nil,
  shipping_cost: nil
)
  @amount = amount
  @credit_amount = credit_amount
  @effective_at = effective_at
  @email_type = email_type
  @expand = expand
  @invoice = invoice
  @lines = lines
  @memo = memo
  @metadata = metadata
  @out_of_band_amount = out_of_band_amount
  @reason = reason
  @refund_amount = refund_amount
  @refunds = refunds
  @shipping_cost = shipping_cost
end

Instance Attribute Details

#amount ⇒ Object

The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of ‘amount`, `lines`, or `shipping_cost` must be provided.



373
374
375
 
# File 'lib/stripe/resources/credit_note.rb', line 373

def amount
  @amount
end

#credit_amount ⇒ Object

The integer amount in cents (or local equivalent) representing the amount to credit the customer’s balance, which will be automatically applied to their next invoice.



375
376
377
 
# File 'lib/stripe/resources/credit_note.rb', line 375

def credit_amount
  @credit_amount
end

#effective_at ⇒ Object

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.



377
378
379
 
# File 'lib/stripe/resources/credit_note.rb', line 377

def effective_at
  @effective_at
end

#email_type ⇒ Object

Type of email to send to the customer, one of ‘credit_note` or `none` and the default is `credit_note`.



379
380
381
 
# File 'lib/stripe/resources/credit_note.rb', line 379

def email_type
  @email_type
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



381
382
383
 
# File 'lib/stripe/resources/credit_note.rb', line 381

def expand
  @expand
end

#invoice ⇒ Object

ID of the invoice.



383
384
385
 
# File 'lib/stripe/resources/credit_note.rb', line 383

def invoice
  @invoice
end

#lines ⇒ Object

Line items that make up the credit note. One of ‘amount`, `lines`, or `shipping_cost` must be provided.



385
386
387
 
# File 'lib/stripe/resources/credit_note.rb', line 385

def lines
  @lines
end

#memo ⇒ Object

The credit note’s memo appears on the credit note PDF.



387
388
389
 
# File 'lib/stripe/resources/credit_note.rb', line 387

def memo
  @memo
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



389
390
391
 
# File 'lib/stripe/resources/credit_note.rb', line 389

def metadata
  @metadata
end

#out_of_band_amount ⇒ Object

The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.



391
392
393
 
# File 'lib/stripe/resources/credit_note.rb', line 391

def out_of_band_amount
  @out_of_band_amount
end

#reason ⇒ Object

Reason for issuing this credit note, one of ‘duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`



393
394
395
 
# File 'lib/stripe/resources/credit_note.rb', line 393

def reason
  @reason
end

#refund_amount ⇒ Object

The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.



395
396
397
 
# File 'lib/stripe/resources/credit_note.rb', line 395

def refund_amount
  @refund_amount
end

#refunds ⇒ Object

Refunds to link to this credit note.



397
398
399
 
# File 'lib/stripe/resources/credit_note.rb', line 397

def refunds
  @refunds
end

#shipping_cost ⇒ Object

When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of ‘amount`, `lines`, or `shipping_cost` must be provided.



399
400
401
 
# File 'lib/stripe/resources/credit_note.rb', line 399

def shipping_cost
  @shipping_cost
end