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, billing_cadence: nil, currency: nil, customer: nil, customer_account: 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.



4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
 
# File 'lib/stripe/resources/invoice.rb', line 4725

def initialize(
  automatic_tax: nil,
  billing_cadence: nil,
  currency: nil,
  customer: nil,
  customer_account: 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
  @billing_cadence = billing_cadence
  @currency = currency
  @customer = customer
  @customer_account = 
  @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.



4693
4694
4695
 
# File 'lib/stripe/resources/invoice.rb', line 4693

def automatic_tax
  @automatic_tax
end

#billing_cadence ⇒ Object

The identifier of the billing cadence for which you’d like to retrieve the upcoming invoice.Cannot be provided when ‘subscription`, `schedule`, `subscription_details` or `schedule_details` are provided.



4695
4696
4697
 
# File 'lib/stripe/resources/invoice.rb', line 4695

def billing_cadence
  @billing_cadence
end

#currency ⇒ Object

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



4697
4698
4699
 
# File 'lib/stripe/resources/invoice.rb', line 4697

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.



4699
4700
4701
 
# File 'lib/stripe/resources/invoice.rb', line 4699

def customer
  @customer
end

#customer_account ⇒ Object

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



4701
4702
4703
 
# File 'lib/stripe/resources/invoice.rb', line 4701

def 
  @customer_account
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.



4703
4704
4705
 
# File 'lib/stripe/resources/invoice.rb', line 4703

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.



4705
4706
4707
 
# File 'lib/stripe/resources/invoice.rb', line 4705

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



4707
4708
4709
 
# File 'lib/stripe/resources/invoice.rb', line 4707

def expand
  @expand
end

#invoice_items ⇒ Object

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



4709
4710
4711
 
# File 'lib/stripe/resources/invoice.rb', line 4709

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.



4711
4712
4713
 
# File 'lib/stripe/resources/invoice.rb', line 4711

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.



4713
4714
4715
 
# File 'lib/stripe/resources/invoice.rb', line 4713

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.



4715
4716
4717
 
# File 'lib/stripe/resources/invoice.rb', line 4715

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.



4717
4718
4719
 
# File 'lib/stripe/resources/invoice.rb', line 4717

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.



4719
4720
4721
 
# File 'lib/stripe/resources/invoice.rb', line 4719

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.



4721
4722
4723
 
# File 'lib/stripe/resources/invoice.rb', line 4721

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.



4723
4724
4725
 
# File 'lib/stripe/resources/invoice.rb', line 4723

def subscription_details
  @subscription_details
end