Class: Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice

Defined in:

lib/stigg/models/v1/subscription_preview_response.rb

Overview

See Also:

• #recurring_invoice

Defined Under Namespace

Classes: BillingPeriodRange, Discount, DiscountDetails, Line

Instance Attribute Summary

• #billing_period_range ⇒ Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::BillingPeriodRange^?

  Billing period covered.

• #currency ⇒ String^?

  Currency code.

• #discount ⇒ Float^?

  Total discount amount.

• #discount_details ⇒ Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::DiscountDetails^?

  Discount breakdown.

• #discounts ⇒ Array<Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::Discount>^?

  Applied discounts.

• #lines ⇒ Array<Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::Line>^?

  Line items.

• #sub_total ⇒ Float

  Subtotal before discounts.

• #tax ⇒ Float^?

  Tax amount.

• #total ⇒ Float

  Invoice total.

Instance Method Summary

• #initialize(amount:, currency:, description:) ⇒ Object constructor

  Applied discount amount.

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(amount:, currency:, description:) ⇒ Object

Applied discount amount

Parameters:

• amount (Float) —

  Discount amount

• currency (String) —

  Currency code

• description (String) —

  Discount description

# File 'lib/stigg/models/v1/subscription_preview_response.rb', line 395

Instance Attribute Details

#billing_period_range ⇒ Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::BillingPeriodRange^?

Billing period covered

Returns:

• (Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::BillingPeriodRange, nil)

# File 'lib/stigg/models/v1/subscription_preview_response.rb', line 351

optional :billing_period_range,
-> { Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::BillingPeriodRange },
api_name: :billingPeriodRange

#currency ⇒ String^?

Currency code

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/subscription_preview_response.rb', line 359

optional :currency, String, nil?: true

#discount ⇒ Float^?

Total discount amount

Returns:

• (Float, nil)

# File 'lib/stigg/models/v1/subscription_preview_response.rb', line 365

optional :discount, Float

#discount_details ⇒ Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::DiscountDetails^?

Discount breakdown

Returns:

• (Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::DiscountDetails, nil)

# File 'lib/stigg/models/v1/subscription_preview_response.rb', line 371

optional :discount_details,
-> { Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::DiscountDetails },
api_name: :discountDetails

#discounts ⇒ Array<Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::Discount>^?

Applied discounts

Returns:

• (Array<Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::Discount>, nil)

# File 'lib/stigg/models/v1/subscription_preview_response.rb', line 379

optional :discounts,
-> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::Discount] }

#lines ⇒ Array<Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::Line>^?

Line items

Returns:

• (Array<Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::Line>, nil)

# File 'lib/stigg/models/v1/subscription_preview_response.rb', line 386

optional :lines,
-> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::SubscriptionPreviewResponse::Data::RecurringInvoice::Line] }

#sub_total ⇒ Float

Subtotal before discounts

Returns:

• (Float)

# File 'lib/stigg/models/v1/subscription_preview_response.rb', line 339

required :sub_total, Float, api_name: :subTotal

#tax ⇒ Float^?

Tax amount

Returns:

• (Float, nil)

# File 'lib/stigg/models/v1/subscription_preview_response.rb', line 393

optional :tax, Float

#total ⇒ Float

Invoice total

Returns:

• (Float)

# File 'lib/stigg/models/v1/subscription_preview_response.rb', line 345

required :total, Float