Class: Stripe::Invoice::CreatePreviewParams

Inherits:

RequestParams

• Object
• RequestParams
• Stripe::Invoice::CreatePreviewParams

Defined in:

lib/stripe/resources/invoice.rb

Defined Under Namespace

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

Instance Attribute Summary

• #automatic_tax ⇒ Object

  Settings for automatic tax lookup for this invoice preview.

• #coupon ⇒ Object

  The ID of the coupon to apply to this phase of the subscription schedule.

• #currency ⇒ Object

  The currency to preview this invoice in.

• #customer ⇒ Object

  The identifier of the customer whose upcoming invoice you’d like to retrieve.

• #customer_details ⇒ Object

  Details about the customer you want to invoice or overrides for an existing customer.

• #discounts ⇒ Object

  The coupons to redeem into discounts for the invoice preview.

• #expand ⇒ Object

  Specifies which fields in the response should be expanded.

• #invoice_items ⇒ Object

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

• #issuer ⇒ Object

  The connected account that issues the invoice.

• #on_behalf_of ⇒ Object

  The account (if any) for which the funds of the invoice payment are intended.

• #preview_mode ⇒ Object

  Customizes the types of values to include when calculating the invoice.

• #schedule ⇒ Object

  The identifier of the schedule whose upcoming invoice you’d like to retrieve.

• #schedule_details ⇒ Object

  The schedule creation or modification params to apply as a preview.

• #subscription ⇒ Object

  The identifier of the subscription for which you’d like to retrieve the upcoming invoice.

• #subscription_details ⇒ Object

  The subscription creation or modification params to apply as a preview.

Instance Method Summary

• #initialize(automatic_tax: nil, coupon: 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 constructor

  A new instance of CreatePreviewParams.

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(automatic_tax: nil, coupon: 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.

# File 'lib/stripe/resources/invoice.rb', line 9008

def initialize(
  automatic_tax: nil,
  coupon: 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
  @coupon = coupon
  @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.

# File 'lib/stripe/resources/invoice.rb', line 8964

def automatic_tax
  @automatic_tax
end

#coupon ⇒ Object

The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use ‘discounts` instead.

# File 'lib/stripe/resources/invoice.rb', line 8967

def coupon
  @coupon
end

#currency ⇒ Object

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

# File 'lib/stripe/resources/invoice.rb', line 8970

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.

# File 'lib/stripe/resources/invoice.rb', line 8973

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.

# File 'lib/stripe/resources/invoice.rb', line 8976

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.

# File 'lib/stripe/resources/invoice.rb', line 8979

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.

# File 'lib/stripe/resources/invoice.rb', line 8982

def expand
  @expand
end

#invoice_items ⇒ Object

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

# File 'lib/stripe/resources/invoice.rb', line 8985

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.

# File 'lib/stripe/resources/invoice.rb', line 8988

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.

# File 'lib/stripe/resources/invoice.rb', line 8991

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.

# File 'lib/stripe/resources/invoice.rb', line 8994

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.

# File 'lib/stripe/resources/invoice.rb', line 8997

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.

# File 'lib/stripe/resources/invoice.rb', line 9000

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.

# File 'lib/stripe/resources/invoice.rb', line 9003

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.

# File 'lib/stripe/resources/invoice.rb', line 9006

def subscription_details
  @subscription_details
end