Class: Stripe::InvoiceCreatePreviewParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/invoice_create_preview_params.rb

Defined Under Namespace

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, new, #to_h

Constructor Details

#initialize(automatic_tax: 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) ⇒ InvoiceCreatePreviewParams

Returns a new instance of InvoiceCreatePreviewParams.



1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1135

def initialize(
  automatic_tax: 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
  @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.



1105
1106
1107
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1105

def automatic_tax
  @automatic_tax
end

#currency ⇒ Object

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



1107
1108
1109
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1107

def currency
  @currency
end

#customer ⇒ Object

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



1109
1110
1111
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1109

def customer
  @customer
end

#customer_account ⇒ Object

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



1111
1112
1113
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1111

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.



1113
1114
1115
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1113

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.



1115
1116
1117
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1115

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1117
1118
1119
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1117

def expand
  @expand
end

#invoice_items ⇒ Object

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



1119
1120
1121
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1119

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.



1121
1122
1123
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1121

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](docs.stripe.com/billing/invoices/connect) documentation for details.



1123
1124
1125
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1123

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.



1125
1126
1127
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1125

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.



1127
1128
1129
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1127

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.



1129
1130
1131
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1129

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.



1131
1132
1133
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1131

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.



1133
1134
1135
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1133

def subscription_details
  @subscription_details
end

Class Method Details

.field_encodings ⇒ Object 



1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 1169

def self.field_encodings
  @field_encodings = {
    invoice_items: {
      kind: :array,
      element: {
        kind: :object,
        fields: {
          price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
          quantity_decimal: :decimal_string,
          unit_amount_decimal: :decimal_string,
        },
      },
    },
    schedule_details: {
      kind: :object,
      fields: {
        phases: {
          kind: :array,
          element: {
            kind: :object,
            fields: {
              add_invoice_items: {
                kind: :array,
                element: {
                  kind: :object,
                  fields: {
                    price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
                  },
                },
              },
              items: {
                kind: :array,
                element: {
                  kind: :object,
                  fields: {
                    price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
                  },
                },
              },
            },
          },
        },
      },
    },
    subscription_details: {
      kind: :object,
      fields: {
        items: {
          kind: :array,
          element: {
            kind: :object,
            fields: {
              price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
            },
          },
        },
      },
    },
  }
end