Class: Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::BillingInformation

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/stigg/models/v1/contract_create_params.rb,
sig/stigg/models/v1/contract_create_params.rbs

Overview

See Also:

  • Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription#billing_information

Defined Under Namespace

Modules: ProrationBehavior Classes: BillingAddress, TaxID

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) ⇒ Object

Billing address for the subscription

Parameters:

  • city (String) (defaults to: nil)
  • country (String) (defaults to: nil)
  • line1 (String) (defaults to: nil)
  • line2 (String) (defaults to: nil)
  • postal_code (String) (defaults to: nil)
  • state (String) (defaults to: nil) 



# File 'lib/stigg/models/v1/contract_create_params.rb', line 751

Instance Attribute Details

#billing_address ⇒ Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::BillingInformation::BillingAddress?

Billing address for the subscription

Returns:



677
678
679
680
681
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 677

optional :billing_address,
-> {
  Stigg::V1::ContractCreateParams::Subscription::NewSubscription::BillingInformation::BillingAddress
},
api_name: :billingAddress

#charge_on_behalf_of_account ⇒ String?

Stripe Connect account to charge on behalf of

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


687
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 687

optional :charge_on_behalf_of_account, String, api_name: :chargeOnBehalfOfAccount, nil?: true

#integration_id ⇒ String?

Billing integration identifier

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


693
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 693

optional :integration_id, String, api_name: :integrationId, nil?: true

#invoice_days_until_due ⇒ Float?

Number of days until invoice is due

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


699
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 699

optional :invoice_days_until_due, Float, api_name: :invoiceDaysUntilDue

#is_backdated ⇒ Boolean?

Whether the subscription is backdated

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


705
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 705

optional :is_backdated, Stigg::Internal::Type::Boolean, api_name: :isBackdated

#is_invoice_paid ⇒ Boolean?

Whether the invoice is marked as paid

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


711
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 711

optional :is_invoice_paid, Stigg::Internal::Type::Boolean, api_name: :isInvoicePaid

#metadata ⇒ Hash{Symbol=>String}?

Additional metadata for the subscription

Parameters:

  • (::Hash[Symbol, String])

Returns:

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


717
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 717

optional :metadata, Stigg::Internal::Type::HashOf[String]

#proration_behavior ⇒ Symbol, ...

How to handle proration for billing changes

Returns:



723
724
725
726
727
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 723

optional :proration_behavior,
enum: -> {
  Stigg::V1::ContractCreateParams::Subscription::NewSubscription::BillingInformation::ProrationBehavior
},
api_name: :prorationBehavior

#tax_ids ⇒ Array<Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::BillingInformation::TaxID>?

Customer tax identification numbers

Returns:



733
734
735
736
737
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 733

optional :tax_ids,
-> {
  Stigg::Internal::Type::ArrayOf[Stigg::V1::ContractCreateParams::Subscription::NewSubscription::BillingInformation::TaxID]
},
api_name: :taxIds

#tax_percentage ⇒ Float?

Tax percentage (0-100)

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


743
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 743

optional :tax_percentage, Float, api_name: :taxPercentage

#tax_rate_ids ⇒ Array<String>?

Tax rate identifiers to apply

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


749
 
# File 'lib/stigg/models/v1/contract_create_params.rb', line 749

optional :tax_rate_ids, Stigg::Internal::Type::ArrayOf[String], api_name: :taxRateIds

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/contract_create_params.rb', line 827

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


779
 
# File 'sig/stigg/models/v1/contract_create_params.rbs', line 779

def to_hash: -> {