Class: Stripe::CreditNotePreviewLinesListParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/credit_note_preview_lines_list_params.rb

Defined Under Namespace

Classes: Line, Refund, ShippingCost

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, new, #to_h

Constructor Details

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

Returns a new instance of CreditNotePreviewLinesListParams.



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 143

def initialize(
  amount: nil,
  credit_amount: nil,
  effective_at: nil,
  email_type: nil,
  ending_before: nil,
  expand: nil,
  invoice: nil,
  limit: nil,
  lines: nil,
  memo: nil,
  metadata: nil,
  out_of_band_amount: nil,
  reason: nil,
  refund_amount: nil,
  refunds: nil,
  shipping_cost: nil,
  starting_after: nil
)
  @amount = amount
  @credit_amount = credit_amount
  @effective_at = effective_at
  @email_type = email_type
  @ending_before = ending_before
  @expand = expand
  @invoice = invoice
  @limit = limit
  @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
  @starting_after = starting_after
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.



109
110
111
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 109

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.



111
112
113
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 111

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.



113
114
115
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 113

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.



115
116
117
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 115

def email_type
  @email_type
end

#ending_before ⇒ Object

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ‘ending_before=obj_bar` in order to fetch the previous page of the list.



117
118
119
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 117

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



119
120
121
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 119

def expand
  @expand
end

#invoice ⇒ Object

ID of the invoice.



121
122
123
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 121

def invoice
  @invoice
end

#limit ⇒ Object

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.



123
124
125
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 123

def limit
  @limit
end

#lines ⇒ Object

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



125
126
127
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 125

def lines
  @lines
end

#memo ⇒ Object

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



127
128
129
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 127

def memo
  @memo
end

#metadata ⇒ Object

Set of [key-value pairs](docs.stripe.com/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.



129
130
131
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 129

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.



131
132
133
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 131

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



133
134
135
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 133

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.



135
136
137
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 135

def refund_amount
  @refund_amount
end

#refunds ⇒ Object

Refunds to link to this credit note.



137
138
139
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 137

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.



139
140
141
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 139

def shipping_cost
  @shipping_cost
end

#starting_after ⇒ Object

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include ‘starting_after=obj_foo` in order to fetch the next page of the list.



141
142
143
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 141

def starting_after
  @starting_after
end

Class Method Details

.field_encodings ⇒ Object 



181
182
183
184
185
186
187
188
 
# File 'lib/stripe/params/credit_note_preview_lines_list_params.rb', line 181

def self.field_encodings
  @field_encodings = {
    lines: {
      kind: :array,
      element: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
    },
  }
end