orb-billing 1.9.0 → 1.11.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 (71) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +1 -1
  4. data/lib/orb/models/customer.rb +139 -100
  5. data/lib/orb/models/customer_create_params.rb +139 -100
  6. data/lib/orb/models/customer_tax_id.rb +214 -102
  7. data/lib/orb/models/customer_update_by_external_id_params.rb +145 -103
  8. data/lib/orb/models/customer_update_params.rb +145 -103
  9. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
  10. data/lib/orb/models/customers/cost_list_params.rb +2 -2
  11. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +3 -3
  12. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +3 -3
  13. data/lib/orb/models/dimensional_price_group_update_params.rb +38 -0
  14. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rb +44 -0
  15. data/lib/orb/models/invoice.rb +141 -102
  16. data/lib/orb/models/invoice_fetch_upcoming_response.rb +141 -102
  17. data/lib/orb/models/invoice_line_item_create_response.rb +2 -2
  18. data/lib/orb/models/per_price_cost.rb +2 -2
  19. data/lib/orb/models/plan.rb +2 -2
  20. data/lib/orb/models/plan_version.rb +2 -2
  21. data/lib/orb/models/price.rb +245 -1
  22. data/lib/orb/models/price_interval.rb +2 -2
  23. data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
  24. data/lib/orb/models.rb +2 -0
  25. data/lib/orb/resources/customers/costs.rb +2 -2
  26. data/lib/orb/resources/customers.rb +2 -2
  27. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +36 -0
  28. data/lib/orb/resources/dimensional_price_groups.rb +31 -0
  29. data/lib/orb/resources/invoices.rb +5 -4
  30. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  31. data/lib/orb/resources/prices.rb +4 -4
  32. data/lib/orb/resources/subscriptions.rb +1 -1
  33. data/lib/orb/version.rb +1 -1
  34. data/lib/orb.rb +2 -0
  35. data/rbi/orb/models/customer.rbi +278 -200
  36. data/rbi/orb/models/customer_create_params.rbi +278 -200
  37. data/rbi/orb/models/customer_tax_id.rbi +214 -102
  38. data/rbi/orb/models/customer_update_by_external_id_params.rbi +288 -204
  39. data/rbi/orb/models/customer_update_params.rbi +288 -204
  40. data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +2 -2
  41. data/rbi/orb/models/customers/cost_list_params.rbi +2 -2
  42. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +3 -3
  43. data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +3 -3
  44. data/rbi/orb/models/dimensional_price_group_update_params.rbi +61 -0
  45. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbi +66 -0
  46. data/rbi/orb/models/invoice.rbi +280 -201
  47. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +280 -201
  48. data/rbi/orb/models/invoice_line_item_create_response.rbi +2 -1
  49. data/rbi/orb/models/per_price_cost.rbi +2 -1
  50. data/rbi/orb/models/plan.rbi +2 -1
  51. data/rbi/orb/models/plan_version.rbi +2 -1
  52. data/rbi/orb/models/price.rbi +384 -1
  53. data/rbi/orb/models/price_interval.rbi +2 -1
  54. data/rbi/orb/models/subscription_fetch_costs_params.rbi +2 -2
  55. data/rbi/orb/models.rbi +3 -0
  56. data/rbi/orb/resources/customers/costs.rbi +2 -2
  57. data/rbi/orb/resources/customers.rbi +427 -304
  58. data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +26 -0
  59. data/rbi/orb/resources/dimensional_price_groups.rbi +26 -0
  60. data/rbi/orb/resources/invoices.rbi +5 -4
  61. data/rbi/orb/resources/subscriptions.rbi +1 -1
  62. data/sig/orb/models/customer_tax_id.rbs +150 -4
  63. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +4 -4
  64. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +4 -4
  65. data/sig/orb/models/dimensional_price_group_update_params.rbs +31 -0
  66. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbs +33 -0
  67. data/sig/orb/models/price.rbs +179 -0
  68. data/sig/orb/models.rbs +2 -0
  69. data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +7 -0
  70. data/sig/orb/resources/dimensional_price_groups.rbs +7 -0
  71. metadata +8 -2
data/rbi/orb/models/customer_update_params.rbi CHANGED
@@ -51,8 +51,11 @@ module Orb
51
51
  sig { returns(T.nilable(T::Boolean)) }
52
52
  attr_accessor :email_delivery
53
53
 
54
- # The external customer ID. This can only be set if empty and the customer has no
55
- # past or current subscriptions.
54
+ # The external customer ID. This can only be set if the customer has no existing
55
+ # external customer ID. Since this action may change usage quantities for all
56
+ # existing subscriptions, it is disallowed if the customer has issued invoices
57
+ # with usage line items and subject to the same restrictions as backdated
58
+ # subscription creation.
56
59
  sig { returns(T.nilable(String)) }
57
60
  attr_accessor :external_customer_id
58
61
 
@@ -129,106 +132,145 @@ module Orb
129
132
  #
130
133
  # ### Supported Tax ID Countries and Types
131
134
  #
132
- # | Country | Type | Description |
133
- # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
134
- # | Andorra | `ad_nrt` | Andorran NRT Number |
135
- # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
136
- # | Australia | `au_abn` | Australian Business Number (AU ABN) |
137
- # | Australia | `au_arn` | Australian Taxation Office Reference Number |
138
- # | Austria | `eu_vat` | European VAT Number |
139
- # | Bahrain | `bh_vat` | Bahraini VAT Number |
140
- # | Belgium | `eu_vat` | European VAT Number |
141
- # | Bolivia | `bo_tin` | Bolivian Tax ID |
142
- # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
143
- # | Brazil | `br_cpf` | Brazilian CPF Number |
144
- # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
145
- # | Bulgaria | `eu_vat` | European VAT Number |
146
- # | Canada | `ca_bn` | Canadian BN |
147
- # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
148
- # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
149
- # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
150
- # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
151
- # | Canada | `ca_qst` | Canadian QST Number (Québec) |
152
- # | Chile | `cl_tin` | Chilean TIN |
153
- # | China | `cn_tin` | Chinese Tax ID |
154
- # | Colombia | `co_nit` | Colombian NIT Number |
155
- # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
156
- # | Croatia | `eu_vat` | European VAT Number |
157
- # | Cyprus | `eu_vat` | European VAT Number |
158
- # | Czech Republic | `eu_vat` | European VAT Number |
159
- # | Denmark | `eu_vat` | European VAT Number |
160
- # | Dominican Republic | `do_rcn` | Dominican RCN Number |
161
- # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
162
- # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
163
- # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
164
- # | Estonia | `eu_vat` | European VAT Number |
165
- # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
166
- # | Finland | `eu_vat` | European VAT Number |
167
- # | France | `eu_vat` | European VAT Number |
168
- # | Georgia | `ge_vat` | Georgian VAT |
169
- # | Germany | `eu_vat` | European VAT Number |
170
- # | Greece | `eu_vat` | European VAT Number |
171
- # | Hong Kong | `hk_br` | Hong Kong BR Number |
172
- # | Hungary | `eu_vat` | European VAT Number |
173
- # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
174
- # | Iceland | `is_vat` | Icelandic VAT |
175
- # | India | `in_gst` | Indian GST Number |
176
- # | Indonesia | `id_npwp` | Indonesian NPWP Number |
177
- # | Ireland | `eu_vat` | European VAT Number |
178
- # | Israel | `il_vat` | Israel VAT |
179
- # | Italy | `eu_vat` | European VAT Number |
180
- # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
181
- # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
182
- # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
183
- # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
184
- # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
185
- # | Latvia | `eu_vat` | European VAT Number |
186
- # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
187
- # | Lithuania | `eu_vat` | European VAT Number |
188
- # | Luxembourg | `eu_vat` | European VAT Number |
189
- # | Malaysia | `my_frp` | Malaysian FRP Number |
190
- # | Malaysia | `my_itn` | Malaysian ITN |
191
- # | Malaysia | `my_sst` | Malaysian SST Number |
192
- # | Malta | `eu_vat ` | European VAT Number |
193
- # | Mexico | `mx_rfc` | Mexican RFC Number |
194
- # | Netherlands | `eu_vat` | European VAT Number |
195
- # | New Zealand | `nz_gst` | New Zealand GST Number |
196
- # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
197
- # | Norway | `no_vat` | Norwegian VAT Number |
198
- # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
199
- # | Oman | `om_vat` | Omani VAT Number |
200
- # | Peru | `pe_ruc` | Peruvian RUC Number |
201
- # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
202
- # | Poland | `eu_vat` | European VAT Number |
203
- # | Portugal | `eu_vat` | European VAT Number |
204
- # | Romania | `eu_vat` | European VAT Number |
205
- # | Romania | `ro_tin` | Romanian Tax ID Number |
206
- # | Russia | `ru_inn` | Russian INN |
207
- # | Russia | `ru_kpp` | Russian KPP |
208
- # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
209
- # | Serbia | `rs_pib` | Serbian PIB Number |
210
- # | Singapore | `sg_gst` | Singaporean GST |
211
- # | Singapore | `sg_uen` | Singaporean UEN |
212
- # | Slovakia | `eu_vat` | European VAT Number |
213
- # | Slovenia | `eu_vat` | European VAT Number |
214
- # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
215
- # | South Africa | `za_vat` | South African VAT Number |
216
- # | South Korea | `kr_brn` | Korean BRN |
217
- # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
218
- # | Spain | `eu_vat` | European VAT Number |
219
- # | Sweden | `eu_vat` | European VAT Number |
220
- # | Switzerland | `ch_vat` | Switzerland VAT Number |
221
- # | Taiwan | `tw_vat` | Taiwanese VAT |
222
- # | Thailand | `th_vat` | Thai VAT |
223
- # | Turkey | `tr_tin` | Turkish Tax Identification Number |
224
- # | Ukraine | `ua_vat` | Ukrainian VAT |
225
- # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
226
- # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
227
- # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
228
- # | United States | `us_ein` | United States EIN |
229
- # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
230
- # | Venezuela | `ve_rif` | Venezuelan RIF Number |
231
- # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
135
+ # | Country | Type | Description |
136
+ # | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
137
+ # | Albania | `al_tin` | Albania Tax Identification Number |
138
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
139
+ # | Angola | `ao_tin` | Angola Tax Identification Number |
140
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
141
+ # | Armenia | `am_tin` | Armenia Tax Identification Number |
142
+ # | Aruba | `aw_tin` | Aruba Tax Identification Number |
143
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
144
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
145
+ # | Austria | `eu_vat` | European VAT Number |
146
+ # | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
147
+ # | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
148
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
149
+ # | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
150
+ # | Barbados | `bb_tin` | Barbados Tax Identification Number |
151
+ # | Belarus | `by_tin` | Belarus TIN Number |
152
+ # | Belgium | `eu_vat` | European VAT Number |
153
+ # | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
154
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
155
+ # | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
156
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
157
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
158
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
159
+ # | Bulgaria | `eu_vat` | European VAT Number |
160
+ # | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
161
+ # | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
162
+ # | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
163
+ # | Canada | `ca_bn` | Canadian BN |
164
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
165
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
166
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
167
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
168
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
169
+ # | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
170
+ # | Chile | `cl_tin` | Chilean TIN |
171
+ # | China | `cn_tin` | Chinese Tax ID |
172
+ # | Colombia | `co_nit` | Colombian NIT Number |
173
+ # | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
174
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
175
+ # | Croatia | `eu_vat` | European VAT Number |
176
+ # | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
177
+ # | Cyprus | `eu_vat` | European VAT Number |
178
+ # | Czech Republic | `eu_vat` | European VAT Number |
179
+ # | Denmark | `eu_vat` | European VAT Number |
180
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
181
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
182
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
183
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
184
+ # | Estonia | `eu_vat` | European VAT Number |
185
+ # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
186
+ # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
187
+ # | Finland | `eu_vat` | European VAT Number |
188
+ # | France | `eu_vat` | European VAT Number |
189
+ # | Georgia | `ge_vat` | Georgian VAT |
190
+ # | Germany | `de_stn` | German Tax Number (Steuernummer) |
191
+ # | Germany | `eu_vat` | European VAT Number |
192
+ # | Greece | `eu_vat` | European VAT Number |
193
+ # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
194
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
195
+ # | Hungary | `eu_vat` | European VAT Number |
196
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
197
+ # | Iceland | `is_vat` | Icelandic VAT |
198
+ # | India | `in_gst` | Indian GST Number |
199
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
200
+ # | Ireland | `eu_vat` | European VAT Number |
201
+ # | Israel | `il_vat` | Israel VAT |
202
+ # | Italy | `eu_vat` | European VAT Number |
203
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
204
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
205
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
206
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
207
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
208
+ # | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
209
+ # | Laos | `la_tin` | Laos Tax Identification Number |
210
+ # | Latvia | `eu_vat` | European VAT Number |
211
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
212
+ # | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
213
+ # | Lithuania | `eu_vat` | European VAT Number |
214
+ # | Luxembourg | `eu_vat` | European VAT Number |
215
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
216
+ # | Malaysia | `my_itn` | Malaysian ITN |
217
+ # | Malaysia | `my_sst` | Malaysian SST Number |
218
+ # | Malta | `eu_vat` | European VAT Number |
219
+ # | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
220
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
221
+ # | Moldova | `md_vat` | Moldova VAT Number |
222
+ # | Montenegro | `me_pib` | Montenegro PIB Number |
223
+ # | Morocco | `ma_vat` | Morocco VAT Number |
224
+ # | Nepal | `np_pan` | Nepal PAN Number |
225
+ # | Netherlands | `eu_vat` | European VAT Number |
226
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
227
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
228
+ # | North Macedonia | `mk_vat` | North Macedonia VAT Number |
229
+ # | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
230
+ # | Norway | `no_vat` | Norwegian VAT Number |
231
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
232
+ # | Oman | `om_vat` | Omani VAT Number |
233
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
234
+ # | Philippines | `ph_tin` | Philippines Tax Identification Number |
235
+ # | Poland | `eu_vat` | European VAT Number |
236
+ # | Portugal | `eu_vat` | European VAT Number |
237
+ # | Romania | `eu_vat` | European VAT Number |
238
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
239
+ # | Russia | `ru_inn` | Russian INN |
240
+ # | Russia | `ru_kpp` | Russian KPP |
241
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
242
+ # | Senegal | `sn_ninea` | Senegal NINEA Number |
243
+ # | Serbia | `rs_pib` | Serbian PIB Number |
244
+ # | Singapore | `sg_gst` | Singaporean GST |
245
+ # | Singapore | `sg_uen` | Singaporean UEN |
246
+ # | Slovakia | `eu_vat` | European VAT Number |
247
+ # | Slovenia | `eu_vat` | European VAT Number |
248
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
249
+ # | South Africa | `za_vat` | South African VAT Number |
250
+ # | South Korea | `kr_brn` | Korean BRN |
251
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
252
+ # | Spain | `eu_vat` | European VAT Number |
253
+ # | Suriname | `sr_fin` | Suriname FIN Number |
254
+ # | Sweden | `eu_vat` | European VAT Number |
255
+ # | Switzerland | `ch_uid` | Switzerland UID Number |
256
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
257
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
258
+ # | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
259
+ # | Tanzania | `tz_vat` | Tanzania VAT Number |
260
+ # | Thailand | `th_vat` | Thai VAT |
261
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
262
+ # | Uganda | `ug_tin` | Uganda Tax Identification Number |
263
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
264
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
265
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
266
+ # | United States | `us_ein` | United States EIN |
267
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
268
+ # | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
269
+ # | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
270
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
271
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
272
+ # | Zambia | `zm_tin` | Zambia Tax Identification Number |
273
+ # | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
232
274
  sig { returns(T.nilable(Orb::CustomerTaxID)) }
233
275
  attr_reader :tax_id
234
276
 
@@ -283,8 +325,11 @@ module Orb
283
325
  # A valid customer email, to be used for invoicing and notifications.
284
326
  email: nil,
285
327
  email_delivery: nil,
286
- # The external customer ID. This can only be set if empty and the customer has no
287
- # past or current subscriptions.
328
+ # The external customer ID. This can only be set if the customer has no existing
329
+ # external customer ID. Since this action may change usage quantities for all
330
+ # existing subscriptions, it is disallowed if the customer has issued invoices
331
+ # with usage line items and subject to the same restrictions as backdated
332
+ # subscription creation.
288
333
  external_customer_id: nil,
289
334
  # The hierarchical relationships for this customer.
290
335
  hierarchy: nil,
@@ -313,106 +358,145 @@ module Orb
313
358
  #
314
359
  # ### Supported Tax ID Countries and Types
315
360
  #
316
- # | Country | Type | Description |
317
- # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
318
- # | Andorra | `ad_nrt` | Andorran NRT Number |
319
- # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
320
- # | Australia | `au_abn` | Australian Business Number (AU ABN) |
321
- # | Australia | `au_arn` | Australian Taxation Office Reference Number |
322
- # | Austria | `eu_vat` | European VAT Number |
323
- # | Bahrain | `bh_vat` | Bahraini VAT Number |
324
- # | Belgium | `eu_vat` | European VAT Number |
325
- # | Bolivia | `bo_tin` | Bolivian Tax ID |
326
- # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
327
- # | Brazil | `br_cpf` | Brazilian CPF Number |
328
- # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
329
- # | Bulgaria | `eu_vat` | European VAT Number |
330
- # | Canada | `ca_bn` | Canadian BN |
331
- # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
332
- # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
333
- # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
334
- # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
335
- # | Canada | `ca_qst` | Canadian QST Number (Québec) |
336
- # | Chile | `cl_tin` | Chilean TIN |
337
- # | China | `cn_tin` | Chinese Tax ID |
338
- # | Colombia | `co_nit` | Colombian NIT Number |
339
- # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
340
- # | Croatia | `eu_vat` | European VAT Number |
341
- # | Cyprus | `eu_vat` | European VAT Number |
342
- # | Czech Republic | `eu_vat` | European VAT Number |
343
- # | Denmark | `eu_vat` | European VAT Number |
344
- # | Dominican Republic | `do_rcn` | Dominican RCN Number |
345
- # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
346
- # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
347
- # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
348
- # | Estonia | `eu_vat` | European VAT Number |
349
- # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
350
- # | Finland | `eu_vat` | European VAT Number |
351
- # | France | `eu_vat` | European VAT Number |
352
- # | Georgia | `ge_vat` | Georgian VAT |
353
- # | Germany | `eu_vat` | European VAT Number |
354
- # | Greece | `eu_vat` | European VAT Number |
355
- # | Hong Kong | `hk_br` | Hong Kong BR Number |
356
- # | Hungary | `eu_vat` | European VAT Number |
357
- # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
358
- # | Iceland | `is_vat` | Icelandic VAT |
359
- # | India | `in_gst` | Indian GST Number |
360
- # | Indonesia | `id_npwp` | Indonesian NPWP Number |
361
- # | Ireland | `eu_vat` | European VAT Number |
362
- # | Israel | `il_vat` | Israel VAT |
363
- # | Italy | `eu_vat` | European VAT Number |
364
- # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
365
- # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
366
- # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
367
- # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
368
- # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
369
- # | Latvia | `eu_vat` | European VAT Number |
370
- # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
371
- # | Lithuania | `eu_vat` | European VAT Number |
372
- # | Luxembourg | `eu_vat` | European VAT Number |
373
- # | Malaysia | `my_frp` | Malaysian FRP Number |
374
- # | Malaysia | `my_itn` | Malaysian ITN |
375
- # | Malaysia | `my_sst` | Malaysian SST Number |
376
- # | Malta | `eu_vat ` | European VAT Number |
377
- # | Mexico | `mx_rfc` | Mexican RFC Number |
378
- # | Netherlands | `eu_vat` | European VAT Number |
379
- # | New Zealand | `nz_gst` | New Zealand GST Number |
380
- # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
381
- # | Norway | `no_vat` | Norwegian VAT Number |
382
- # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
383
- # | Oman | `om_vat` | Omani VAT Number |
384
- # | Peru | `pe_ruc` | Peruvian RUC Number |
385
- # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
386
- # | Poland | `eu_vat` | European VAT Number |
387
- # | Portugal | `eu_vat` | European VAT Number |
388
- # | Romania | `eu_vat` | European VAT Number |
389
- # | Romania | `ro_tin` | Romanian Tax ID Number |
390
- # | Russia | `ru_inn` | Russian INN |
391
- # | Russia | `ru_kpp` | Russian KPP |
392
- # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
393
- # | Serbia | `rs_pib` | Serbian PIB Number |
394
- # | Singapore | `sg_gst` | Singaporean GST |
395
- # | Singapore | `sg_uen` | Singaporean UEN |
396
- # | Slovakia | `eu_vat` | European VAT Number |
397
- # | Slovenia | `eu_vat` | European VAT Number |
398
- # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
399
- # | South Africa | `za_vat` | South African VAT Number |
400
- # | South Korea | `kr_brn` | Korean BRN |
401
- # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
402
- # | Spain | `eu_vat` | European VAT Number |
403
- # | Sweden | `eu_vat` | European VAT Number |
404
- # | Switzerland | `ch_vat` | Switzerland VAT Number |
405
- # | Taiwan | `tw_vat` | Taiwanese VAT |
406
- # | Thailand | `th_vat` | Thai VAT |
407
- # | Turkey | `tr_tin` | Turkish Tax Identification Number |
408
- # | Ukraine | `ua_vat` | Ukrainian VAT |
409
- # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
410
- # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
411
- # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
412
- # | United States | `us_ein` | United States EIN |
413
- # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
414
- # | Venezuela | `ve_rif` | Venezuelan RIF Number |
415
- # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
361
+ # | Country | Type | Description |
362
+ # | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
363
+ # | Albania | `al_tin` | Albania Tax Identification Number |
364
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
365
+ # | Angola | `ao_tin` | Angola Tax Identification Number |
366
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
367
+ # | Armenia | `am_tin` | Armenia Tax Identification Number |
368
+ # | Aruba | `aw_tin` | Aruba Tax Identification Number |
369
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
370
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
371
+ # | Austria | `eu_vat` | European VAT Number |
372
+ # | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
373
+ # | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
374
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
375
+ # | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
376
+ # | Barbados | `bb_tin` | Barbados Tax Identification Number |
377
+ # | Belarus | `by_tin` | Belarus TIN Number |
378
+ # | Belgium | `eu_vat` | European VAT Number |
379
+ # | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
380
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
381
+ # | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
382
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
383
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
384
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
385
+ # | Bulgaria | `eu_vat` | European VAT Number |
386
+ # | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
387
+ # | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
388
+ # | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
389
+ # | Canada | `ca_bn` | Canadian BN |
390
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
391
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
392
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
393
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
394
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
395
+ # | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
396
+ # | Chile | `cl_tin` | Chilean TIN |
397
+ # | China | `cn_tin` | Chinese Tax ID |
398
+ # | Colombia | `co_nit` | Colombian NIT Number |
399
+ # | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
400
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
401
+ # | Croatia | `eu_vat` | European VAT Number |
402
+ # | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
403
+ # | Cyprus | `eu_vat` | European VAT Number |
404
+ # | Czech Republic | `eu_vat` | European VAT Number |
405
+ # | Denmark | `eu_vat` | European VAT Number |
406
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
407
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
408
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
409
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
410
+ # | Estonia | `eu_vat` | European VAT Number |
411
+ # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
412
+ # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
413
+ # | Finland | `eu_vat` | European VAT Number |
414
+ # | France | `eu_vat` | European VAT Number |
415
+ # | Georgia | `ge_vat` | Georgian VAT |
416
+ # | Germany | `de_stn` | German Tax Number (Steuernummer) |
417
+ # | Germany | `eu_vat` | European VAT Number |
418
+ # | Greece | `eu_vat` | European VAT Number |
419
+ # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
420
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
421
+ # | Hungary | `eu_vat` | European VAT Number |
422
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
423
+ # | Iceland | `is_vat` | Icelandic VAT |
424
+ # | India | `in_gst` | Indian GST Number |
425
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
426
+ # | Ireland | `eu_vat` | European VAT Number |
427
+ # | Israel | `il_vat` | Israel VAT |
428
+ # | Italy | `eu_vat` | European VAT Number |
429
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
430
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
431
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
432
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
433
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
434
+ # | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
435
+ # | Laos | `la_tin` | Laos Tax Identification Number |
436
+ # | Latvia | `eu_vat` | European VAT Number |
437
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
438
+ # | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
439
+ # | Lithuania | `eu_vat` | European VAT Number |
440
+ # | Luxembourg | `eu_vat` | European VAT Number |
441
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
442
+ # | Malaysia | `my_itn` | Malaysian ITN |
443
+ # | Malaysia | `my_sst` | Malaysian SST Number |
444
+ # | Malta | `eu_vat` | European VAT Number |
445
+ # | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
446
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
447
+ # | Moldova | `md_vat` | Moldova VAT Number |
448
+ # | Montenegro | `me_pib` | Montenegro PIB Number |
449
+ # | Morocco | `ma_vat` | Morocco VAT Number |
450
+ # | Nepal | `np_pan` | Nepal PAN Number |
451
+ # | Netherlands | `eu_vat` | European VAT Number |
452
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
453
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
454
+ # | North Macedonia | `mk_vat` | North Macedonia VAT Number |
455
+ # | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
456
+ # | Norway | `no_vat` | Norwegian VAT Number |
457
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
458
+ # | Oman | `om_vat` | Omani VAT Number |
459
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
460
+ # | Philippines | `ph_tin` | Philippines Tax Identification Number |
461
+ # | Poland | `eu_vat` | European VAT Number |
462
+ # | Portugal | `eu_vat` | European VAT Number |
463
+ # | Romania | `eu_vat` | European VAT Number |
464
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
465
+ # | Russia | `ru_inn` | Russian INN |
466
+ # | Russia | `ru_kpp` | Russian KPP |
467
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
468
+ # | Senegal | `sn_ninea` | Senegal NINEA Number |
469
+ # | Serbia | `rs_pib` | Serbian PIB Number |
470
+ # | Singapore | `sg_gst` | Singaporean GST |
471
+ # | Singapore | `sg_uen` | Singaporean UEN |
472
+ # | Slovakia | `eu_vat` | European VAT Number |
473
+ # | Slovenia | `eu_vat` | European VAT Number |
474
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
475
+ # | South Africa | `za_vat` | South African VAT Number |
476
+ # | South Korea | `kr_brn` | Korean BRN |
477
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
478
+ # | Spain | `eu_vat` | European VAT Number |
479
+ # | Suriname | `sr_fin` | Suriname FIN Number |
480
+ # | Sweden | `eu_vat` | European VAT Number |
481
+ # | Switzerland | `ch_uid` | Switzerland UID Number |
482
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
483
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
484
+ # | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
485
+ # | Tanzania | `tz_vat` | Tanzania VAT Number |
486
+ # | Thailand | `th_vat` | Thai VAT |
487
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
488
+ # | Uganda | `ug_tin` | Uganda Tax Identification Number |
489
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
490
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
491
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
492
+ # | United States | `us_ein` | United States EIN |
493
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
494
+ # | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
495
+ # | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
496
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
497
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
498
+ # | Zambia | `zm_tin` | Zambia Tax Identification Number |
499
+ # | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
416
500
  tax_id: nil,
417
501
  request_options: {}
418
502
  )