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.



3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
 
# File 'lib/stripe/resources/invoice.rb', line 3061

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.



3033
3034
3035
 
# File 'lib/stripe/resources/invoice.rb', line 3033

def automatic_tax
  @automatic_tax
end

#currency ⇒ Object

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



3035
3036
3037
 
# File 'lib/stripe/resources/invoice.rb', line 3035

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.



3037
3038
3039
 
# File 'lib/stripe/resources/invoice.rb', line 3037

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.



3039
3040
3041
 
# File 'lib/stripe/resources/invoice.rb', line 3039

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.



3041
3042
3043
 
# File 'lib/stripe/resources/invoice.rb', line 3041

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



3043
3044
3045
 
# File 'lib/stripe/resources/invoice.rb', line 3043

def expand
  @expand
end

#invoice_items ⇒ Object

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



3045
3046
3047
 
# File 'lib/stripe/resources/invoice.rb', line 3045

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.



3047
3048
3049
 
# File 'lib/stripe/resources/invoice.rb', line 3047

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.



3049
3050
3051
 
# File 'lib/stripe/resources/invoice.rb', line 3049

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.



3051
3052
3053
 
# File 'lib/stripe/resources/invoice.rb', line 3051

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.



3053
3054
3055
 
# File 'lib/stripe/resources/invoice.rb', line 3053

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.



3055
3056
3057
 
# File 'lib/stripe/resources/invoice.rb', line 3055

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.



3057
3058
3059
 
# File 'lib/stripe/resources/invoice.rb', line 3057

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.



3059
3060
3061
 
# File 'lib/stripe/resources/invoice.rb', line 3059

def subscription_details
  @subscription_details
end