Class: Stripe::InvoiceService::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/invoice_service.rb

Defined Under Namespace

Classes: AmountsDue, AutomaticTax, CustomField, Discount, FromInvoice, Issuer, PaymentSettings, Rendering, ShippingCost, ShippingDetails, TransferData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(account_tax_ids: nil, amounts_due: nil, application_fee_amount: nil, auto_advance: nil, automatic_tax: nil, automatically_finalizes_at: nil, collection_method: nil, currency: nil, custom_fields: nil, customer: nil, days_until_due: nil, default_margins: nil, default_payment_method: nil, default_source: nil, default_tax_rates: nil, description: nil, discounts: nil, due_date: nil, effective_at: nil, expand: nil, footer: nil, from_invoice: nil, issuer: nil, metadata: nil, number: nil, on_behalf_of: nil, payment_settings: nil, pending_invoice_items_behavior: nil, rendering: nil, shipping_cost: nil, shipping_details: nil, statement_descriptor: nil, subscription: nil, transfer_data: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
 
# File 'lib/stripe/services/invoice_service.rb', line 1499

def initialize(
  account_tax_ids: nil,
  amounts_due: nil,
  application_fee_amount: nil,
  auto_advance: nil,
  automatic_tax: nil,
  automatically_finalizes_at: nil,
  collection_method: nil,
  currency: nil,
  custom_fields: nil,
  customer: nil,
  days_until_due: nil,
  default_margins: nil,
  default_payment_method: nil,
  default_source: nil,
  default_tax_rates: nil,
  description: nil,
  discounts: nil,
  due_date: nil,
  effective_at: nil,
  expand: nil,
  footer: nil,
  from_invoice: nil,
  issuer: nil,
  metadata: nil,
  number: nil,
  on_behalf_of: nil,
  payment_settings: nil,
  pending_invoice_items_behavior: nil,
  rendering: nil,
  shipping_cost: nil,
  shipping_details: nil,
  statement_descriptor: nil,
  subscription: nil,
  transfer_data: nil
)
  @account_tax_ids = 
  @amounts_due = amounts_due
  @application_fee_amount = application_fee_amount
  @auto_advance = auto_advance
  @automatic_tax = automatic_tax
  @automatically_finalizes_at = automatically_finalizes_at
  @collection_method = collection_method
  @currency = currency
  @custom_fields = custom_fields
  @customer = customer
  @days_until_due = days_until_due
  @default_margins = default_margins
  @default_payment_method = default_payment_method
  @default_source = default_source
  @default_tax_rates = default_tax_rates
  @description = description
  @discounts = discounts
  @due_date = due_date
  @effective_at = effective_at
  @expand = expand
  @footer = footer
  @from_invoice = from_invoice
  @issuer = issuer
  @metadata = metadata
  @number = number
  @on_behalf_of = on_behalf_of
  @payment_settings = payment_settings
  @pending_invoice_items_behavior = pending_invoice_items_behavior
  @rendering = rendering
  @shipping_cost = shipping_cost
  @shipping_details = shipping_details
  @statement_descriptor = statement_descriptor
  @subscription = subscription
  @transfer_data = transfer_data
end

Instance Attribute Details

#account_tax_ids ⇒ Object

The account tax IDs associated with the invoice. Only editable when the invoice is a draft.



1398
1399
1400
 
# File 'lib/stripe/services/invoice_service.rb', line 1398

def 
  @account_tax_ids
end

#amounts_due ⇒ Object

List of expected payments and corresponding due dates. Valid only for invoices where ‘collection_method=send_invoice`.



1401
1402
1403
 
# File 'lib/stripe/services/invoice_service.rb', line 1401

def amounts_due
  @amounts_due
end

#application_fee_amount ⇒ Object

A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](stripe.com/docs/billing/invoices/connect#collecting-fees).



1404
1405
1406
 
# File 'lib/stripe/services/invoice_service.rb', line 1404

def application_fee_amount
  @application_fee_amount
end

#auto_advance ⇒ Object

Controls whether Stripe performs [automatic collection](stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If ‘false`, the invoice’s state doesn’t automatically advance without an explicit action.



1407
1408
1409
 
# File 'lib/stripe/services/invoice_service.rb', line 1407

def auto_advance
  @auto_advance
end

#automatic_tax ⇒ Object

Settings for automatic tax lookup for this invoice.



1410
1411
1412
 
# File 'lib/stripe/services/invoice_service.rb', line 1410

def automatic_tax
  @automatic_tax
end

#automatically_finalizes_at ⇒ Object

The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state.



1413
1414
1415
 
# File 'lib/stripe/services/invoice_service.rb', line 1413

def automatically_finalizes_at
  @automatically_finalizes_at
end

#collection_method ⇒ Object

Either ‘charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.



1416
1417
1418
 
# File 'lib/stripe/services/invoice_service.rb', line 1416

def collection_method
  @collection_method
end

#currency ⇒ Object

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



1419
1420
1421
 
# File 'lib/stripe/services/invoice_service.rb', line 1419

def currency
  @currency
end

#custom_fields ⇒ Object

A list of up to 4 custom fields to be displayed on the invoice.



1422
1423
1424
 
# File 'lib/stripe/services/invoice_service.rb', line 1422

def custom_fields
  @custom_fields
end

#customer ⇒ Object

The ID of the customer who will be billed.



1425
1426
1427
 
# File 'lib/stripe/services/invoice_service.rb', line 1425

def customer
  @customer
end

#days_until_due ⇒ Object

The number of days from when the invoice is created until it is due. Valid only for invoices where ‘collection_method=send_invoice`.



1428
1429
1430
 
# File 'lib/stripe/services/invoice_service.rb', line 1428

def days_until_due
  @days_until_due
end

#default_margins ⇒ Object

The ids of the margins to apply to the invoice. Can be overridden by line item ‘margins`.



1431
1432
1433
 
# File 'lib/stripe/services/invoice_service.rb', line 1431

def default_margins
  @default_margins
end

#default_payment_method ⇒ Object

ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription’s default payment method, if any, or to the default payment method in the customer’s invoice settings.



1434
1435
1436
 
# File 'lib/stripe/services/invoice_service.rb', line 1434

def default_payment_method
  @default_payment_method
end

#default_source ⇒ Object

ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription’s default source, if any, or to the customer’s default source.



1437
1438
1439
 
# File 'lib/stripe/services/invoice_service.rb', line 1437

def default_source
  @default_source
end

#default_tax_rates ⇒ Object

The tax rates that will apply to any line item that does not have ‘tax_rates` set.



1440
1441
1442
 
# File 'lib/stripe/services/invoice_service.rb', line 1440

def default_tax_rates
  @default_tax_rates
end

#description ⇒ Object

An arbitrary string attached to the object. Often useful for displaying to users. Referenced as ‘memo’ in the Dashboard.



1443
1444
1445
 
# File 'lib/stripe/services/invoice_service.rb', line 1443

def description
  @description
end

#discounts ⇒ Object

The coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice’s customer. Pass an empty string to avoid inheriting any discounts.



1446
1447
1448
 
# File 'lib/stripe/services/invoice_service.rb', line 1446

def discounts
  @discounts
end

#due_date ⇒ Object

The date on which payment for this invoice is due. Valid only for invoices where ‘collection_method=send_invoice`.



1449
1450
1451
 
# File 'lib/stripe/services/invoice_service.rb', line 1449

def due_date
  @due_date
end

#effective_at ⇒ Object

The date when this invoice is in effect. Same as ‘finalized_at` unless overwritten. When defined, this value replaces the system-generated ’Date of issue’ printed on the invoice PDF and receipt.



1452
1453
1454
 
# File 'lib/stripe/services/invoice_service.rb', line 1452

def effective_at
  @effective_at
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1455
1456
1457
 
# File 'lib/stripe/services/invoice_service.rb', line 1455

def expand
  @expand
end

#footer ⇒ Object

Footer to be displayed on the invoice.



1458
1459
1460
 
# File 'lib/stripe/services/invoice_service.rb', line 1458

def footer
  @footer
end

#from_invoice ⇒ Object

Revise an existing invoice. The new invoice will be created in ‘status=draft`. See the [revision documentation](stripe.com/docs/invoicing/invoice-revisions) for more details.



1461
1462
1463
 
# File 'lib/stripe/services/invoice_service.rb', line 1461

def from_invoice
  @from_invoice
end

#issuer ⇒ Object

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



1464
1465
1466
 
# File 'lib/stripe/services/invoice_service.rb', line 1464

def issuer
  @issuer
end

#metadata ⇒ Object

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



1467
1468
1469
 
# File 'lib/stripe/services/invoice_service.rb', line 1467

def metadata
  @metadata
end

#number ⇒ Object

Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.



1470
1471
1472
 
# File 'lib/stripe/services/invoice_service.rb', line 1470

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



1473
1474
1475
 
# File 'lib/stripe/services/invoice_service.rb', line 1473

def on_behalf_of
  @on_behalf_of
end

#payment_settings ⇒ Object

Configuration settings for the PaymentIntent that is generated when the invoice is finalized.



1476
1477
1478
 
# File 'lib/stripe/services/invoice_service.rb', line 1476

def payment_settings
  @payment_settings
end

#pending_invoice_items_behavior ⇒ Object

How to handle pending invoice items on invoice creation. Defaults to ‘exclude` if the parameter is omitted.



1479
1480
1481
 
# File 'lib/stripe/services/invoice_service.rb', line 1479

def pending_invoice_items_behavior
  @pending_invoice_items_behavior
end

#rendering ⇒ Object

The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.



1482
1483
1484
 
# File 'lib/stripe/services/invoice_service.rb', line 1482

def rendering
  @rendering
end

#shipping_cost ⇒ Object

Settings for the cost of shipping for this invoice.



1485
1486
1487
 
# File 'lib/stripe/services/invoice_service.rb', line 1485

def shipping_cost
  @shipping_cost
end

#shipping_details ⇒ Object

Shipping details for the invoice. The Invoice PDF will use the ‘shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.



1488
1489
1490
 
# File 'lib/stripe/services/invoice_service.rb', line 1488

def shipping_details
  @shipping_details
end

#statement_descriptor ⇒ Object

Extra information about a charge for the customer’s credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default ‘statement_descriptor` will be set to the first subscription item’s product’s ‘statement_descriptor`.



1491
1492
1493
 
# File 'lib/stripe/services/invoice_service.rb', line 1491

def statement_descriptor
  @statement_descriptor
end

#subscription ⇒ Object

The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription’s billing cycle and regular subscription events won’t be affected.



1494
1495
1496
 
# File 'lib/stripe/services/invoice_service.rb', line 1494

def subscription
  @subscription
end

#transfer_data ⇒ Object

If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice’s charge.



1497
1498
1499
 
# File 'lib/stripe/services/invoice_service.rb', line 1497

def transfer_data
  @transfer_data
end