orb-billing 5.9.0 → 5.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/package.json +1 -1
  3. package/resources/shared.d.ts +539 -1
  4. package/resources/shared.d.ts.map +1 -1
  5. package/resources/shared.js.map +1 -1
  6. package/resources/shared.mjs.map +1 -1
  7. package/src/resources/shared.ts +672 -1
  8. package/src/version.ts +1 -1
  9. package/version.d.ts +1 -1
  10. package/version.d.ts.map +1 -1
  11. package/version.js +1 -1
  12. package/version.js.map +1 -1
  13. package/version.mjs +1 -1
  14. package/version.mjs.map +1 -1
package/resources/shared.d.ts CHANGED
@@ -140,7 +140,7 @@ export interface ChangedSubscriptionResources {
140
140
  /**
141
141
  * The invoices that were created as part of this operation.
142
142
  */
143
- created_invoices: Array<Invoice>;
143
+ created_invoices: Array<ChangedSubscriptionResources.CreatedInvoice>;
144
144
  /**
145
145
  * The credit notes that were voided as part of this operation.
146
146
  */
@@ -150,6 +150,517 @@ export interface ChangedSubscriptionResources {
150
150
  */
151
151
  voided_invoices: Array<Invoice>;
152
152
  }
153
+ export declare namespace ChangedSubscriptionResources {
154
+ interface CreatedInvoice {
155
+ id: string;
156
+ /**
157
+ * This is the final amount required to be charged to the customer and reflects the
158
+ * application of the customer balance to the `total` of the invoice.
159
+ */
160
+ amount_due: string;
161
+ auto_collection: CreatedInvoice.AutoCollection;
162
+ billing_address: Shared.Address | null;
163
+ /**
164
+ * The creation time of the resource in Orb.
165
+ */
166
+ created_at: string;
167
+ /**
168
+ * A list of credit notes associated with the invoice
169
+ */
170
+ credit_notes: Array<CreatedInvoice.CreditNote>;
171
+ /**
172
+ * An ISO 4217 currency string or `credits`
173
+ */
174
+ currency: string;
175
+ customer: Shared.CustomerMinified;
176
+ customer_balance_transactions: Array<CreatedInvoice.CustomerBalanceTransaction>;
177
+ /**
178
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
179
+ * added to the headers of invoices.
180
+ *
181
+ * ### Supported Tax ID Countries and Types
182
+ *
183
+ * | Country | Type | Description |
184
+ * | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
185
+ * | Albania | `al_tin` | Albania Tax Identification Number |
186
+ * | Andorra | `ad_nrt` | Andorran NRT Number |
187
+ * | Angola | `ao_tin` | Angola Tax Identification Number |
188
+ * | Argentina | `ar_cuit` | Argentinian Tax ID Number |
189
+ * | Armenia | `am_tin` | Armenia Tax Identification Number |
190
+ * | Aruba | `aw_tin` | Aruba Tax Identification Number |
191
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
192
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
193
+ * | Austria | `eu_vat` | European VAT Number |
194
+ * | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
195
+ * | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
196
+ * | Bahrain | `bh_vat` | Bahraini VAT Number |
197
+ * | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
198
+ * | Barbados | `bb_tin` | Barbados Tax Identification Number |
199
+ * | Belarus | `by_tin` | Belarus TIN Number |
200
+ * | Belgium | `eu_vat` | European VAT Number |
201
+ * | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
202
+ * | Bolivia | `bo_tin` | Bolivian Tax ID |
203
+ * | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
204
+ * | Brazil | `br_cnpj` | Brazilian CNPJ Number |
205
+ * | Brazil | `br_cpf` | Brazilian CPF Number |
206
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
207
+ * | Bulgaria | `eu_vat` | European VAT Number |
208
+ * | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
209
+ * | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
210
+ * | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
211
+ * | Canada | `ca_bn` | Canadian BN |
212
+ * | Canada | `ca_gst_hst` | Canadian GST/HST Number |
213
+ * | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
214
+ * | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
215
+ * | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
216
+ * | Canada | `ca_qst` | Canadian QST Number (Québec) |
217
+ * | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
218
+ * | Chile | `cl_tin` | Chilean TIN |
219
+ * | China | `cn_tin` | Chinese Tax ID |
220
+ * | Colombia | `co_nit` | Colombian NIT Number |
221
+ * | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
222
+ * | Costa Rica | `cr_tin` | Costa Rican Tax ID |
223
+ * | Croatia | `eu_vat` | European VAT Number |
224
+ * | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
225
+ * | Cyprus | `eu_vat` | European VAT Number |
226
+ * | Czech Republic | `eu_vat` | European VAT Number |
227
+ * | Denmark | `eu_vat` | European VAT Number |
228
+ * | Dominican Republic | `do_rcn` | Dominican RCN Number |
229
+ * | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
230
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
231
+ * | El Salvador | `sv_nit` | El Salvadorian NIT Number |
232
+ * | Estonia | `eu_vat` | European VAT Number |
233
+ * | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
234
+ * | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
235
+ * | Finland | `eu_vat` | European VAT Number |
236
+ * | France | `eu_vat` | European VAT Number |
237
+ * | Georgia | `ge_vat` | Georgian VAT |
238
+ * | Germany | `de_stn` | German Tax Number (Steuernummer) |
239
+ * | Germany | `eu_vat` | European VAT Number |
240
+ * | Greece | `eu_vat` | European VAT Number |
241
+ * | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
242
+ * | Hong Kong | `hk_br` | Hong Kong BR Number |
243
+ * | Hungary | `eu_vat` | European VAT Number |
244
+ * | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
245
+ * | Iceland | `is_vat` | Icelandic VAT |
246
+ * | India | `in_gst` | Indian GST Number |
247
+ * | Indonesia | `id_npwp` | Indonesian NPWP Number |
248
+ * | Ireland | `eu_vat` | European VAT Number |
249
+ * | Israel | `il_vat` | Israel VAT |
250
+ * | Italy | `eu_vat` | European VAT Number |
251
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
252
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
253
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
254
+ * | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
255
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
256
+ * | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
257
+ * | Laos | `la_tin` | Laos Tax Identification Number |
258
+ * | Latvia | `eu_vat` | European VAT Number |
259
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
260
+ * | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
261
+ * | Lithuania | `eu_vat` | European VAT Number |
262
+ * | Luxembourg | `eu_vat` | European VAT Number |
263
+ * | Malaysia | `my_frp` | Malaysian FRP Number |
264
+ * | Malaysia | `my_itn` | Malaysian ITN |
265
+ * | Malaysia | `my_sst` | Malaysian SST Number |
266
+ * | Malta | `eu_vat` | European VAT Number |
267
+ * | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
268
+ * | Mexico | `mx_rfc` | Mexican RFC Number |
269
+ * | Moldova | `md_vat` | Moldova VAT Number |
270
+ * | Montenegro | `me_pib` | Montenegro PIB Number |
271
+ * | Morocco | `ma_vat` | Morocco VAT Number |
272
+ * | Nepal | `np_pan` | Nepal PAN Number |
273
+ * | Netherlands | `eu_vat` | European VAT Number |
274
+ * | New Zealand | `nz_gst` | New Zealand GST Number |
275
+ * | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
276
+ * | North Macedonia | `mk_vat` | North Macedonia VAT Number |
277
+ * | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
278
+ * | Norway | `no_vat` | Norwegian VAT Number |
279
+ * | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
280
+ * | Oman | `om_vat` | Omani VAT Number |
281
+ * | Peru | `pe_ruc` | Peruvian RUC Number |
282
+ * | Philippines | `ph_tin` | Philippines Tax Identification Number |
283
+ * | Poland | `eu_vat` | European VAT Number |
284
+ * | Portugal | `eu_vat` | European VAT Number |
285
+ * | Romania | `eu_vat` | European VAT Number |
286
+ * | Romania | `ro_tin` | Romanian Tax ID Number |
287
+ * | Russia | `ru_inn` | Russian INN |
288
+ * | Russia | `ru_kpp` | Russian KPP |
289
+ * | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
290
+ * | Senegal | `sn_ninea` | Senegal NINEA Number |
291
+ * | Serbia | `rs_pib` | Serbian PIB Number |
292
+ * | Singapore | `sg_gst` | Singaporean GST |
293
+ * | Singapore | `sg_uen` | Singaporean UEN |
294
+ * | Slovakia | `eu_vat` | European VAT Number |
295
+ * | Slovenia | `eu_vat` | European VAT Number |
296
+ * | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
297
+ * | South Africa | `za_vat` | South African VAT Number |
298
+ * | South Korea | `kr_brn` | Korean BRN |
299
+ * | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
300
+ * | Spain | `eu_vat` | European VAT Number |
301
+ * | Suriname | `sr_fin` | Suriname FIN Number |
302
+ * | Sweden | `eu_vat` | European VAT Number |
303
+ * | Switzerland | `ch_uid` | Switzerland UID Number |
304
+ * | Switzerland | `ch_vat` | Switzerland VAT Number |
305
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
306
+ * | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
307
+ * | Tanzania | `tz_vat` | Tanzania VAT Number |
308
+ * | Thailand | `th_vat` | Thai VAT |
309
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
310
+ * | Uganda | `ug_tin` | Uganda Tax Identification Number |
311
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
312
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
313
+ * | United Kingdom | `gb_vat` | United Kingdom VAT Number |
314
+ * | United States | `us_ein` | United States EIN |
315
+ * | Uruguay | `uy_ruc` | Uruguayan RUC Number |
316
+ * | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
317
+ * | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
318
+ * | Venezuela | `ve_rif` | Venezuelan RIF Number |
319
+ * | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
320
+ * | Zambia | `zm_tin` | Zambia Tax Identification Number |
321
+ * | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
322
+ */
323
+ customer_tax_id: Shared.CustomerTaxID | null;
324
+ /**
325
+ * @deprecated This field is deprecated in favor of `discounts`. If a `discounts`
326
+ * list is provided, the first discount in the list will be returned. If the list
327
+ * is empty, `None` will be returned.
328
+ */
329
+ discount: unknown;
330
+ discounts: Array<Shared.InvoiceLevelDiscount>;
331
+ /**
332
+ * When the invoice payment is due. The due date is null if the invoice is not yet
333
+ * finalized.
334
+ */
335
+ due_date: string | null;
336
+ /**
337
+ * If the invoice has a status of `draft`, this will be the time that the invoice
338
+ * will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is
339
+ * true, the invoice will automatically begin issuing at this time.
340
+ */
341
+ eligible_to_issue_at: string | null;
342
+ /**
343
+ * A URL for the customer-facing invoice portal. This URL expires 30 days after the
344
+ * invoice's due date, or 60 days after being re-generated through the UI.
345
+ */
346
+ hosted_invoice_url: string | null;
347
+ /**
348
+ * The scheduled date of the invoice
349
+ */
350
+ invoice_date: string;
351
+ /**
352
+ * Automatically generated invoice number to help track and reconcile invoices.
353
+ * Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per
354
+ * account or customer.
355
+ */
356
+ invoice_number: string;
357
+ /**
358
+ * The link to download the PDF representation of the `Invoice`.
359
+ */
360
+ invoice_pdf: string | null;
361
+ invoice_source: 'subscription' | 'partial' | 'one_off';
362
+ /**
363
+ * True if the invoice has only in-advance fixed fees and is payable now
364
+ */
365
+ is_payable_now: boolean;
366
+ /**
367
+ * If the invoice failed to issue, this will be the last time it failed to issue
368
+ * (even if it is now in a different state.)
369
+ */
370
+ issue_failed_at: string | null;
371
+ /**
372
+ * If the invoice has been issued, this will be the time it transitioned to
373
+ * `issued` (even if it is now in a different state.)
374
+ */
375
+ issued_at: string | null;
376
+ /**
377
+ * The breakdown of prices in this invoice.
378
+ */
379
+ line_items: Array<CreatedInvoice.LineItem>;
380
+ maximum: Shared.Maximum | null;
381
+ maximum_amount: string | null;
382
+ /**
383
+ * Free-form text which is available on the invoice PDF and the Orb invoice portal.
384
+ */
385
+ memo: string | null;
386
+ /**
387
+ * User specified key-value pairs for the resource. If not present, this defaults
388
+ * to an empty dictionary. Individual keys can be removed by setting the value to
389
+ * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
390
+ * `null`.
391
+ */
392
+ metadata: {
393
+ [key: string]: string;
394
+ };
395
+ minimum: Shared.Minimum | null;
396
+ minimum_amount: string | null;
397
+ /**
398
+ * If the invoice has a status of `paid`, this gives a timestamp when the invoice
399
+ * was paid.
400
+ */
401
+ paid_at: string | null;
402
+ /**
403
+ * A list of payment attempts associated with the invoice
404
+ */
405
+ payment_attempts: Array<CreatedInvoice.PaymentAttempt>;
406
+ /**
407
+ * If payment was attempted on this invoice but failed, this will be the time of
408
+ * the most recent attempt.
409
+ */
410
+ payment_failed_at: string | null;
411
+ /**
412
+ * If payment was attempted on this invoice, this will be the start time of the
413
+ * most recent attempt. This field is especially useful for delayed-notification
414
+ * payment mechanisms (like bank transfers), where payment can take 3 days or more.
415
+ */
416
+ payment_started_at: string | null;
417
+ /**
418
+ * If the invoice is in draft, this timestamp will reflect when the invoice is
419
+ * scheduled to be issued.
420
+ */
421
+ scheduled_issue_at: string | null;
422
+ shipping_address: Shared.Address | null;
423
+ status: 'issued' | 'paid' | 'synced' | 'void' | 'draft';
424
+ subscription: Shared.SubscriptionMinified | null;
425
+ /**
426
+ * The total before any discounts and minimums are applied.
427
+ */
428
+ subtotal: string;
429
+ /**
430
+ * If the invoice failed to sync, this will be the last time an external invoicing
431
+ * provider sync was attempted. This field will always be `null` for invoices using
432
+ * Orb Invoicing.
433
+ */
434
+ sync_failed_at: string | null;
435
+ /**
436
+ * The total after any minimums and discounts have been applied.
437
+ */
438
+ total: string;
439
+ /**
440
+ * If the invoice has a status of `void`, this gives a timestamp when the invoice
441
+ * was voided.
442
+ */
443
+ voided_at: string | null;
444
+ /**
445
+ * This is true if the invoice will be automatically issued in the future, and
446
+ * false otherwise.
447
+ */
448
+ will_auto_issue: boolean;
449
+ }
450
+ namespace CreatedInvoice {
451
+ interface AutoCollection {
452
+ /**
453
+ * True only if auto-collection is enabled for this invoice.
454
+ */
455
+ enabled: boolean | null;
456
+ /**
457
+ * If the invoice is scheduled for auto-collection, this field will reflect when
458
+ * the next attempt will occur. If dunning has been exhausted, or auto-collection
459
+ * is not enabled for this invoice, this field will be `null`.
460
+ */
461
+ next_attempt_at: string | null;
462
+ /**
463
+ * Number of auto-collection payment attempts.
464
+ */
465
+ num_attempts: number | null;
466
+ /**
467
+ * If Orb has ever attempted payment auto-collection for this invoice, this field
468
+ * will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
469
+ * this can be used to tell whether the invoice is currently in dunning (that is,
470
+ * `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or
471
+ * if dunning has been exhausted (`previously_attempted_at` is non-null, but
472
+ * `next_attempt_time` is null).
473
+ */
474
+ previously_attempted_at: string | null;
475
+ }
476
+ interface CreditNote {
477
+ id: string;
478
+ credit_note_number: string;
479
+ /**
480
+ * An optional memo supplied on the credit note.
481
+ */
482
+ memo: string | null;
483
+ reason: string;
484
+ total: string;
485
+ type: string;
486
+ /**
487
+ * If the credit note has a status of `void`, this gives a timestamp when the
488
+ * credit note was voided.
489
+ */
490
+ voided_at: string | null;
491
+ }
492
+ interface CustomerBalanceTransaction {
493
+ /**
494
+ * A unique id for this transaction.
495
+ */
496
+ id: string;
497
+ action: 'applied_to_invoice' | 'manual_adjustment' | 'prorated_refund' | 'revert_prorated_refund' | 'return_from_voiding' | 'credit_note_applied' | 'credit_note_voided' | 'overpayment_refund' | 'external_payment' | 'small_invoice_carryover';
498
+ /**
499
+ * The value of the amount changed in the transaction.
500
+ */
501
+ amount: string;
502
+ /**
503
+ * The creation time of this transaction.
504
+ */
505
+ created_at: string;
506
+ credit_note: Shared.CreditNoteTiny | null;
507
+ /**
508
+ * An optional description provided for manual customer balance adjustments.
509
+ */
510
+ description: string | null;
511
+ /**
512
+ * The new value of the customer's balance prior to the transaction, in the
513
+ * customer's currency.
514
+ */
515
+ ending_balance: string;
516
+ invoice: Shared.InvoiceTiny | null;
517
+ /**
518
+ * The original value of the customer's balance prior to the transaction, in the
519
+ * customer's currency.
520
+ */
521
+ starting_balance: string;
522
+ type: 'increment' | 'decrement';
523
+ }
524
+ interface LineItem {
525
+ /**
526
+ * A unique ID for this line item.
527
+ */
528
+ id: string;
529
+ /**
530
+ * The line amount after any adjustments and before overage conversion, credits and
531
+ * partial invoicing.
532
+ */
533
+ adjusted_subtotal: string;
534
+ /**
535
+ * All adjustments applied to the line item in the order they were applied based on
536
+ * invoice calculations (ie. usage discounts -> amount discounts -> percentage
537
+ * discounts -> minimums -> maximums).
538
+ */
539
+ adjustments: Array<Shared.MonetaryUsageDiscountAdjustment | Shared.MonetaryAmountDiscountAdjustment | Shared.MonetaryPercentageDiscountAdjustment | Shared.MonetaryMinimumAdjustment | Shared.MonetaryMaximumAdjustment>;
540
+ /**
541
+ * The final amount for a line item after all adjustments and pre paid credits have
542
+ * been applied.
543
+ */
544
+ amount: string;
545
+ /**
546
+ * The number of prepaid credits applied.
547
+ */
548
+ credits_applied: string;
549
+ /**
550
+ * @deprecated This field is deprecated in favor of `adjustments`
551
+ */
552
+ discount: Shared.Discount | null;
553
+ /**
554
+ * The end date of the range of time applied for this line item's price.
555
+ */
556
+ end_date: string;
557
+ /**
558
+ * An additional filter that was used to calculate the usage for this line item.
559
+ */
560
+ filter: string | null;
561
+ /**
562
+ * [DEPRECATED] For configured prices that are split by a grouping key, this will
563
+ * be populated with the key and a value. The `amount` and `subtotal` will be the
564
+ * values for this particular grouping.
565
+ */
566
+ grouping: string | null;
567
+ /**
568
+ * @deprecated This field is deprecated in favor of `adjustments`.
569
+ */
570
+ maximum: Shared.Maximum | null;
571
+ /**
572
+ * @deprecated This field is deprecated in favor of `adjustments`.
573
+ */
574
+ maximum_amount: string | null;
575
+ /**
576
+ * @deprecated This field is deprecated in favor of `adjustments`.
577
+ */
578
+ minimum: Shared.Minimum | null;
579
+ /**
580
+ * @deprecated This field is deprecated in favor of `adjustments`.
581
+ */
582
+ minimum_amount: string | null;
583
+ /**
584
+ * The name of the price associated with this line item.
585
+ */
586
+ name: string;
587
+ /**
588
+ * Any amount applied from a partial invoice
589
+ */
590
+ partially_invoiced_amount: string;
591
+ /**
592
+ * The Price resource represents a price that can be billed on a subscription,
593
+ * resulting in a charge on an invoice in the form of an invoice line item. Prices
594
+ * take a quantity and determine an amount to bill.
595
+ *
596
+ * Orb supports a few different pricing models out of the box. Each of these models
597
+ * is serialized differently in a given Price object. The model_type field
598
+ * determines the key for the configuration object that is present.
599
+ *
600
+ * For more on the types of prices, see
601
+ * [the core concepts documentation](/core-concepts#plan-and-price)
602
+ */
603
+ price: Shared.Price;
604
+ /**
605
+ * Either the fixed fee quantity or the usage during the service period.
606
+ */
607
+ quantity: number;
608
+ /**
609
+ * The start date of the range of time applied for this line item's price.
610
+ */
611
+ start_date: string;
612
+ /**
613
+ * For complex pricing structures, the line item can be broken down further in
614
+ * `sub_line_items`.
615
+ */
616
+ sub_line_items: Array<Shared.MatrixSubLineItem | Shared.TierSubLineItem | Shared.OtherSubLineItem>;
617
+ /**
618
+ * The line amount before any adjustments.
619
+ */
620
+ subtotal: string;
621
+ /**
622
+ * An array of tax rates and their incurred tax amounts. Empty if no tax
623
+ * integration is configured.
624
+ */
625
+ tax_amounts: Array<Shared.TaxAmount>;
626
+ /**
627
+ * A list of customer ids that were used to calculate the usage for this line item.
628
+ */
629
+ usage_customer_ids: Array<string> | null;
630
+ }
631
+ interface PaymentAttempt {
632
+ /**
633
+ * The ID of the payment attempt.
634
+ */
635
+ id: string;
636
+ /**
637
+ * The amount of the payment attempt.
638
+ */
639
+ amount: string;
640
+ /**
641
+ * The time at which the payment attempt was created.
642
+ */
643
+ created_at: string;
644
+ /**
645
+ * The payment provider that attempted to collect the payment.
646
+ */
647
+ payment_provider: 'stripe' | null;
648
+ /**
649
+ * The ID of the payment attempt in the payment provider.
650
+ */
651
+ payment_provider_id: string | null;
652
+ /**
653
+ * URL to the downloadable PDF version of the receipt. This field will be `null`
654
+ * for payment attempts that did not succeed.
655
+ */
656
+ receipt_pdf: string | null;
657
+ /**
658
+ * Whether the payment attempt succeeded.
659
+ */
660
+ succeeded: boolean;
661
+ }
662
+ }
663
+ }
153
664
  export interface ConversionRateTier {
154
665
  /**
155
666
  * Exclusive tier starting value
@@ -7261,6 +7772,7 @@ export declare namespace Price {
7261
7772
  id: string;
7262
7773
  billable_metric: Shared.BillableMetricTiny | null;
7263
7774
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
7775
+ billing_mode: 'in_advance' | 'in_arrear';
7264
7776
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
7265
7777
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
7266
7778
  conversion_rate: number | null;
@@ -7323,6 +7835,7 @@ export declare namespace Price {
7323
7835
  id: string;
7324
7836
  billable_metric: Shared.BillableMetricTiny | null;
7325
7837
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
7838
+ billing_mode: 'in_advance' | 'in_arrear';
7326
7839
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
7327
7840
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
7328
7841
  conversion_rate: number | null;
@@ -7385,6 +7898,7 @@ export declare namespace Price {
7385
7898
  id: string;
7386
7899
  billable_metric: Shared.BillableMetricTiny | null;
7387
7900
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
7901
+ billing_mode: 'in_advance' | 'in_arrear';
7388
7902
  /**
7389
7903
  * Configuration for bulk pricing
7390
7904
  */
@@ -7447,6 +7961,7 @@ export declare namespace Price {
7447
7961
  id: string;
7448
7962
  billable_metric: Shared.BillableMetricTiny | null;
7449
7963
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
7964
+ billing_mode: 'in_advance' | 'in_arrear';
7450
7965
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
7451
7966
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
7452
7967
  conversion_rate: number | null;
@@ -7509,6 +8024,7 @@ export declare namespace Price {
7509
8024
  id: string;
7510
8025
  billable_metric: Shared.BillableMetricTiny | null;
7511
8026
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
8027
+ billing_mode: 'in_advance' | 'in_arrear';
7512
8028
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
7513
8029
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
7514
8030
  conversion_rate: number | null;
@@ -7571,6 +8087,7 @@ export declare namespace Price {
7571
8087
  id: string;
7572
8088
  billable_metric: Shared.BillableMetricTiny | null;
7573
8089
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
8090
+ billing_mode: 'in_advance' | 'in_arrear';
7574
8091
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
7575
8092
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
7576
8093
  conversion_rate: number | null;
@@ -7664,6 +8181,7 @@ export declare namespace Price {
7664
8181
  id: string;
7665
8182
  billable_metric: Shared.BillableMetricTiny | null;
7666
8183
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
8184
+ billing_mode: 'in_advance' | 'in_arrear';
7667
8185
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
7668
8186
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
7669
8187
  conversion_rate: number | null;
@@ -7759,6 +8277,7 @@ export declare namespace Price {
7759
8277
  id: string;
7760
8278
  billable_metric: Shared.BillableMetricTiny | null;
7761
8279
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
8280
+ billing_mode: 'in_advance' | 'in_arrear';
7762
8281
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
7763
8282
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
7764
8283
  conversion_rate: number | null;
@@ -7860,6 +8379,7 @@ export declare namespace Price {
7860
8379
  id: string;
7861
8380
  billable_metric: Shared.BillableMetricTiny | null;
7862
8381
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
8382
+ billing_mode: 'in_advance' | 'in_arrear';
7863
8383
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
7864
8384
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
7865
8385
  conversion_rate: number | null;
@@ -7953,6 +8473,7 @@ export declare namespace Price {
7953
8473
  id: string;
7954
8474
  billable_metric: Shared.BillableMetricTiny | null;
7955
8475
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
8476
+ billing_mode: 'in_advance' | 'in_arrear';
7956
8477
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
7957
8478
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
7958
8479
  conversion_rate: number | null;
@@ -8050,6 +8571,7 @@ export declare namespace Price {
8050
8571
  id: string;
8051
8572
  billable_metric: Shared.BillableMetricTiny | null;
8052
8573
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
8574
+ billing_mode: 'in_advance' | 'in_arrear';
8053
8575
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
8054
8576
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
8055
8577
  conversion_rate: number | null;
@@ -8131,6 +8653,7 @@ export declare namespace Price {
8131
8653
  id: string;
8132
8654
  billable_metric: Shared.BillableMetricTiny | null;
8133
8655
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
8656
+ billing_mode: 'in_advance' | 'in_arrear';
8134
8657
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
8135
8658
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
8136
8659
  conversion_rate: number | null;
@@ -8208,6 +8731,7 @@ export declare namespace Price {
8208
8731
  id: string;
8209
8732
  billable_metric: Shared.BillableMetricTiny | null;
8210
8733
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
8734
+ billing_mode: 'in_advance' | 'in_arrear';
8211
8735
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
8212
8736
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
8213
8737
  conversion_rate: number | null;
@@ -8270,6 +8794,7 @@ export declare namespace Price {
8270
8794
  id: string;
8271
8795
  billable_metric: Shared.BillableMetricTiny | null;
8272
8796
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
8797
+ billing_mode: 'in_advance' | 'in_arrear';
8273
8798
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
8274
8799
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
8275
8800
  conversion_rate: number | null;
@@ -8359,6 +8884,7 @@ export declare namespace Price {
8359
8884
  id: string;
8360
8885
  billable_metric: Shared.BillableMetricTiny | null;
8361
8886
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
8887
+ billing_mode: 'in_advance' | 'in_arrear';
8362
8888
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
8363
8889
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
8364
8890
  conversion_rate: number | null;
@@ -8432,6 +8958,7 @@ export declare namespace Price {
8432
8958
  id: string;
8433
8959
  billable_metric: Shared.BillableMetricTiny | null;
8434
8960
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
8961
+ billing_mode: 'in_advance' | 'in_arrear';
8435
8962
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
8436
8963
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
8437
8964
  conversion_rate: number | null;
@@ -8513,6 +9040,7 @@ export declare namespace Price {
8513
9040
  id: string;
8514
9041
  billable_metric: Shared.BillableMetricTiny | null;
8515
9042
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
9043
+ billing_mode: 'in_advance' | 'in_arrear';
8516
9044
  /**
8517
9045
  * Configuration for bulk_with_proration pricing
8518
9046
  */
@@ -8601,6 +9129,7 @@ export declare namespace Price {
8601
9129
  id: string;
8602
9130
  billable_metric: Shared.BillableMetricTiny | null;
8603
9131
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
9132
+ billing_mode: 'in_advance' | 'in_arrear';
8604
9133
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
8605
9134
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
8606
9135
  conversion_rate: number | null;
@@ -8682,6 +9211,7 @@ export declare namespace Price {
8682
9211
  id: string;
8683
9212
  billable_metric: Shared.BillableMetricTiny | null;
8684
9213
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
9214
+ billing_mode: 'in_advance' | 'in_arrear';
8685
9215
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
8686
9216
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
8687
9217
  conversion_rate: number | null;
@@ -8805,6 +9335,7 @@ export declare namespace Price {
8805
9335
  id: string;
8806
9336
  billable_metric: Shared.BillableMetricTiny | null;
8807
9337
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
9338
+ billing_mode: 'in_advance' | 'in_arrear';
8808
9339
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
8809
9340
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
8810
9341
  conversion_rate: number | null;
@@ -8890,6 +9421,7 @@ export declare namespace Price {
8890
9421
  id: string;
8891
9422
  billable_metric: Shared.BillableMetricTiny | null;
8892
9423
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
9424
+ billing_mode: 'in_advance' | 'in_arrear';
8893
9425
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
8894
9426
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
8895
9427
  conversion_rate: number | null;
@@ -8986,6 +9518,7 @@ export declare namespace Price {
8986
9518
  id: string;
8987
9519
  billable_metric: Shared.BillableMetricTiny | null;
8988
9520
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
9521
+ billing_mode: 'in_advance' | 'in_arrear';
8989
9522
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
8990
9523
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
8991
9524
  conversion_rate: number | null;
@@ -9083,6 +9616,7 @@ export declare namespace Price {
9083
9616
  id: string;
9084
9617
  billable_metric: Shared.BillableMetricTiny | null;
9085
9618
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
9619
+ billing_mode: 'in_advance' | 'in_arrear';
9086
9620
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
9087
9621
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
9088
9622
  conversion_rate: number | null;
@@ -9179,6 +9713,7 @@ export declare namespace Price {
9179
9713
  id: string;
9180
9714
  billable_metric: Shared.BillableMetricTiny | null;
9181
9715
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
9716
+ billing_mode: 'in_advance' | 'in_arrear';
9182
9717
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
9183
9718
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
9184
9719
  conversion_rate: number | null;
@@ -9287,6 +9822,7 @@ export declare namespace Price {
9287
9822
  id: string;
9288
9823
  billable_metric: Shared.BillableMetricTiny | null;
9289
9824
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
9825
+ billing_mode: 'in_advance' | 'in_arrear';
9290
9826
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
9291
9827
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
9292
9828
  conversion_rate: number | null;
@@ -9404,6 +9940,7 @@ export declare namespace Price {
9404
9940
  id: string;
9405
9941
  billable_metric: Shared.BillableMetricTiny | null;
9406
9942
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
9943
+ billing_mode: 'in_advance' | 'in_arrear';
9407
9944
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
9408
9945
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
9409
9946
  conversion_rate: number | null;
@@ -9500,6 +10037,7 @@ export declare namespace Price {
9500
10037
  id: string;
9501
10038
  billable_metric: Shared.BillableMetricTiny | null;
9502
10039
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
10040
+ billing_mode: 'in_advance' | 'in_arrear';
9503
10041
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
9504
10042
  composite_price_filters: Array<Shared.TransformPriceFilter> | null;
9505
10043
  conversion_rate: number | null;