Class: Stripe::CreditNotePreviewParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/credit_note_preview_params.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) ⇒ CreditNotePreviewParams

Returns a new instance of CreditNotePreviewParams.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 112

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.



84
85
86
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 84

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.



86
87
88
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 86

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.



88
89
90
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 88

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`.



90
91
92
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 90

def email_type
  @email_type
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



92
93
94
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 92

def expand
  @expand
end

#invoice ⇒ Object

ID of the invoice.



94
95
96
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 94

def invoice
  @invoice
end

#lines ⇒ Object

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



96
97
98
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 96

def lines
  @lines
end

#memo ⇒ Object

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



98
99
100
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 98

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`.



100
101
102
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 100

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.



102
103
104
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 102

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`



104
105
106
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 104

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.



106
107
108
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 106

def refund_amount
  @refund_amount
end

#refunds ⇒ Object

Refunds to link to this credit note.



108
109
110
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 108

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.



110
111
112
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 110

def shipping_cost
  @shipping_cost
end