Class: Stigg::Models::V1::SubscriptionPreviewParams::BillingInformation

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stigg::Models::V1::SubscriptionPreviewParams::BillingInformation

Defined in:

lib/stigg/models/v1/subscription_preview_params.rb

Defined Under Namespace

Modules: ProrationBehavior Classes: BillingAddress, TaxID

Instance Attribute Summary

• #billing_address ⇒ Stigg::Models::V1::SubscriptionPreviewParams::BillingInformation::BillingAddress^?

  Billing address.

• #charge_on_behalf_of_account ⇒ String^?

  Connected account ID for platform billing.

• #integration_id ⇒ String^?

  Billing integration ID.

• #invoice_days_until_due ⇒ Float^?

  Days until invoice is due.

• #is_backdated ⇒ Boolean^?

  Whether subscription is backdated.

• #is_invoice_paid ⇒ Boolean^?

  Whether invoice is already paid.

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

  Additional billing metadata.

• #proration_behavior ⇒ Symbol, ...

  Proration behavior.

• #tax_ids ⇒ Array<Stigg::Models::V1::SubscriptionPreviewParams::BillingInformation::TaxID>^?

  Customer tax IDs.

• #tax_percentage ⇒ Float^?

  Tax percentage to apply.

• #tax_rate_ids ⇒ Array<String>^?

  Tax rate IDs from billing provider.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) ⇒ Object constructor

  Billing address.

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

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/subscription_preview_params.rb', line 555

Instance Attribute Details

#billing_address ⇒ Stigg::Models::V1::SubscriptionPreviewParams::BillingInformation::BillingAddress^?

Billing address

Returns:

• (Stigg::Models::V1::SubscriptionPreviewParams::BillingInformation::BillingAddress, nil)

# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 485

optional :billing_address,
-> { Stigg::V1::SubscriptionPreviewParams::BillingInformation::BillingAddress },
api_name: :billingAddress

#charge_on_behalf_of_account ⇒ String^?

Connected account ID for platform billing

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 493

optional :charge_on_behalf_of_account, String, api_name: :chargeOnBehalfOfAccount

#integration_id ⇒ String^?

Billing integration ID

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 499

optional :integration_id, String, api_name: :integrationId

#invoice_days_until_due ⇒ Float^?

Days until invoice is due

Returns:

• (Float, nil)

# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 505

optional :invoice_days_until_due, Float, api_name: :invoiceDaysUntilDue

#is_backdated ⇒ Boolean^?

Whether subscription is backdated

Returns:

• (Boolean, nil)

# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 511

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

#is_invoice_paid ⇒ Boolean^?

Whether invoice is already paid

Returns:

• (Boolean, nil)

# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 517

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

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

Additional billing metadata

Returns:

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

# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 523

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

#proration_behavior ⇒ Symbol, ...

Proration behavior

Returns:

• (Symbol, Stigg::Models::V1::SubscriptionPreviewParams::BillingInformation::ProrationBehavior, nil)

# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 529

optional :proration_behavior,
enum: -> { Stigg::V1::SubscriptionPreviewParams::BillingInformation::ProrationBehavior },
api_name: :prorationBehavior

#tax_ids ⇒ Array<Stigg::Models::V1::SubscriptionPreviewParams::BillingInformation::TaxID>^?

Customer tax IDs

Returns:

• (Array<Stigg::Models::V1::SubscriptionPreviewParams::BillingInformation::TaxID>, nil)

# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 537

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

#tax_percentage ⇒ Float^?

Tax percentage to apply

Returns:

• (Float, nil)

# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 547

optional :tax_percentage, Float, api_name: :taxPercentage

#tax_rate_ids ⇒ Array<String>^?

Tax rate IDs from billing provider

Returns:

• (Array<String>, nil)

# File 'lib/stigg/models/v1/subscription_preview_params.rb', line 553

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/subscription_preview_params.rb', line 633