forked from stripe/stripe-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
invoice.go
544 lines (475 loc) · 27.1 KB
/
invoice.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
package stripe
import (
"encoding/json"
"github.com/HRInnovationLab/stripe-go/v72/form"
)
// InvoiceLineType is the list of allowed values for the invoice line's type.
type InvoiceLineType string
// List of values that InvoiceLineType can take.
const (
InvoiceLineTypeInvoiceItem InvoiceLineType = "invoiceitem"
InvoiceLineTypeSubscription InvoiceLineType = "subscription"
)
type InvoiceAutomaticTaxStatus string
const (
InvoiceAutomaticTaxStatusComplete InvoiceAutomaticTaxStatus = "complete"
InvoiceAutomaticTaxStatusFailed InvoiceAutomaticTaxStatus = "failed"
InvoiceAutomaticTaxStatusRequiresLocationInputs InvoiceAutomaticTaxStatus = "requires_location_inputs"
)
// InvoiceBillingReason is the reason why a given invoice was created
type InvoiceBillingReason string
// List of values that InvoiceBillingReason can take.
const (
InvoiceBillingReasonManual InvoiceBillingReason = "manual"
InvoiceBillingReasonSubscription InvoiceBillingReason = "subscription"
InvoiceBillingReasonSubscriptionCreate InvoiceBillingReason = "subscription_create"
InvoiceBillingReasonSubscriptionCycle InvoiceBillingReason = "subscription_cycle"
InvoiceBillingReasonSubscriptionThreshold InvoiceBillingReason = "subscription_threshold"
InvoiceBillingReasonSubscriptionUpdate InvoiceBillingReason = "subscription_update"
InvoiceBillingReasonUpcoming InvoiceBillingReason = "upcoming"
)
// InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure represents
// the options for requesting 3D Secure.
type InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure string
// List of values that InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure can take.
const (
InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecureAny InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure = "any"
InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecureAutomatic InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure = "automatic"
)
// InvoicePaymentSettingsPaymentMethodType represents the payment method type to provide to the invoice's PaymentIntent.
type InvoicePaymentSettingsPaymentMethodType string
// List of values that InvoicePaymentSettingsPaymentMethodType can take.
const (
InvoicePaymentSettingsPaymentMethodTypeAchCreditTransfer InvoicePaymentSettingsPaymentMethodType = "ach_credit_transfer"
InvoicePaymentSettingsPaymentMethodTypeAchDebit InvoicePaymentSettingsPaymentMethodType = "ach_debit"
InvoicePaymentSettingsPaymentMethodTypeAUBECSDebit InvoicePaymentSettingsPaymentMethodType = "au_becs_debit"
InvoicePaymentSettingsPaymentMethodTypeBACSDebit InvoicePaymentSettingsPaymentMethodType = "bacs_debit"
InvoicePaymentSettingsPaymentMethodTypeBancontact InvoicePaymentSettingsPaymentMethodType = "bancontact"
InvoicePaymentSettingsPaymentMethodTypeBoleto InvoicePaymentSettingsPaymentMethodType = "boleto"
InvoicePaymentSettingsPaymentMethodTypeCard InvoicePaymentSettingsPaymentMethodType = "card"
InvoicePaymentSettingsPaymentMethodTypeFPX InvoicePaymentSettingsPaymentMethodType = "fpx"
InvoicePaymentSettingsPaymentMethodTypeGiropay InvoicePaymentSettingsPaymentMethodType = "giropay"
InvoicePaymentSettingsPaymentMethodTypeIdeal InvoicePaymentSettingsPaymentMethodType = "ideal"
InvoicePaymentSettingsPaymentMethodTypeSepaCreditTransfer InvoicePaymentSettingsPaymentMethodType = "sepa_credit_transfer"
InvoicePaymentSettingsPaymentMethodTypeSepaDebit InvoicePaymentSettingsPaymentMethodType = "sepa_debit"
InvoicePaymentSettingsPaymentMethodTypeSofort InvoicePaymentSettingsPaymentMethodType = "sofort"
InvoicePaymentSettingsPaymentMethodTypeWechatPay InvoicePaymentSettingsPaymentMethodType = "wechat_pay"
)
// InvoiceStatus is the reason why a given invoice was created
type InvoiceStatus string
// List of values that InvoiceStatus can take.
const (
InvoiceStatusDraft InvoiceStatus = "draft"
InvoiceStatusOpen InvoiceStatus = "open"
InvoiceStatusPaid InvoiceStatus = "paid"
InvoiceStatusUncollectible InvoiceStatus = "uncollectible"
InvoiceStatusVoid InvoiceStatus = "void"
)
// InvoiceCollectionMethod is the type of collection method for this invoice.
type InvoiceCollectionMethod string
// List of values that InvoiceCollectionMethod can take.
const (
InvoiceCollectionMethodChargeAutomatically InvoiceCollectionMethod = "charge_automatically"
InvoiceCollectionMethodSendInvoice InvoiceCollectionMethod = "send_invoice"
)
type InvoiceUpcomingAutomaticTaxParams struct {
Enabled *bool `form:"enabled"`
}
type InvoiceUpcomingCustomerDetailsShippingParams struct {
Address *AddressParams `form:"address"`
Name *string `form:"name"`
Phone *string `form:"phone"`
}
type InvoiceUpcomingCustomerDetailsTaxParams struct {
IPAddress *string `form:"ip_address"`
}
type InvoiceUpcomingCustomerDetailsTaxIDParams struct {
Type *string `form:"type"`
Value *string `form:"value"`
}
type InvoiceUpcomingCustomerDetailsParams struct {
Address *AddressParams `form:"address"`
Shipping *InvoiceUpcomingCustomerDetailsShippingParams `form:"shipping"`
Tax *InvoiceUpcomingCustomerDetailsTaxParams `form:"tax"`
TaxExempt *string `form:"tax_exempt"`
TaxIDs []*InvoiceUpcomingCustomerDetailsTaxIDParams `form:"tax_ids"`
}
// InvoiceUpcomingInvoiceItemPeriodParams represents the period associated with that invoice item
type InvoiceUpcomingInvoiceItemPeriodParams struct {
End *int64 `form:"end"`
Start *int64 `form:"start"`
}
// InvoiceUpcomingInvoiceItemParams is the set of parameters that can be used when adding or modifying
// invoice items on an upcoming invoice.
// For more details see https://stripe.com/docs/api#upcoming_invoice-invoice_items.
type InvoiceUpcomingInvoiceItemParams struct {
Amount *int64 `form:"amount"`
Currency *string `form:"currency"`
Description *string `form:"description"`
Discountable *bool `form:"discountable"`
Discounts []*InvoiceItemDiscountParams `form:"discounts"`
InvoiceItem *string `form:"invoiceitem"`
Period *InvoiceUpcomingInvoiceItemPeriodParams `form:"period"`
Price *string `form:"price"`
PriceData *InvoiceItemPriceDataParams `form:"price_data"`
Quantity *int64 `form:"quantity"`
Schedule *string `form:"schedule"`
TaxRates []*string `form:"tax_rates"`
UnitAmount *int64 `form:"unit_amount"`
UnitAmountDecimal *float64 `form:"unit_amount_decimal,high_precision"`
}
type InvoiceAutomaticTaxParams struct {
Enabled *bool `form:"enabled"`
}
// InvoiceCustomFieldParams represents the parameters associated with one custom field on an invoice.
type InvoiceCustomFieldParams struct {
Name *string `form:"name"`
Value *string `form:"value"`
}
// InvoiceDiscountParams represents the parameters associated with the discounts to apply to an invoice.
type InvoiceDiscountParams struct {
Coupon *string `form:"coupon"`
Discount *string `form:"discount"`
}
// InvoicePaymentSettingsPaymentMethodOptionsBancontactParams is the set of parameters allowed for
// bancontact on payment_method_options on payment_settings on an invoice.
type InvoicePaymentSettingsPaymentMethodOptionsBancontactParams struct {
PreferredLanguage *string `form:"preferred_language"`
}
// InvoicePaymentSettingsPaymentMethodOptionsCardParams is the set of parameters allowed for
// payment method options when using the card payment method.
type InvoicePaymentSettingsPaymentMethodOptionsCardParams struct {
RequestThreeDSecure *string `form:"request_three_d_secure"`
}
// InvoicePaymentSettingsPaymentMethodOptionsParams is the set of parameters allowed for
// specific payment methods on an invoice's payment settings.
type InvoicePaymentSettingsPaymentMethodOptionsParams struct {
Bancontact *InvoicePaymentSettingsPaymentMethodOptionsBancontactParams `form:"bancontact"`
Card *InvoicePaymentSettingsPaymentMethodOptionsCardParams `form:"card"`
}
// InvoicePaymentSettingsParams is the set of parameters allowed for the payment_settings on an invoice.
type InvoicePaymentSettingsParams struct {
PaymentMethodOptions *InvoicePaymentSettingsPaymentMethodOptionsParams `form:"payment_method_options"`
PaymentMethodTypes []*string `form:"payment_method_types"`
}
// InvoiceTransferDataParams is the set of parameters allowed for the transfer_data hash.
type InvoiceTransferDataParams struct {
Amount *int64 `form:"amount"`
Destination *string `form:"destination"`
}
// InvoiceParams is the set of parameters that can be used when creating or updating an invoice.
// For more details see https://stripe.com/docs/api#create_invoice, https://stripe.com/docs/api#update_invoice.
type InvoiceParams struct {
Params `form:"*"`
AccountTaxIDs []*string `form:"account_tax_ids"`
AutoAdvance *bool `form:"auto_advance"`
ApplicationFeeAmount *int64 `form:"application_fee_amount"`
AutomaticTax *InvoiceAutomaticTaxParams `form:"automatic_tax"`
CollectionMethod *string `form:"collection_method"`
CustomFields []*InvoiceCustomFieldParams `form:"custom_fields"`
Customer *string `form:"customer"`
DaysUntilDue *int64 `form:"days_until_due"`
DefaultPaymentMethod *string `form:"default_payment_method"`
DefaultSource *string `form:"default_source"`
DefaultTaxRates []*string `form:"default_tax_rates"`
Description *string `form:"description"`
Discounts []*InvoiceDiscountParams `form:"discounts"`
DueDate *int64 `form:"due_date"`
Footer *string `form:"footer"`
OnBehalfOf *string `form:"on_behalf_of"`
Paid *bool `form:"paid"`
PaymentSettings *InvoicePaymentSettingsParams `form:"payment_settings"`
StatementDescriptor *string `form:"statement_descriptor"`
Subscription *string `form:"subscription"`
TransferData *InvoiceTransferDataParams `form:"transfer_data"`
// These are all for exclusive use by GetNext.
Coupon *string `form:"coupon"`
CustomerDetails *InvoiceUpcomingCustomerDetailsParams `form:"customer_details"`
InvoiceItems []*InvoiceUpcomingInvoiceItemParams `form:"invoice_items"`
SubscriptionBillingCycleAnchor *int64 `form:"subscription_billing_cycle_anchor"`
SubscriptionBillingCycleAnchorNow *bool `form:"-"` // See custom AppendTo
SubscriptionBillingCycleAnchorUnchanged *bool `form:"-"` // See custom AppendTo
SubscriptionCancelAt *int64 `form:"subscription_cancel_at"`
SubscriptionCancelAtPeriodEnd *bool `form:"subscription_cancel_at_period_end"`
SubscriptionCancelNow *bool `form:"subscription_cancel_now"`
SubscriptionDefaultTaxRates []*string `form:"subscription_default_tax_rates"`
SubscriptionItems []*SubscriptionItemsParams `form:"subscription_items"`
SubscriptionPlan *string `form:"subscription_plan"`
SubscriptionProrationBehavior *string `form:"subscription_proration_behavior"`
SubscriptionProrationDate *int64 `form:"subscription_proration_date"`
SubscriptionQuantity *int64 `form:"subscription_quantity"`
SubscriptionStartDate *int64 `form:"subscription_start_date"`
SubscriptionTrialEnd *int64 `form:"subscription_trial_end"`
SubscriptionTrialEndNow *bool `form:"-"` // See custom AppendTo
SubscriptionTrialFromPlan *bool `form:"subscription_trial_from_plan"`
}
// AppendTo implements custom encoding logic for InvoiceParams so that the special
// "now" value for subscription_billing_cycle_anchor can be implemented
// (they're otherwise timestamps rather than strings).
func (p *InvoiceParams) AppendTo(body *form.Values, keyParts []string) {
if BoolValue(p.SubscriptionBillingCycleAnchorNow) {
body.Add(form.FormatKey(append(keyParts, "subscription_billing_cycle_anchor")), "now")
}
if BoolValue(p.SubscriptionBillingCycleAnchorUnchanged) {
body.Add(form.FormatKey(append(keyParts, "subscription_billing_cycle_anchor")), "unchanged")
}
if BoolValue(p.SubscriptionTrialEndNow) {
body.Add(form.FormatKey(append(keyParts, "subscription_trial_end")), "now")
}
}
// InvoiceListParams is the set of parameters that can be used when listing invoices.
// For more details see https://stripe.com/docs/api#list_customer_invoices.
type InvoiceListParams struct {
ListParams `form:"*"`
CollectionMethod *string `form:"collection_method"`
Customer *string `form:"customer"`
Created *int64 `form:"created"`
CreatedRange *RangeQueryParams `form:"created"`
DueDate *int64 `form:"due_date"`
DueDateRange *RangeQueryParams `form:"due_date"`
Status *string `form:"status"`
Subscription *string `form:"subscription"`
}
// InvoiceLineListParams is the set of parameters that can be used when listing invoice line items.
// For more details see https://stripe.com/docs/api#invoice_lines.
type InvoiceLineListParams struct {
ListParams `form:"*"`
Customer *string `form:"customer"`
// ID is the invoice ID to list invoice lines for.
ID *string `form:"-"` // Goes in the URL
Subscription *string `form:"subscription"`
}
// InvoiceFinalizeParams is the set of parameters that can be used when finalizing invoices.
type InvoiceFinalizeParams struct {
Params `form:"*"`
AutoAdvance *bool `form:"auto_advance"`
}
// InvoiceMarkUncollectibleParams is the set of parameters that can be used when marking
// invoices as uncollectible.
type InvoiceMarkUncollectibleParams struct {
Params `form:"*"`
}
// InvoicePayParams is the set of parameters that can be used when
// paying invoices. For more details, see:
// https://stripe.com/docs/api#pay_invoice.
type InvoicePayParams struct {
Params `form:"*"`
Forgive *bool `form:"forgive"`
OffSession *bool `form:"off_session"`
PaidOutOfBand *bool `form:"paid_out_of_band"`
PaymentMethod *string `form:"payment_method"`
Source *string `form:"source"`
}
// InvoiceSendParams is the set of parameters that can be used when sending invoices.
type InvoiceSendParams struct {
Params `form:"*"`
}
// InvoiceVoidParams is the set of parameters that can be used when voiding invoices.
type InvoiceVoidParams struct {
Params `form:"*"`
}
// Invoice is the resource representing a Stripe invoice.
// For more details see https://stripe.com/docs/api#invoice_object.
type Invoice struct {
APIResource
AccountCountry string `json:"account_country"`
AccountName string `json:"account_name"`
AccountTaxIDs []*TaxID `json:"account_tax_ids"`
AmountDue int64 `json:"amount_due"`
AmountPaid int64 `json:"amount_paid"`
AmountRemaining int64 `json:"amount_remaining"`
ApplicationFeeAmount int64 `json:"application_fee_amount"`
AttemptCount int64 `json:"attempt_count"`
Attempted bool `json:"attempted"`
AutoAdvance bool `json:"auto_advance"`
AutomaticTax *InvoiceAutomaticTax `json:"automatic_tax"`
BillingReason InvoiceBillingReason `json:"billing_reason"`
Charge *Charge `json:"charge"`
CollectionMethod *InvoiceCollectionMethod `json:"collection_method"`
Created int64 `json:"created"`
Currency Currency `json:"currency"`
CustomFields []*InvoiceCustomField `json:"custom_fields"`
Customer *Customer `json:"customer"`
CustomerAddress *Address `json:"customer_address"`
CustomerEmail string `json:"customer_email"`
CustomerName *string `json:"customer_name"`
CustomerPhone *string `json:"customer_phone"`
CustomerShipping *CustomerShippingDetails `json:"customer_shipping"`
CustomerTaxExempt CustomerTaxExempt `json:"customer_tax_exempt"`
CustomerTaxIDs []*InvoiceCustomerTaxID `json:"customer_tax_ids"`
DefaultPaymentMethod *PaymentMethod `json:"default_payment_method"`
DefaultSource *PaymentSource `json:"default_source"`
DefaultTaxRates []*TaxRate `json:"default_tax_rates"`
Deleted bool `json:"deleted"`
Description string `json:"description"`
Discount *Discount `json:"discount"`
Discounts []*Discount `json:"discounts"`
DueDate int64 `json:"due_date"`
EndingBalance int64 `json:"ending_balance"`
Footer string `json:"footer"`
HostedInvoiceURL string `json:"hosted_invoice_url"`
ID string `json:"id"`
InvoicePDF string `json:"invoice_pdf"`
LastFinalizationError *Error `json:"last_finalization_error"`
Lines *InvoiceLineList `json:"lines"`
Livemode bool `json:"livemode"`
Metadata map[string]string `json:"metadata"`
NextPaymentAttempt int64 `json:"next_payment_attempt"`
Number string `json:"number"`
Object string `json:"object"`
OnBehalfOf *Account `json:"on_behalf_of"`
Paid bool `json:"paid"`
PaymentIntent *PaymentIntent `json:"payment_intent"`
PaymentSettings *InvoicePaymentSettings `json:"payment_settings"`
PeriodEnd int64 `json:"period_end"`
PeriodStart int64 `json:"period_start"`
PostPaymentCreditNotesAmount int64 `json:"post_payment_credit_notes_amount"`
PrePaymentCreditNotesAmount int64 `json:"pre_payment_credit_notes_amount"`
ReceiptNumber string `json:"receipt_number"`
StartingBalance int64 `json:"starting_balance"`
StatementDescriptor string `json:"statement_descriptor"`
Status InvoiceStatus `json:"status"`
StatusTransitions InvoiceStatusTransitions `json:"status_transitions"`
Subscription *Subscription `json:"subscription"`
SubscriptionProrationDate int64 `json:"subscription_proration_date"`
Subtotal int64 `json:"subtotal"`
Tax int64 `json:"tax"`
ThreasholdReason *InvoiceThresholdReason `json:"threshold_reason"`
Total int64 `json:"total"`
TotalDiscountAmounts []*InvoiceDiscountAmount `json:"total_discount_amounts"`
TotalTaxAmounts []*InvoiceTaxAmount `json:"total_tax_amounts"`
TransferData *InvoiceTransferData `json:"transfer_data"`
WebhooksDeliveredAt int64 `json:"webhooks_delivered_at"`
}
type InvoiceAutomaticTax struct {
Enabled bool `json:"enabled"`
Status InvoiceAutomaticTaxStatus `json:"status"`
}
// InvoiceCustomField is a structure representing a custom field on an invoice.
type InvoiceCustomField struct {
Name string `json:"name"`
Value string `json:"value"`
}
// InvoiceCustomerTaxID is a structure representing a customer tax id on an invoice.
type InvoiceCustomerTaxID struct {
Type TaxIDType `json:"type"`
Value string `json:"value"`
}
// InvoiceDiscountAmount represents the aggregate amounts calculated per discount for all line items.
type InvoiceDiscountAmount struct {
Amount int64 `json:"amount"`
Discount *Discount `json:"discount"`
}
// InvoiceTaxAmount is a structure representing one of the tax amounts on an invoice.
type InvoiceTaxAmount struct {
Amount int64 `json:"amount"`
Inclusive bool `json:"inclusive"`
TaxRate *TaxRate `json:"tax_rate"`
}
// InvoiceThresholdReason is a structure representing a reason for a billing threshold.
type InvoiceThresholdReason struct {
AmountGTE int64 `json:"amount_gte"`
ItemReasons []*InvoiceThresholdReasonItemReason `json:"item_reasons"`
}
// InvoiceThresholdReasonItemReason is a structure representing the line items that
// triggered an invoice.
type InvoiceThresholdReasonItemReason struct {
LineItemIDs []string `json:"line_item_ids"`
UsageGTE int64 `json:"usage_gte"`
}
// InvoiceList is a list of invoices as retrieved from a list endpoint.
type InvoiceList struct {
APIResource
ListMeta
Data []*Invoice `json:"data"`
}
// InvoiceLineDiscountAmount represents the amount of discount calculated per discount for this line item.
type InvoiceLineDiscountAmount struct {
Amount int64 `json:"amount"`
Discount *Discount `json:"discount"`
}
// InvoiceLine is the resource representing a Stripe invoice line item.
// For more details see https://stripe.com/docs/api#invoice_line_item_object.
type InvoiceLine struct {
Amount int64 `json:"amount"`
Currency Currency `json:"currency"`
Description string `json:"description"`
Discountable bool `json:"discountable"`
Discounts []*Discount `json:"discounts"`
DiscountAmounts []*InvoiceLineDiscountAmount `json:"discount_amounts"`
ID string `json:"id"`
InvoiceItem string `json:"invoice_item"`
Livemode bool `json:"livemode"`
Metadata map[string]string `json:"metadata"`
Object string `json:"object"`
Period *Period `json:"period"`
Plan *Plan `json:"plan"`
Price *Price `json:"price"`
Proration bool `json:"proration"`
Quantity int64 `json:"quantity"`
Subscription string `json:"subscription"`
SubscriptionItem string `json:"subscription_item"`
TaxAmounts []*InvoiceTaxAmount `json:"tax_amounts"`
TaxRates []*TaxRate `json:"tax_rates"`
Type InvoiceLineType `json:"type"`
UnifiedProration bool `json:"unified_proration"`
}
// InvoiceTransferData represents the information for the transfer_data associated with an invoice.
type InvoiceTransferData struct {
Amount int64 `json:"amount"`
Destination *Account `json:"destination"`
}
// Period is a structure representing a start and end dates.
type Period struct {
End int64 `json:"end"`
Start int64 `json:"start"`
}
// InvoiceLineList is a list object for invoice line items.
type InvoiceLineList struct {
APIResource
ListMeta
Data []*InvoiceLine `json:"data"`
}
// InvoicePaymentSettingsPaymentMethodOptionsBancontact contains details about the Bancontact
// payment method options to pass to the invoice's PaymentIntent.
type InvoicePaymentSettingsPaymentMethodOptionsBancontact struct {
PreferredLanguage string `json:"preferred_language"`
}
// InvoicePaymentSettingsPaymentMethodOptionsCard contains details about the Card payment
// method options to pass to the invoice's PaymentIntent.
type InvoicePaymentSettingsPaymentMethodOptionsCard struct {
RequestThreeDSecure InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure `json:"request_three_d_secure"`
}
// InvoicePaymentSettingsPaymentMethodOptions represents payment-method-specific configuration to provide to the invoice's PaymentIntent.
type InvoicePaymentSettingsPaymentMethodOptions struct {
Bancontact *InvoicePaymentSettingsPaymentMethodOptionsBancontact `json:"bancontact"`
Card *InvoicePaymentSettingsPaymentMethodOptionsCard `json:"card"`
}
// InvoicePaymentSettings represents configuration settings to provide to the invoice's PaymentIntent.
type InvoicePaymentSettings struct {
PaymentMethodOptions *InvoicePaymentSettingsPaymentMethodOptions `json:"payment_method_options"`
PaymentMethodTypes []InvoicePaymentSettingsPaymentMethodType `json:"payment_method_types"`
}
// InvoiceStatusTransitions are the timestamps at which the invoice status was updated.
type InvoiceStatusTransitions struct {
FinalizedAt int64 `json:"finalized_at"`
MarkedUncollectibleAt int64 `json:"marked_uncollectible_at"`
PaidAt int64 `json:"paid_at"`
VoidedAt int64 `json:"voided_at"`
}
// UnmarshalJSON handles deserialization of an Invoice.
// This custom unmarshaling is needed because the resulting
// property may be an id or the full struct if it was expanded.
func (i *Invoice) UnmarshalJSON(data []byte) error {
if id, ok := ParseID(data); ok {
i.ID = id
return nil
}
type invoice Invoice
var v invoice
if err := json.Unmarshal(data, &v); err != nil {
return err
}
*i = Invoice(v)
return nil
}