-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathcustomers.ts
2397 lines (2195 loc) · 156 KB
/
customers.ts
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
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../../resource';
import { isRequestOptions } from '../../core';
import * as Core from '../../core';
import * as BalanceTransactionsAPI from './balance-transactions';
import {
BalanceTransactionCreateParams,
BalanceTransactionCreateResponse,
BalanceTransactionListParams,
BalanceTransactionListResponse,
BalanceTransactionListResponsesPage,
BalanceTransactions,
} from './balance-transactions';
import * as CostsAPI from './costs';
import {
CostListByExternalIDParams,
CostListByExternalIDResponse,
CostListParams,
CostListResponse,
Costs,
} from './costs';
import * as CreditsAPI from './credits/credits';
import {
CreditListByExternalIDParams,
CreditListByExternalIDResponse,
CreditListByExternalIDResponsesPage,
CreditListParams,
CreditListResponse,
CreditListResponsesPage,
Credits,
} from './credits/credits';
import { Page, type PageParams } from '../../pagination';
export class Customers extends APIResource {
costs: CostsAPI.Costs = new CostsAPI.Costs(this._client);
credits: CreditsAPI.Credits = new CreditsAPI.Credits(this._client);
balanceTransactions: BalanceTransactionsAPI.BalanceTransactions =
new BalanceTransactionsAPI.BalanceTransactions(this._client);
/**
* This operation is used to create an Orb customer, who is party to the core
* billing relationship. See [Customer](/core-concepts##customer) for an overview
* of the customer resource.
*
* This endpoint is critical in the following Orb functionality:
*
* - Automated charges can be configured by setting `payment_provider` and
* `payment_provider_id` to automatically issue invoices
* - [Customer ID Aliases](/events-and-metrics/customer-aliases) can be configured
* by setting `external_customer_id`
* - [Timezone localization](/essentials/timezones) can be configured on a
* per-customer basis by setting the `timezone` parameter
*/
create(body: CustomerCreateParams, options?: Core.RequestOptions): Core.APIPromise<Customer> {
return this._client.post('/customers', { body, ...options });
}
/**
* This endpoint can be used to update the `payment_provider`,
* `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`,
* `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and
* `additional_emails` of an existing customer. Other fields on a customer are
* currently immutable.
*/
update(
customerId: string,
body: CustomerUpdateParams,
options?: Core.RequestOptions,
): Core.APIPromise<Customer> {
return this._client.put(`/customers/${customerId}`, { body, ...options });
}
/**
* This endpoint returns a list of all customers for an account. The list of
* customers is ordered starting from the most recently created customer. This
* endpoint follows Orb's
* [standardized pagination format](/api-reference/pagination).
*
* See [Customer](/core-concepts##customer) for an overview of the customer model.
*/
list(query?: CustomerListParams, options?: Core.RequestOptions): Core.PagePromise<CustomersPage, Customer>;
list(options?: Core.RequestOptions): Core.PagePromise<CustomersPage, Customer>;
list(
query: CustomerListParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.PagePromise<CustomersPage, Customer> {
if (isRequestOptions(query)) {
return this.list({}, query);
}
return this._client.getAPIList('/customers', CustomersPage, { query, ...options });
}
/**
* This performs a deletion of this customer, its subscriptions, and its invoices,
* provided the customer does not have any issued invoices. Customers with issued
* invoices cannot be deleted. This operation is irreversible. Note that this is a
* _soft_ deletion, but the data will be inaccessible through the API and Orb
* dashboard.
*
* For a hard-deletion, please reach out to the Orb team directly.
*
* **Note**: This operation happens asynchronously and can be expected to take a
* few minutes to propagate to related resources. However, querying for the
* customer on subsequent GET requests while deletion is in process will reflect
* its deletion with a `deleted: true` property. Once the customer deletion has
* been fully processed, the customer will not be returned in the API.
*
* On successful processing, this returns an empty dictionary (`{}`) in the API.
*/
delete(customerId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
return this._client.delete(`/customers/${customerId}`, {
...options,
headers: { Accept: '*/*', ...options?.headers },
});
}
/**
* This endpoint is used to fetch customer details given an identifier. If the
* `Customer` is in the process of being deleted, only the properties `id` and
* `deleted: true` will be returned.
*
* See the [Customer resource](/core-concepts#customer) for a full discussion of
* the Customer model.
*/
fetch(customerId: string, options?: Core.RequestOptions): Core.APIPromise<Customer> {
return this._client.get(`/customers/${customerId}`, options);
}
/**
* This endpoint is used to fetch customer details given an `external_customer_id`
* (see [Customer ID Aliases](/events-and-metrics/customer-aliases)).
*
* Note that the resource and semantics of this endpoint exactly mirror
* [Get Customer](fetch-customer).
*/
fetchByExternalId(externalCustomerId: string, options?: Core.RequestOptions): Core.APIPromise<Customer> {
return this._client.get(`/customers/external_customer_id/${externalCustomerId}`, options);
}
/**
* Sync Orb's payment methods for the customer with their gateway.
*
* This method can be called before taking an action that may cause the customer to
* be charged, ensuring that the most up-to-date payment method is charged.
*
* **Note**: This functionality is currently only available for Stripe.
*/
syncPaymentMethodsFromGateway(customerId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
return this._client.post(`/customers/${customerId}/sync_payment_methods_from_gateway`, {
...options,
headers: { Accept: '*/*', ...options?.headers },
});
}
/**
* Sync Orb's payment methods for the customer with their gateway.
*
* This method can be called before taking an action that may cause the customer to
* be charged, ensuring that the most up-to-date payment method is charged.
*
* **Note**: This functionality is currently only available for Stripe.
*/
syncPaymentMethodsFromGatewayByExternalCustomerId(
externalCustomerId: string,
options?: Core.RequestOptions,
): Core.APIPromise<void> {
return this._client.post(
`/customers/external_customer_id/${externalCustomerId}/sync_payment_methods_from_gateway`,
{ ...options, headers: { Accept: '*/*', ...options?.headers } },
);
}
/**
* This endpoint is used to update customer details given an `external_customer_id`
* (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the
* resource and semantics of this endpoint exactly mirror
* [Update Customer](update-customer).
*/
updateByExternalId(
id: string,
body: CustomerUpdateByExternalIDParams,
options?: Core.RequestOptions,
): Core.APIPromise<Customer> {
return this._client.put(`/customers/external_customer_id/${id}`, { body, ...options });
}
}
export class CustomersPage extends Page<Customer> {}
/**
* A customer is a buyer of your products, and the other party to the billing
* relationship.
*
* In Orb, customers are assigned system generated identifiers automatically, but
* it's often desirable to have these match existing identifiers in your system. To
* avoid having to denormalize Orb ID information, you can pass in an
* `external_customer_id` with your own identifier. See
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
* information about how these aliases work in Orb.
*
* In addition to having an identifier in your system, a customer may exist in a
* payment provider solution like Stripe. Use the `payment_provider_id` and the
* `payment_provider` enum field to express this mapping.
*
* A customer also has a timezone (from the standard
* [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
* your account's timezone. See [Timezone localization](/essentials/timezones) for
* information on what this timezone parameter influences within Orb.
*/
export interface Customer {
id: string;
additional_emails: Array<string>;
auto_collection: boolean;
/**
* The customer's current balance in their currency.
*/
balance: string;
billing_address: Customer.BillingAddress | null;
created_at: string;
currency: string | null;
/**
* A valid customer email, to be used for notifications. When Orb triggers payment
* through a payment gateway, this email will be used for any automatically issued
* receipts.
*/
email: string;
email_delivery: boolean;
exempt_from_automated_tax: boolean | null;
/**
* An optional user-defined ID for this customer resource, used throughout the
* system as an alias for this Customer. Use this field to identify a customer by
* an existing identifier in your system.
*/
external_customer_id: string | null;
/**
* The hierarchical relationships for this customer.
*/
hierarchy: Customer.Hierarchy;
/**
* User specified key-value pairs for the resource. If not present, this defaults
* to an empty dictionary. Individual keys can be removed by setting the value to
* `null`, and the entire metadata mapping can be cleared by setting `metadata` to
* `null`.
*/
metadata: Record<string, string>;
/**
* The full name of the customer
*/
name: string;
/**
* This is used for creating charges or invoices in an external system via Orb.
* When not in test mode, the connection must first be configured in the Orb
* webapp.
*/
payment_provider: 'quickbooks' | 'bill.com' | 'stripe_charge' | 'stripe_invoice' | 'netsuite' | null;
/**
* The ID of this customer in an external payments solution, such as Stripe. This
* is used for creating charges or invoices in the external system via Orb.
*/
payment_provider_id: string | null;
portal_url: string | null;
shipping_address: Customer.ShippingAddress | null;
/**
* Tax IDs are commonly required to be displayed on customer invoices, which are
* added to the headers of invoices.
*
* ### Supported Tax ID Countries and Types
*
* | Country | Type | Description |
* | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
* | Andorra | `ad_nrt` | Andorran NRT Number |
* | Argentina | `ar_cuit` | Argentinian Tax ID Number |
* | Australia | `au_abn` | Australian Business Number (AU ABN) |
* | Australia | `au_arn` | Australian Taxation Office Reference Number |
* | Austria | `eu_vat` | European VAT Number |
* | Bahrain | `bh_vat` | Bahraini VAT Number |
* | Belgium | `eu_vat` | European VAT Number |
* | Bolivia | `bo_tin` | Bolivian Tax ID |
* | Brazil | `br_cnpj` | Brazilian CNPJ Number |
* | Brazil | `br_cpf` | Brazilian CPF Number |
* | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
* | Bulgaria | `eu_vat` | European VAT Number |
* | Canada | `ca_bn` | Canadian BN |
* | Canada | `ca_gst_hst` | Canadian GST/HST Number |
* | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
* | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
* | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
* | Canada | `ca_qst` | Canadian QST Number (Québec) |
* | Chile | `cl_tin` | Chilean TIN |
* | China | `cn_tin` | Chinese Tax ID |
* | Colombia | `co_nit` | Colombian NIT Number |
* | Costa Rica | `cr_tin` | Costa Rican Tax ID |
* | Croatia | `eu_vat` | European VAT Number |
* | Cyprus | `eu_vat` | European VAT Number |
* | Czech Republic | `eu_vat` | European VAT Number |
* | Denmark | `eu_vat` | European VAT Number |
* | Dominican Republic | `do_rcn` | Dominican RCN Number |
* | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
* | Egypt | `eg_tin` | Egyptian Tax Identification Number |
* | El Salvador | `sv_nit` | El Salvadorian NIT Number |
* | Estonia | `eu_vat` | European VAT Number |
* | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
* | Finland | `eu_vat` | European VAT Number |
* | France | `eu_vat` | European VAT Number |
* | Georgia | `ge_vat` | Georgian VAT |
* | Germany | `eu_vat` | European VAT Number |
* | Greece | `eu_vat` | European VAT Number |
* | Hong Kong | `hk_br` | Hong Kong BR Number |
* | Hungary | `eu_vat` | European VAT Number |
* | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
* | Iceland | `is_vat` | Icelandic VAT |
* | India | `in_gst` | Indian GST Number |
* | Indonesia | `id_npwp` | Indonesian NPWP Number |
* | Ireland | `eu_vat` | European VAT Number |
* | Israel | `il_vat` | Israel VAT |
* | Italy | `eu_vat` | European VAT Number |
* | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
* | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
* | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
* | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
* | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
* | Latvia | `eu_vat` | European VAT Number |
* | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
* | Lithuania | `eu_vat` | European VAT Number |
* | Luxembourg | `eu_vat` | European VAT Number |
* | Malaysia | `my_frp` | Malaysian FRP Number |
* | Malaysia | `my_itn` | Malaysian ITN |
* | Malaysia | `my_sst` | Malaysian SST Number |
* | Malta | `eu_vat ` | European VAT Number |
* | Mexico | `mx_rfc` | Mexican RFC Number |
* | Netherlands | `eu_vat` | European VAT Number |
* | New Zealand | `nz_gst` | New Zealand GST Number |
* | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
* | Norway | `no_vat` | Norwegian VAT Number |
* | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
* | Oman | `om_vat` | Omani VAT Number |
* | Peru | `pe_ruc` | Peruvian RUC Number |
* | Philippines | `ph_tin ` | Philippines Tax Identification Number |
* | Poland | `eu_vat` | European VAT Number |
* | Portugal | `eu_vat` | European VAT Number |
* | Romania | `eu_vat` | European VAT Number |
* | Romania | `ro_tin` | Romanian Tax ID Number |
* | Russia | `ru_inn` | Russian INN |
* | Russia | `ru_kpp` | Russian KPP |
* | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
* | Serbia | `rs_pib` | Serbian PIB Number |
* | Singapore | `sg_gst` | Singaporean GST |
* | Singapore | `sg_uen` | Singaporean UEN |
* | Slovakia | `eu_vat` | European VAT Number |
* | Slovenia | `eu_vat` | European VAT Number |
* | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
* | South Africa | `za_vat` | South African VAT Number |
* | South Korea | `kr_brn` | Korean BRN |
* | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
* | Spain | `eu_vat` | European VAT Number |
* | Sweden | `eu_vat` | European VAT Number |
* | Switzerland | `ch_vat` | Switzerland VAT Number |
* | Taiwan | `tw_vat` | Taiwanese VAT |
* | Thailand | `th_vat` | Thai VAT |
* | Turkey | `tr_tin` | Turkish Tax Identification Number |
* | Ukraine | `ua_vat` | Ukrainian VAT |
* | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
* | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
* | United Kingdom | `gb_vat` | United Kingdom VAT Number |
* | United States | `us_ein` | United States EIN |
* | Uruguay | `uy_ruc` | Uruguayan RUC Number |
* | Venezuela | `ve_rif` | Venezuelan RIF Number |
* | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
*/
tax_id: Customer.TaxID | null;
/**
* A timezone identifier from the IANA timezone database, such as
* "America/Los_Angeles". This "defaults to your account's timezone if not set.
* This cannot be changed after customer creation.
*/
timezone: string;
accounting_sync_configuration?: Customer.AccountingSyncConfiguration | null;
reporting_configuration?: Customer.ReportingConfiguration | null;
}
export namespace Customer {
export interface BillingAddress {
city: string | null;
country: string | null;
line1: string | null;
line2: string | null;
postal_code: string | null;
state: string | null;
}
/**
* The hierarchical relationships for this customer.
*/
export interface Hierarchy {
children: Array<Hierarchy.Child>;
parent: Hierarchy.Parent | null;
}
export namespace Hierarchy {
export interface Child {
id: string;
external_customer_id: string | null;
}
export interface Parent {
id: string;
external_customer_id: string | null;
}
}
export interface ShippingAddress {
city: string | null;
country: string | null;
line1: string | null;
line2: string | null;
postal_code: string | null;
state: string | null;
}
/**
* Tax IDs are commonly required to be displayed on customer invoices, which are
* added to the headers of invoices.
*
* ### Supported Tax ID Countries and Types
*
* | Country | Type | Description |
* | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
* | Andorra | `ad_nrt` | Andorran NRT Number |
* | Argentina | `ar_cuit` | Argentinian Tax ID Number |
* | Australia | `au_abn` | Australian Business Number (AU ABN) |
* | Australia | `au_arn` | Australian Taxation Office Reference Number |
* | Austria | `eu_vat` | European VAT Number |
* | Bahrain | `bh_vat` | Bahraini VAT Number |
* | Belgium | `eu_vat` | European VAT Number |
* | Bolivia | `bo_tin` | Bolivian Tax ID |
* | Brazil | `br_cnpj` | Brazilian CNPJ Number |
* | Brazil | `br_cpf` | Brazilian CPF Number |
* | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
* | Bulgaria | `eu_vat` | European VAT Number |
* | Canada | `ca_bn` | Canadian BN |
* | Canada | `ca_gst_hst` | Canadian GST/HST Number |
* | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
* | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
* | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
* | Canada | `ca_qst` | Canadian QST Number (Québec) |
* | Chile | `cl_tin` | Chilean TIN |
* | China | `cn_tin` | Chinese Tax ID |
* | Colombia | `co_nit` | Colombian NIT Number |
* | Costa Rica | `cr_tin` | Costa Rican Tax ID |
* | Croatia | `eu_vat` | European VAT Number |
* | Cyprus | `eu_vat` | European VAT Number |
* | Czech Republic | `eu_vat` | European VAT Number |
* | Denmark | `eu_vat` | European VAT Number |
* | Dominican Republic | `do_rcn` | Dominican RCN Number |
* | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
* | Egypt | `eg_tin` | Egyptian Tax Identification Number |
* | El Salvador | `sv_nit` | El Salvadorian NIT Number |
* | Estonia | `eu_vat` | European VAT Number |
* | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
* | Finland | `eu_vat` | European VAT Number |
* | France | `eu_vat` | European VAT Number |
* | Georgia | `ge_vat` | Georgian VAT |
* | Germany | `eu_vat` | European VAT Number |
* | Greece | `eu_vat` | European VAT Number |
* | Hong Kong | `hk_br` | Hong Kong BR Number |
* | Hungary | `eu_vat` | European VAT Number |
* | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
* | Iceland | `is_vat` | Icelandic VAT |
* | India | `in_gst` | Indian GST Number |
* | Indonesia | `id_npwp` | Indonesian NPWP Number |
* | Ireland | `eu_vat` | European VAT Number |
* | Israel | `il_vat` | Israel VAT |
* | Italy | `eu_vat` | European VAT Number |
* | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
* | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
* | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
* | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
* | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
* | Latvia | `eu_vat` | European VAT Number |
* | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
* | Lithuania | `eu_vat` | European VAT Number |
* | Luxembourg | `eu_vat` | European VAT Number |
* | Malaysia | `my_frp` | Malaysian FRP Number |
* | Malaysia | `my_itn` | Malaysian ITN |
* | Malaysia | `my_sst` | Malaysian SST Number |
* | Malta | `eu_vat ` | European VAT Number |
* | Mexico | `mx_rfc` | Mexican RFC Number |
* | Netherlands | `eu_vat` | European VAT Number |
* | New Zealand | `nz_gst` | New Zealand GST Number |
* | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
* | Norway | `no_vat` | Norwegian VAT Number |
* | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
* | Oman | `om_vat` | Omani VAT Number |
* | Peru | `pe_ruc` | Peruvian RUC Number |
* | Philippines | `ph_tin ` | Philippines Tax Identification Number |
* | Poland | `eu_vat` | European VAT Number |
* | Portugal | `eu_vat` | European VAT Number |
* | Romania | `eu_vat` | European VAT Number |
* | Romania | `ro_tin` | Romanian Tax ID Number |
* | Russia | `ru_inn` | Russian INN |
* | Russia | `ru_kpp` | Russian KPP |
* | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
* | Serbia | `rs_pib` | Serbian PIB Number |
* | Singapore | `sg_gst` | Singaporean GST |
* | Singapore | `sg_uen` | Singaporean UEN |
* | Slovakia | `eu_vat` | European VAT Number |
* | Slovenia | `eu_vat` | European VAT Number |
* | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
* | South Africa | `za_vat` | South African VAT Number |
* | South Korea | `kr_brn` | Korean BRN |
* | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
* | Spain | `eu_vat` | European VAT Number |
* | Sweden | `eu_vat` | European VAT Number |
* | Switzerland | `ch_vat` | Switzerland VAT Number |
* | Taiwan | `tw_vat` | Taiwanese VAT |
* | Thailand | `th_vat` | Thai VAT |
* | Turkey | `tr_tin` | Turkish Tax Identification Number |
* | Ukraine | `ua_vat` | Ukrainian VAT |
* | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
* | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
* | United Kingdom | `gb_vat` | United Kingdom VAT Number |
* | United States | `us_ein` | United States EIN |
* | Uruguay | `uy_ruc` | Uruguayan RUC Number |
* | Venezuela | `ve_rif` | Venezuelan RIF Number |
* | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
*/
export interface TaxID {
country:
| 'AD'
| 'AE'
| 'AR'
| 'AT'
| 'AU'
| 'BE'
| 'BG'
| 'BH'
| 'BO'
| 'BR'
| 'CA'
| 'CH'
| 'CL'
| 'CN'
| 'CO'
| 'CR'
| 'CY'
| 'CZ'
| 'DE'
| 'DK'
| 'EE'
| 'DO'
| 'EC'
| 'EG'
| 'ES'
| 'EU'
| 'FI'
| 'FR'
| 'GB'
| 'GE'
| 'GR'
| 'HK'
| 'HR'
| 'HU'
| 'ID'
| 'IE'
| 'IL'
| 'IN'
| 'IS'
| 'IT'
| 'JP'
| 'KE'
| 'KR'
| 'KZ'
| 'LI'
| 'LT'
| 'LU'
| 'LV'
| 'MT'
| 'MX'
| 'MY'
| 'NG'
| 'NL'
| 'NO'
| 'NZ'
| 'OM'
| 'PE'
| 'PH'
| 'PL'
| 'PT'
| 'RO'
| 'RS'
| 'RU'
| 'SA'
| 'SE'
| 'SG'
| 'SI'
| 'SK'
| 'SV'
| 'TH'
| 'TR'
| 'TW'
| 'UA'
| 'US'
| 'UY'
| 'VE'
| 'VN'
| 'ZA';
type:
| 'ad_nrt'
| 'ae_trn'
| 'ar_cuit'
| 'eu_vat'
| 'au_abn'
| 'au_arn'
| 'bg_uic'
| 'bh_vat'
| 'bo_tin'
| 'br_cnpj'
| 'br_cpf'
| 'ca_bn'
| 'ca_gst_hst'
| 'ca_pst_bc'
| 'ca_pst_mb'
| 'ca_pst_sk'
| 'ca_qst'
| 'ch_vat'
| 'cl_tin'
| 'cn_tin'
| 'co_nit'
| 'cr_tin'
| 'do_rcn'
| 'ec_ruc'
| 'eg_tin'
| 'es_cif'
| 'eu_oss_vat'
| 'gb_vat'
| 'ge_vat'
| 'hk_br'
| 'hu_tin'
| 'id_npwp'
| 'il_vat'
| 'in_gst'
| 'is_vat'
| 'jp_cn'
| 'jp_rn'
| 'jp_trn'
| 'ke_pin'
| 'kr_brn'
| 'kz_bin'
| 'li_uid'
| 'mx_rfc'
| 'my_frp'
| 'my_itn'
| 'my_sst'
| 'ng_tin'
| 'no_vat'
| 'no_voec'
| 'nz_gst'
| 'om_vat'
| 'pe_ruc'
| 'ph_tin'
| 'ro_tin'
| 'rs_pib'
| 'ru_inn'
| 'ru_kpp'
| 'sa_vat'
| 'sg_gst'
| 'sg_uen'
| 'si_tin'
| 'sv_nit'
| 'th_vat'
| 'tr_tin'
| 'tw_vat'
| 'ua_vat'
| 'us_ein'
| 'uy_ruc'
| 've_rif'
| 'vn_tin'
| 'za_vat';
value: string;
}
export interface AccountingSyncConfiguration {
accounting_providers: Array<AccountingSyncConfiguration.AccountingProvider>;
excluded: boolean;
}
export namespace AccountingSyncConfiguration {
export interface AccountingProvider {
external_provider_id: string | null;
provider_type: 'quickbooks' | 'netsuite';
}
}
export interface ReportingConfiguration {
exempt: boolean;
}
}
export interface CustomerCreateParams {
/**
* A valid customer email, to be used for notifications. When Orb triggers payment
* through a payment gateway, this email will be used for any automatically issued
* receipts.
*/
email: string;
/**
* The full name of the customer
*/
name: string;
accounting_sync_configuration?: CustomerCreateParams.AccountingSyncConfiguration | null;
/**
* Additional email addresses for this customer. If populated, these email
* addresses will be CC'd for customer communications.
*/
additional_emails?: Array<string> | null;
/**
* Used to determine if invoices for this customer will automatically attempt to
* charge a saved payment method, if available. This parameter defaults to `True`
* when a payment provider is provided on customer creation.
*/
auto_collection?: boolean | null;
billing_address?: CustomerCreateParams.BillingAddress | null;
/**
* An ISO 4217 currency string used for the customer's invoices and balance. If not
* set at creation time, will be set at subscription creation time.
*/
currency?: string | null;
email_delivery?: boolean | null;
/**
* An optional user-defined ID for this customer resource, used throughout the
* system as an alias for this Customer. Use this field to identify a customer by
* an existing identifier in your system.
*/
external_customer_id?: string | null;
/**
* The hierarchical relationships for this customer.
*/
hierarchy?: CustomerCreateParams.Hierarchy | null;
/**
* User-specified key/value pairs for the resource. Individual keys can be removed
* by setting the value to `null`, and the entire metadata mapping can be cleared
* by setting `metadata` to `null`.
*/
metadata?: Record<string, string | null> | null;
/**
* This is used for creating charges or invoices in an external system via Orb.
* When not in test mode, the connection must first be configured in the Orb
* webapp.
*/
payment_provider?: 'quickbooks' | 'bill.com' | 'stripe_charge' | 'stripe_invoice' | 'netsuite' | null;
/**
* The ID of this customer in an external payments solution, such as Stripe. This
* is used for creating charges or invoices in the external system via Orb.
*/
payment_provider_id?: string | null;
reporting_configuration?: CustomerCreateParams.ReportingConfiguration | null;
shipping_address?: CustomerCreateParams.ShippingAddress | null;
tax_configuration?:
| CustomerCreateParams.NewAvalaraTaxConfiguration
| CustomerCreateParams.NewTaxJarConfiguration
| null;
/**
* Tax IDs are commonly required to be displayed on customer invoices, which are
* added to the headers of invoices.
*
* ### Supported Tax ID Countries and Types
*
* | Country | Type | Description |
* | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
* | Andorra | `ad_nrt` | Andorran NRT Number |
* | Argentina | `ar_cuit` | Argentinian Tax ID Number |
* | Australia | `au_abn` | Australian Business Number (AU ABN) |
* | Australia | `au_arn` | Australian Taxation Office Reference Number |
* | Austria | `eu_vat` | European VAT Number |
* | Bahrain | `bh_vat` | Bahraini VAT Number |
* | Belgium | `eu_vat` | European VAT Number |
* | Bolivia | `bo_tin` | Bolivian Tax ID |
* | Brazil | `br_cnpj` | Brazilian CNPJ Number |
* | Brazil | `br_cpf` | Brazilian CPF Number |
* | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
* | Bulgaria | `eu_vat` | European VAT Number |
* | Canada | `ca_bn` | Canadian BN |
* | Canada | `ca_gst_hst` | Canadian GST/HST Number |
* | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
* | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
* | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
* | Canada | `ca_qst` | Canadian QST Number (Québec) |
* | Chile | `cl_tin` | Chilean TIN |
* | China | `cn_tin` | Chinese Tax ID |
* | Colombia | `co_nit` | Colombian NIT Number |
* | Costa Rica | `cr_tin` | Costa Rican Tax ID |
* | Croatia | `eu_vat` | European VAT Number |
* | Cyprus | `eu_vat` | European VAT Number |
* | Czech Republic | `eu_vat` | European VAT Number |
* | Denmark | `eu_vat` | European VAT Number |
* | Dominican Republic | `do_rcn` | Dominican RCN Number |
* | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
* | Egypt | `eg_tin` | Egyptian Tax Identification Number |
* | El Salvador | `sv_nit` | El Salvadorian NIT Number |
* | Estonia | `eu_vat` | European VAT Number |
* | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
* | Finland | `eu_vat` | European VAT Number |
* | France | `eu_vat` | European VAT Number |
* | Georgia | `ge_vat` | Georgian VAT |
* | Germany | `eu_vat` | European VAT Number |
* | Greece | `eu_vat` | European VAT Number |
* | Hong Kong | `hk_br` | Hong Kong BR Number |
* | Hungary | `eu_vat` | European VAT Number |
* | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
* | Iceland | `is_vat` | Icelandic VAT |
* | India | `in_gst` | Indian GST Number |
* | Indonesia | `id_npwp` | Indonesian NPWP Number |
* | Ireland | `eu_vat` | European VAT Number |
* | Israel | `il_vat` | Israel VAT |
* | Italy | `eu_vat` | European VAT Number |
* | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
* | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
* | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
* | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
* | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
* | Latvia | `eu_vat` | European VAT Number |
* | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
* | Lithuania | `eu_vat` | European VAT Number |
* | Luxembourg | `eu_vat` | European VAT Number |
* | Malaysia | `my_frp` | Malaysian FRP Number |
* | Malaysia | `my_itn` | Malaysian ITN |
* | Malaysia | `my_sst` | Malaysian SST Number |
* | Malta | `eu_vat ` | European VAT Number |
* | Mexico | `mx_rfc` | Mexican RFC Number |
* | Netherlands | `eu_vat` | European VAT Number |
* | New Zealand | `nz_gst` | New Zealand GST Number |
* | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
* | Norway | `no_vat` | Norwegian VAT Number |
* | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
* | Oman | `om_vat` | Omani VAT Number |
* | Peru | `pe_ruc` | Peruvian RUC Number |
* | Philippines | `ph_tin ` | Philippines Tax Identification Number |
* | Poland | `eu_vat` | European VAT Number |
* | Portugal | `eu_vat` | European VAT Number |
* | Romania | `eu_vat` | European VAT Number |
* | Romania | `ro_tin` | Romanian Tax ID Number |
* | Russia | `ru_inn` | Russian INN |
* | Russia | `ru_kpp` | Russian KPP |
* | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
* | Serbia | `rs_pib` | Serbian PIB Number |
* | Singapore | `sg_gst` | Singaporean GST |
* | Singapore | `sg_uen` | Singaporean UEN |
* | Slovakia | `eu_vat` | European VAT Number |
* | Slovenia | `eu_vat` | European VAT Number |
* | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
* | South Africa | `za_vat` | South African VAT Number |
* | South Korea | `kr_brn` | Korean BRN |
* | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
* | Spain | `eu_vat` | European VAT Number |
* | Sweden | `eu_vat` | European VAT Number |
* | Switzerland | `ch_vat` | Switzerland VAT Number |
* | Taiwan | `tw_vat` | Taiwanese VAT |
* | Thailand | `th_vat` | Thai VAT |
* | Turkey | `tr_tin` | Turkish Tax Identification Number |
* | Ukraine | `ua_vat` | Ukrainian VAT |
* | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
* | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
* | United Kingdom | `gb_vat` | United Kingdom VAT Number |
* | United States | `us_ein` | United States EIN |
* | Uruguay | `uy_ruc` | Uruguayan RUC Number |
* | Venezuela | `ve_rif` | Venezuelan RIF Number |
* | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
*/
tax_id?: CustomerCreateParams.TaxID | null;
/**
* A timezone identifier from the IANA timezone database, such as
* `"America/Los_Angeles"`. This defaults to your account's timezone if not set.
* This cannot be changed after customer creation.
*/
timezone?: string | null;
}
export namespace CustomerCreateParams {
export interface AccountingSyncConfiguration {
accounting_providers?: Array<AccountingSyncConfiguration.AccountingProvider> | null;
excluded?: boolean | null;
}
export namespace AccountingSyncConfiguration {
export interface AccountingProvider {
external_provider_id: string;
provider_type: string;
}
}
export interface BillingAddress {
city?: string | null;
country?: string | null;
line1?: string | null;
line2?: string | null;
postal_code?: string | null;
state?: string | null;
}
/**
* The hierarchical relationships for this customer.
*/
export interface Hierarchy {
/**
* A list of child customer IDs to add to the hierarchy. The desired child
* customers must not already be part of another hierarchy.
*/
child_customer_ids?: Array<string>;
/**
* The ID of the parent customer in the hierarchy. The desired parent customer must
* not be a child of another customer.
*/
parent_customer_id?: string | null;
}
export interface ReportingConfiguration {
exempt: boolean;
}
export interface ShippingAddress {
city?: string | null;
country?: string | null;
line1?: string | null;
line2?: string | null;
postal_code?: string | null;
state?: string | null;
}
export interface NewAvalaraTaxConfiguration {
tax_exempt: boolean;