Class: Stripe::Invoice::CreatePreviewParams

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

Defined Under Namespace

Classes: AutomaticTax, CustomerDetails, Discount, InvoiceItem, Issuer, ScheduleDetails, SubscriptionDetails

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(automatic_tax: nil, currency: nil, customer: nil, customer_details: nil, discounts: nil, expand: nil, invoice_items: nil, issuer: nil, on_behalf_of: nil, preview_mode: nil, schedule: nil, schedule_details: nil, subscription: nil, subscription_details: nil) ⇒ CreatePreviewParams

Returns a new instance of CreatePreviewParams.



3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
 
# File 'lib/stripe/resources/invoice.rb', line 3194

def initialize(
  automatic_tax: nil,
  currency: nil,
  customer: nil,
  customer_details: nil,
  discounts: nil,
  expand: nil,
  invoice_items: nil,
  issuer: nil,
  on_behalf_of: nil,
  preview_mode: nil,
  schedule: nil,
  schedule_details: nil,
  subscription: nil,
  subscription_details: nil
)
  @automatic_tax = automatic_tax
  @currency = currency
  @customer = customer
  @customer_details = customer_details
  @discounts = discounts
  @expand = expand
  @invoice_items = invoice_items
  @issuer = issuer
  @on_behalf_of = on_behalf_of
  @preview_mode = preview_mode
  @schedule = schedule
  @schedule_details = schedule_details
  @subscription = subscription
  @subscription_details = subscription_details
end

Instance Attribute Details

#automatic_tax ⇒ Object

Settings for automatic tax lookup for this invoice preview.



3166
3167
3168
 
# File 'lib/stripe/resources/invoice.rb', line 3166

def automatic_tax
  @automatic_tax
end

#currency ⇒ Object

The currency to preview this invoice in. Defaults to that of ‘customer` if not specified.



3168
3169
3170
 
# File 'lib/stripe/resources/invoice.rb', line 3168

def currency
  @currency
end

#customer ⇒ Object

The identifier of the customer whose upcoming invoice you’d like to retrieve. If ‘automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.



3170
3171
3172
 
# File 'lib/stripe/resources/invoice.rb', line 3170

def customer
  @customer
end

#customer_details ⇒ Object

Details about the customer you want to invoice or overrides for an existing customer. If ‘automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.



3172
3173
3174
 
# File 'lib/stripe/resources/invoice.rb', line 3172

def customer_details
  @customer_details
end

#discounts ⇒ Object

The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.



3174
3175
3176
 
# File 'lib/stripe/resources/invoice.rb', line 3174

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



3176
3177
3178
 
# File 'lib/stripe/resources/invoice.rb', line 3176

def expand
  @expand
end

#invoice_items ⇒ Object

List of invoice items to add or update in the upcoming invoice preview (up to 250).



3178
3179
3180
 
# File 'lib/stripe/resources/invoice.rb', line 3178

def invoice_items
  @invoice_items
end

#issuer ⇒ Object

The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.



3180
3181
3182
 
# File 'lib/stripe/resources/invoice.rb', line 3180

def issuer
  @issuer
end

#on_behalf_of ⇒ Object

The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](stripe.com/docs/billing/invoices/connect) documentation for details.



3182
3183
3184
 
# File 'lib/stripe/resources/invoice.rb', line 3182

def on_behalf_of
  @on_behalf_of
end

#preview_mode ⇒ Object

Customizes the types of values to include when calculating the invoice. Defaults to ‘next` if unspecified.



3184
3185
3186
 
# File 'lib/stripe/resources/invoice.rb', line 3184

def preview_mode
  @preview_mode
end

#schedule ⇒ Object

The identifier of the schedule whose upcoming invoice you’d like to retrieve. Cannot be used with subscription or subscription fields.



3186
3187
3188
 
# File 'lib/stripe/resources/invoice.rb', line 3186

def schedule
  @schedule
end

#schedule_details ⇒ Object

The schedule creation or modification params to apply as a preview. Cannot be used with ‘subscription` or `subscription_` prefixed fields.



3188
3189
3190
 
# File 'lib/stripe/resources/invoice.rb', line 3188

def schedule_details
  @schedule_details
end

#subscription ⇒ Object

The identifier of the subscription for which you’d like to retrieve the upcoming invoice. If not provided, but a ‘subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer’s subscriptions.



3190
3191
3192
 
# File 'lib/stripe/resources/invoice.rb', line 3190

def subscription
  @subscription
end

#subscription_details ⇒ Object

The subscription creation or modification params to apply as a preview. Cannot be used with ‘schedule` or `schedule_details` fields.



3192
3193
3194
 
# File 'lib/stripe/resources/invoice.rb', line 3192

def subscription_details
  @subscription_details
end