Class: Orb::Models::CustomerUpdateByExternalIDParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::CustomerUpdateByExternalIDParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/orb/models/customer_update_by_external_id_params.rb

Overview

See Also:

• Resources::Customers#update_by_external_id

Defined Under Namespace

Modules: PaymentProvider, TaxConfiguration

Instance Attribute Summary

• #accounting_sync_configuration ⇒ Orb::Models::NewAccountingSyncConfiguration^?
• #additional_emails ⇒ Array<String>^?

  Additional email addresses for this customer.

• #auto_collection ⇒ Boolean^?

  Used to determine if invoices for this customer will automatically attempt to charge a saved payment method, if available.

• #billing_address ⇒ Orb::Models::AddressInput^?
• #currency ⇒ String^?

  An ISO 4217 currency string used for the customer’s invoices and balance.

• #email ⇒ String^?

  A valid customer email, to be used for invoicing and notifications.

• #email_delivery ⇒ Boolean^?
• #external_customer_id ⇒ String^?

  The external customer ID.

• #hierarchy ⇒ Orb::Models::CustomerHierarchyConfig^?

  The hierarchical relationships for this customer.

• #metadata ⇒ Hash{Symbol=>String, nil}^?

  User-specified key/value pairs for the resource.

• #name ⇒ String^?

  The full name of the customer.

• #payment_provider ⇒ Symbol, ...

  This is used for creating charges or invoices in an external system via Orb.

• #payment_provider_id ⇒ String^?

  The ID of this customer in an external payments solution, such as Stripe.

• #reporting_configuration ⇒ Orb::Models::NewReportingConfiguration^?
• #shipping_address ⇒ Orb::Models::AddressInput^?
• #tax_configuration ⇒ Orb::Models::NewAvalaraTaxConfiguration, ...
• #tax_id ⇒ Orb::Models::CustomerTaxID^?

  Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see CustomerUpdateByExternalIDParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::CustomerUpdateByExternalIDParams for more details.

Parameters:

• accounting_sync_configuration (Orb::Models::NewAccountingSyncConfiguration, nil) (defaults to: nil)
• additional_emails (Array<String>, nil) (defaults to: nil) —

  Additional email addresses for this customer. If populated, these email addresse

• auto_collection (Boolean, nil) (defaults to: nil) —

  Used to determine if invoices for this customer will automatically attempt to ch

• billing_address (Orb::Models::AddressInput, nil) (defaults to: nil)
• currency (String, nil) (defaults to: nil) —

  An ISO 4217 currency string used for the customer’s invoices and balance. If not

• email (String, nil) (defaults to: nil) —

  A valid customer email, to be used for invoicing and notifications.

• email_delivery (Boolean, nil) (defaults to: nil)
• external_customer_id (String, nil) (defaults to: nil) —

  The external customer ID. This can only be set if the customer has no existing e

• hierarchy (Orb::Models::CustomerHierarchyConfig, nil) (defaults to: nil) —

  The hierarchical relationships for this customer.

• metadata (Hash{Symbol=>String, nil}, nil) (defaults to: nil) —

  User-specified key/value pairs for the resource. Individual keys can be removed

• name (String, nil) (defaults to: nil) —

  The full name of the customer

• payment_provider (Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil) (defaults to: nil) —

  This is used for creating charges or invoices in an external system via Orb. Whe

• payment_provider_id (String, nil) (defaults to: nil) —

  The ID of this customer in an external payments solution, such as Stripe. This i

• reporting_configuration (Orb::Models::NewReportingConfiguration, nil) (defaults to: nil)
• shipping_address (Orb::Models::AddressInput, nil) (defaults to: nil)
• tax_configuration (Orb::Models::NewAvalaraTaxConfiguration, Orb::Models::NewTaxJarConfiguration, Orb::Models::NewSphereConfiguration, nil) (defaults to: nil)
• tax_id (Orb::Models::CustomerTaxID, nil) (defaults to: nil) —

  Tax IDs are commonly required to be displayed on customer invoices, which are ad

• request_options (Orb::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 270

Instance Attribute Details

#accounting_sync_configuration ⇒ Orb::Models::NewAccountingSyncConfiguration^?

Returns:

• (Orb::Models::NewAccountingSyncConfiguration, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 13

optional :accounting_sync_configuration, -> { Orb::NewAccountingSyncConfiguration }, nil?: true

#additional_emails ⇒ Array<String>^?

Additional email addresses for this customer. If populated, these email addresses will be CC’d for customer communications.

Returns:

• (Array<String>, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 20

optional :additional_emails, Orb::Internal::Type::ArrayOf[String], nil?: true

#auto_collection ⇒ Boolean^?

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.

Returns:

• (Boolean, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 28

optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true

#billing_address ⇒ Orb::Models::AddressInput^?

Returns:

• (Orb::Models::AddressInput, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 33

optional :billing_address, -> { Orb::AddressInput }, nil?: true

#currency ⇒ String^?

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.

Returns:

• (String, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 40

optional :currency, String, nil?: true

#email ⇒ String^?

A valid customer email, to be used for invoicing and notifications.

Returns:

• (String, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 46

optional :email, String, nil?: true

#email_delivery ⇒ Boolean^?

Returns:

• (Boolean, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 51

optional :email_delivery, Orb::Internal::Type::Boolean, nil?: true

#external_customer_id ⇒ String^?

The external customer ID. This can only be set if the customer has no existing external customer ID. Since this action may change usage quantities for all existing subscriptions, it is disallowed if the customer has issued invoices with usage line items and subject to the same restrictions as backdated subscription creation.

Returns:

• (String, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 61

optional :external_customer_id, String, nil?: true

#hierarchy ⇒ Orb::Models::CustomerHierarchyConfig^?

The hierarchical relationships for this customer.

Returns:

• (Orb::Models::CustomerHierarchyConfig, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 67

optional :hierarchy, -> { Orb::CustomerHierarchyConfig }, nil?: true

#metadata ⇒ Hash{Symbol=>String, nil}^?

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`.

Returns:

• (Hash{Symbol=>String, nil}, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 75

optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true

#name ⇒ String^?

The full name of the customer

Returns:

• (String, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 81

optional :name, String, nil?: true

#payment_provider ⇒ Symbol, ...

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.

• if the provider is an invoicing provider (‘stripe_invoice`, `quickbooks`, `bill.com`, `netsuite`), any product mappings must first be configured with the Orb team.

Returns:

• (Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 93

optional :payment_provider,
enum: -> { Orb::CustomerUpdateByExternalIDParams::PaymentProvider },
nil?: true

#payment_provider_id ⇒ String^?

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.

Returns:

• (String, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 102

optional :payment_provider_id, String, nil?: true

#reporting_configuration ⇒ Orb::Models::NewReportingConfiguration^?

Returns:

• (Orb::Models::NewReportingConfiguration, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 107

optional :reporting_configuration, -> { Orb::NewReportingConfiguration }, nil?: true

#shipping_address ⇒ Orb::Models::AddressInput^?

Returns:

• (Orb::Models::AddressInput, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 112

optional :shipping_address, -> { Orb::AddressInput }, nil?: true

#tax_configuration ⇒ Orb::Models::NewAvalaraTaxConfiguration, ...

Returns:

• (Orb::Models::NewAvalaraTaxConfiguration, Orb::Models::NewTaxJarConfiguration, Orb::Models::NewSphereConfiguration, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 117

optional :tax_configuration,
union: -> { Orb::CustomerUpdateByExternalIDParams::TaxConfiguration },
nil?: true

#tax_id ⇒ Orb::Models::CustomerTaxID^?

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 | | ———————- | ———— | ——————————————————————————————————- | | Albania | ‘al_tin` | Albania Tax Identification Number | | Andorra | `ad_nrt` | Andorran NRT Number | | Angola | `ao_tin` | Angola Tax Identification Number | | Argentina | `ar_cuit` | Argentinian Tax ID Number | | Armenia | `am_tin` | Armenia Tax Identification Number | | Aruba | `aw_tin` | Aruba Tax Identification Number | | Australia | `au_abn` | Australian Business Number (AU ABN) | | Australia | `au_arn` | Australian Taxation Office Reference Number | | Austria | `eu_vat` | European VAT Number | | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number | | Bahamas | `bs_tin` | Bahamas Tax Identification Number | | Bahrain | `bh_vat` | Bahraini VAT Number | | Bangladesh | `bd_bin` | Bangladesh Business Identification Number | | Barbados | `bb_tin` | Barbados Tax Identification Number | | Belarus | `by_tin` | Belarus TIN Number | | Belgium | `eu_vat` | European VAT Number | | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) | | Bolivia | `bo_tin` | Bolivian Tax ID | | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number | | 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 | | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d’Identifiant Fiscal Unique) | | Cambodia | ‘kh_tin` | Cambodia Tax Identification Number | | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d’Identifiant fiscal Unique) | | 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) | | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) | | Chile | `cl_tin` | Chilean TIN | | China | `cn_tin` | Chinese Tax ID | | Colombia | `co_nit` | Colombian NIT Number | | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) | | Costa Rica | `cr_tin` | Costa Rican Tax ID | | Croatia | `eu_vat` | European VAT Number | | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) | | 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 | | Ethiopia | `et_tin` | Ethiopia Tax Identification Number | | European Union | `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 | `de_stn` | German Tax Number (Steuernummer) | | Germany | `eu_vat` | European VAT Number | | Greece | `eu_vat` | European VAT Number | | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) | | 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 | | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number | | Laos | `la_tin` | Laos Tax Identification Number | | Latvia | `eu_vat` | European VAT Number | | Liechtenstein | `li_uid` | Liechtensteinian UID Number | | Liechtenstein | `li_vat` | Liechtenstein VAT 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 | | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) | | Mexico | `mx_rfc` | Mexican RFC Number | | Moldova | `md_vat` | Moldova VAT Number | | Montenegro | `me_pib` | Montenegro PIB Number | | Morocco | `ma_vat` | Morocco VAT Number | | Nepal | `np_pan` | Nepal PAN Number | | Netherlands | `eu_vat` | European VAT Number | | New Zealand | `nz_gst` | New Zealand GST Number | | Nigeria | `ng_tin` | Nigerian Tax Identification Number | | North Macedonia | `mk_vat` | North Macedonia VAT Number | | Northern Ireland | `eu_vat` | Northern Ireland VAT 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 | | Senegal | `sn_ninea` | Senegal NINEA Number | | 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 | | Suriname | `sr_fin` | Suriname FIN Number | | Sweden | `eu_vat` | European VAT Number | | Switzerland | `ch_uid` | Switzerland UID Number | | Switzerland | `ch_vat` | Switzerland VAT Number | | Taiwan | `tw_vat` | Taiwanese VAT | | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number | | Tanzania | `tz_vat` | Tanzania VAT Number | | Thailand | `th_vat` | Thai VAT | | Turkey | `tr_tin` | Turkish Tax Identification Number | | Uganda | `ug_tin` | Uganda Tax Identification Number | | Ukraine | `ua_vat` | Ukrainian VAT | | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | | United Kingdom | `gb_vat` | United Kingdom VAT Number | | United States | `us_ein` | United States EIN | | Uruguay | `uy_ruc` | Uruguayan RUC Number | | Uzbekistan | `uz_tin` | Uzbekistan TIN Number | | Uzbekistan | `uz_vat` | Uzbekistan VAT Number | | Venezuela | `ve_rif` | Venezuelan RIF Number | | Vietnam | `vn_tin` | Vietnamese Tax ID Number | | Zambia | `zm_tin` | Zambia Tax Identification Number | | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |

Returns:

• (Orb::Models::CustomerTaxID, nil)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 268

optional :tax_id, -> { Orb::CustomerTaxID }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/orb/models/customer_update_by_external_id_params.rb', line 326