orb-billing 0.12.0 → 1.0.1
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +28 -0
- data/README.md +1 -1
- data/lib/orb/internal/type/base_model.rb +5 -5
- data/lib/orb/models/accounting_provider_config.rb +21 -0
- data/lib/orb/models/address.rb +45 -0
- data/lib/orb/models/address_input.rb +45 -0
- data/lib/orb/models/adjustment_interval.rb +66 -0
- data/lib/orb/models/aggregated_cost.rb +45 -0
- data/lib/orb/models/alert.rb +9 -60
- data/lib/orb/models/alert_create_for_customer_params.rb +3 -24
- data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -24
- data/lib/orb/models/alert_create_for_subscription_params.rb +3 -23
- data/lib/orb/models/alert_update_params.rb +3 -22
- data/lib/orb/models/allocation.rb +27 -0
- data/lib/orb/models/amount_discount.rb +3 -59
- data/lib/orb/models/amount_discount_interval.rb +65 -0
- data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +193 -19201
- data/lib/orb/models/beta_create_plan_version_params.rb +183 -19025
- data/lib/orb/models/billable_metric_tiny.rb +15 -0
- data/lib/orb/models/billing_cycle_anchor_configuration.rb +41 -0
- data/lib/orb/models/billing_cycle_configuration.rb +32 -0
- data/lib/orb/models/bps_config.rb +24 -0
- data/lib/orb/models/bps_tier.rb +40 -0
- data/lib/orb/models/bulk_bps_config.rb +20 -0
- data/lib/orb/models/bulk_bps_tier.rb +32 -0
- data/lib/orb/models/bulk_config.rb +16 -0
- data/lib/orb/models/bulk_tier.rb +24 -0
- data/lib/orb/models/changed_subscription_resources.rb +40 -0
- data/lib/orb/models/conversion_rate_tier.rb +32 -0
- data/lib/orb/models/conversion_rate_tiered_config.rb +16 -0
- data/lib/orb/models/conversion_rate_unit_config.rb +16 -0
- data/lib/orb/models/coupon_redemption.rb +27 -0
- data/lib/orb/models/credit_note.rb +6 -51
- data/lib/orb/models/credit_note_tiny.rb +16 -0
- data/lib/orb/models/custom_expiration.rb +32 -0
- data/lib/orb/models/customer.rb +15 -426
- data/lib/orb/models/customer_create_params.rb +24 -527
- data/lib/orb/models/customer_hierarchy_config.rb +29 -0
- data/lib/orb/models/customer_minified.rb +21 -0
- data/lib/orb/models/customer_tax_id.rb +300 -0
- data/lib/orb/models/customer_update_by_external_id_params.rb +24 -529
- data/lib/orb/models/customer_update_params.rb +24 -527
- data/lib/orb/models/customers/balance_transaction_create_response.rb +6 -32
- data/lib/orb/models/customers/balance_transaction_list_response.rb +6 -32
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -88
- data/lib/orb/models/customers/cost_list_response.rb +3 -87
- data/lib/orb/models/customers/credits/affected_block.rb +31 -0
- data/lib/orb/models/customers/credits/amendment_ledger_entry.rb +131 -0
- data/lib/orb/models/customers/credits/credit_block_expiry_ledger_entry.rb +137 -0
- data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +152 -0
- data/lib/orb/models/customers/credits/expiration_change_ledger_entry.rb +141 -0
- data/lib/orb/models/customers/credits/increment_ledger_entry.rb +139 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +8 -1177
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +8 -1169
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +8 -1173
- data/lib/orb/models/customers/credits/ledger_list_response.rb +8 -1161
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +3 -52
- data/lib/orb/models/customers/credits/top_up_create_response.rb +3 -51
- data/lib/orb/models/customers/credits/top_up_invoice_settings.rb +53 -0
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +3 -52
- data/lib/orb/models/customers/credits/top_up_list_response.rb +3 -51
- data/lib/orb/models/customers/credits/void_initiated_ledger_entry.rb +152 -0
- data/lib/orb/models/customers/credits/void_ledger_entry.rb +145 -0
- data/lib/orb/models/dimensional_price_configuration.rb +21 -0
- data/lib/orb/models/discount_override.rb +56 -0
- data/lib/orb/models/fixed_fee_quantity_schedule_entry.rb +33 -0
- data/lib/orb/models/fixed_fee_quantity_transition.rb +27 -0
- data/lib/orb/models/invoice.rb +56 -1777
- data/lib/orb/models/invoice_create_params.rb +3 -15
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +56 -1794
- data/lib/orb/models/invoice_line_item_create_response.rb +25 -1142
- data/lib/orb/models/invoice_tiny.rb +16 -0
- data/lib/orb/models/item_slim.rb +21 -0
- data/lib/orb/models/matrix_config.rb +32 -0
- data/lib/orb/models/matrix_sub_line_item.rb +61 -0
- data/lib/orb/models/matrix_value.rb +29 -0
- data/lib/orb/models/matrix_with_allocation_config.rb +40 -0
- data/lib/orb/models/maximum.rb +38 -0
- data/lib/orb/models/maximum_interval.rb +52 -0
- data/lib/orb/models/minimum.rb +38 -0
- data/lib/orb/models/minimum_interval.rb +52 -0
- data/lib/orb/models/monetary_amount_discount_adjustment.rb +87 -0
- data/lib/orb/models/monetary_maximum_adjustment.rb +87 -0
- data/lib/orb/models/monetary_minimum_adjustment.rb +95 -0
- data/lib/orb/models/monetary_percentage_discount_adjustment.rb +87 -0
- data/lib/orb/models/monetary_usage_discount_adjustment.rb +87 -0
- data/lib/orb/models/mutated_subscription.rb +302 -0
- data/lib/orb/models/new_accounting_sync_configuration.rb +23 -0
- data/lib/orb/models/new_allocation_price.rb +70 -0
- data/lib/orb/models/new_amount_discount.rb +120 -0
- data/lib/orb/models/new_avalara_tax_configuration.rb +37 -0
- data/lib/orb/models/new_billing_cycle_configuration.rb +37 -0
- data/lib/orb/models/new_dimensional_price_configuration.rb +36 -0
- data/lib/orb/models/new_floating_bps_price.rb +199 -0
- data/lib/orb/models/new_floating_bulk_bps_price.rb +197 -0
- data/lib/orb/models/new_floating_bulk_price.rb +197 -0
- data/lib/orb/models/new_floating_bulk_with_proration_price.rb +197 -0
- data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_allocation_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_tiered_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +198 -0
- data/lib/orb/models/new_floating_matrix_price.rb +197 -0
- data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +197 -0
- data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +197 -0
- data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +197 -0
- data/lib/orb/models/new_floating_package_price.rb +197 -0
- data/lib/orb/models/new_floating_package_with_allocation_price.rb +197 -0
- data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +198 -0
- data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +198 -0
- data/lib/orb/models/new_floating_threshold_total_amount_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_bps_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_package_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_with_proration_price.rb +197 -0
- data/lib/orb/models/new_floating_unit_price.rb +197 -0
- data/lib/orb/models/new_floating_unit_with_percent_price.rb +197 -0
- data/lib/orb/models/new_floating_unit_with_proration_price.rb +197 -0
- data/lib/orb/models/new_maximum.rb +120 -0
- data/lib/orb/models/new_minimum.rb +128 -0
- data/lib/orb/models/new_percentage_discount.rb +120 -0
- data/lib/orb/models/new_plan_bps_price.rb +196 -0
- data/lib/orb/models/new_plan_bulk_bps_price.rb +200 -0
- data/lib/orb/models/new_plan_bulk_price.rb +196 -0
- data/lib/orb/models/new_plan_bulk_with_proration_price.rb +198 -0
- data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_allocation_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_tiered_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +199 -0
- data/lib/orb/models/new_plan_matrix_price.rb +200 -0
- data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +198 -0
- data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +198 -0
- data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +198 -0
- data/lib/orb/models/new_plan_package_price.rb +200 -0
- data/lib/orb/models/new_plan_package_with_allocation_price.rb +198 -0
- data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +199 -0
- data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +199 -0
- data/lib/orb/models/new_plan_threshold_total_amount_price.rb +198 -0
- data/lib/orb/models/new_plan_tier_with_proration_price.rb +198 -0
- data/lib/orb/models/new_plan_tiered_bps_price.rb +198 -0
- data/lib/orb/models/new_plan_tiered_package_price.rb +198 -0
- data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +198 -0
- data/lib/orb/models/new_plan_tiered_price.rb +200 -0
- data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +198 -0
- data/lib/orb/models/new_plan_unit_price.rb +196 -0
- data/lib/orb/models/new_plan_unit_with_percent_price.rb +198 -0
- data/lib/orb/models/new_plan_unit_with_proration_price.rb +198 -0
- data/lib/orb/models/new_reporting_configuration.rb +15 -0
- data/lib/orb/models/new_sphere_configuration.rb +31 -0
- data/lib/orb/models/new_subscription_bps_price.rb +207 -0
- data/lib/orb/models/new_subscription_bulk_bps_price.rb +207 -0
- data/lib/orb/models/new_subscription_bulk_price.rb +207 -0
- data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +207 -0
- data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_allocation_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_tiered_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +208 -0
- data/lib/orb/models/new_subscription_matrix_price.rb +207 -0
- data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +207 -0
- data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +207 -0
- data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +207 -0
- data/lib/orb/models/new_subscription_package_price.rb +207 -0
- data/lib/orb/models/new_subscription_package_with_allocation_price.rb +207 -0
- data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +209 -0
- data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +209 -0
- data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +207 -0
- data/lib/orb/models/new_subscription_tier_with_proration_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_bps_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_package_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +207 -0
- data/lib/orb/models/new_subscription_unit_price.rb +207 -0
- data/lib/orb/models/new_subscription_unit_with_percent_price.rb +207 -0
- data/lib/orb/models/new_subscription_unit_with_proration_price.rb +207 -0
- data/lib/orb/models/new_tax_jar_configuration.rb +31 -0
- data/lib/orb/models/new_usage_discount.rb +120 -0
- data/lib/orb/models/other_sub_line_item.rb +54 -0
- data/lib/orb/models/package_config.rb +28 -0
- data/lib/orb/models/per_price_cost.rb +48 -0
- data/lib/orb/models/percentage_discount.rb +3 -59
- data/lib/orb/models/percentage_discount_interval.rb +69 -0
- data/lib/orb/models/plan.rb +22 -1040
- data/lib/orb/models/plan_create_params.rb +31 -8145
- data/lib/orb/models/plan_phase_amount_discount_adjustment.rb +87 -0
- data/lib/orb/models/plan_phase_maximum_adjustment.rb +87 -0
- data/lib/orb/models/plan_phase_minimum_adjustment.rb +95 -0
- data/lib/orb/models/plan_phase_percentage_discount_adjustment.rb +87 -0
- data/lib/orb/models/plan_phase_usage_discount_adjustment.rb +87 -0
- data/lib/orb/models/plan_version.rb +10 -672
- data/lib/orb/models/price.rb +1225 -10817
- data/lib/orb/models/price_create_params.rb +53 -472
- data/lib/orb/models/price_evaluate_multiple_params.rb +32 -8479
- data/lib/orb/models/price_evaluate_preview_events_params.rb +236 -0
- data/lib/orb/models/price_evaluate_preview_events_response.rb +51 -0
- data/lib/orb/models/price_interval.rb +113 -0
- data/lib/orb/models/sub_line_item_grouping.rb +23 -0
- data/lib/orb/models/sub_line_item_matrix_config.rb +16 -0
- data/lib/orb/models/subscription.rb +33 -1581
- data/lib/orb/models/subscription_change_apply_response.rb +3 -1904
- data/lib/orb/models/subscription_change_cancel_response.rb +3 -1905
- data/lib/orb/models/subscription_change_minified.rb +15 -0
- data/lib/orb/models/subscription_change_retrieve_response.rb +3 -1906
- data/lib/orb/models/subscription_create_params.rb +232 -19698
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -87
- data/lib/orb/models/subscription_minified.rb +15 -0
- data/lib/orb/models/subscription_price_intervals_params.rb +86 -9468
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +238 -19792
- data/lib/orb/models/subscription_trial_info.rb +15 -0
- data/lib/orb/models/tax_amount.rb +32 -0
- data/lib/orb/models/threshold.rb +24 -0
- data/lib/orb/models/tier.rb +32 -0
- data/lib/orb/models/tier_config.rb +27 -0
- data/lib/orb/models/tier_sub_line_item.rb +61 -0
- data/lib/orb/models/tiered_bps_config.rb +20 -0
- data/lib/orb/models/tiered_config.rb +16 -0
- data/lib/orb/models/tiered_conversion_rate_config.rb +31 -0
- data/lib/orb/models/transform_price_filter.rb +61 -0
- data/lib/orb/models/trial_discount.rb +3 -59
- data/lib/orb/models/unit_config.rb +16 -0
- data/lib/orb/models/unit_conversion_rate_config.rb +31 -0
- data/lib/orb/models/usage_discount.rb +3 -59
- data/lib/orb/models/usage_discount_interval.rb +69 -0
- data/lib/orb/models.rb +348 -0
- data/lib/orb/resources/alerts.rb +4 -4
- data/lib/orb/resources/customers/credits/ledger.rb +4 -4
- data/lib/orb/resources/customers.rb +21 -21
- data/lib/orb/resources/plans.rb +1 -1
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +82 -34
- data/lib/orb/resources/subscriptions.rb +24 -24
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +181 -11
- data/rbi/orb/models/accounting_provider_config.rbi +34 -0
- data/rbi/orb/models/address.rbi +55 -0
- data/rbi/orb/models/address_input.rbi +62 -0
- data/rbi/orb/models/adjustment_interval.rbi +93 -0
- data/rbi/orb/models/aggregated_cost.rbi +61 -0
- data/rbi/orb/models/alert.rbi +11 -84
- data/rbi/orb/models/alert_create_for_customer_params.rbi +3 -42
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +3 -48
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +3 -38
- data/rbi/orb/models/alert_update_params.rbi +3 -31
- data/rbi/orb/models/allocation.rbi +45 -0
- data/rbi/orb/models/amount_discount.rbi +3 -112
- data/rbi/orb/models/amount_discount_interval.rbi +100 -0
- data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +558 -35618
- data/rbi/orb/models/beta_create_plan_version_params.rbi +558 -35610
- data/rbi/orb/models/billable_metric_tiny.rbi +21 -0
- data/rbi/orb/models/billing_cycle_anchor_configuration.rbi +61 -0
- data/rbi/orb/models/billing_cycle_configuration.rbi +70 -0
- data/rbi/orb/models/bps_config.rbi +36 -0
- data/rbi/orb/models/bps_tier.rbi +58 -0
- data/rbi/orb/models/bulk_bps_config.rbi +31 -0
- data/rbi/orb/models/bulk_bps_tier.rbi +50 -0
- data/rbi/orb/models/bulk_config.rbi +26 -0
- data/rbi/orb/models/bulk_tier.rbi +38 -0
- data/rbi/orb/models/changed_subscription_resources.rbi +61 -0
- data/rbi/orb/models/conversion_rate_tier.rbi +51 -0
- data/rbi/orb/models/conversion_rate_tiered_config.rbi +31 -0
- data/rbi/orb/models/conversion_rate_unit_config.rbi +27 -0
- data/rbi/orb/models/coupon_redemption.rbi +37 -0
- data/rbi/orb/models/credit_note.rbi +7 -87
- data/rbi/orb/models/credit_note_tiny.rbi +25 -0
- data/rbi/orb/models/custom_expiration.rbi +55 -0
- data/rbi/orb/models/customer.rbi +19 -522
- data/rbi/orb/models/customer_create_params.rbi +36 -957
- data/rbi/orb/models/customer_hierarchy_config.rbi +52 -0
- data/rbi/orb/models/customer_minified.rbi +32 -0
- data/rbi/orb/models/customer_tax_id.rbi +324 -0
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +36 -1436
- data/rbi/orb/models/customer_update_params.rbi +36 -957
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +8 -96
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +8 -96
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +5 -191
- data/rbi/orb/models/customers/cost_list_response.rbi +5 -182
- data/rbi/orb/models/customers/credits/affected_block.rbi +50 -0
- data/rbi/orb/models/customers/credits/amendment_ledger_entry.rbi +207 -0
- data/rbi/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbi +209 -0
- data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +225 -0
- data/rbi/orb/models/customers/credits/expiration_change_ledger_entry.rbi +213 -0
- data/rbi/orb/models/customers/credits/increment_ledger_entry.rbi +215 -0
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +7 -1854
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +7 -1854
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +7 -1854
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +7 -1854
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +4 -84
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +4 -84
- data/rbi/orb/models/customers/credits/top_up_invoice_settings.rbi +83 -0
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +4 -84
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +4 -84
- data/rbi/orb/models/customers/credits/void_initiated_ledger_entry.rbi +225 -0
- data/rbi/orb/models/customers/credits/void_ledger_entry.rbi +219 -0
- data/rbi/orb/models/dimensional_price_configuration.rbi +38 -0
- data/rbi/orb/models/discount_override.rbi +83 -0
- data/rbi/orb/models/fixed_fee_quantity_schedule_entry.rbi +48 -0
- data/rbi/orb/models/fixed_fee_quantity_transition.rbi +39 -0
- data/rbi/orb/models/invoice.rbi +212 -3345
- data/rbi/orb/models/invoice_create_params.rbi +4 -33
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +355 -4329
- data/rbi/orb/models/invoice_line_item_create_response.rbi +30 -2260
- data/rbi/orb/models/invoice_tiny.rbi +24 -0
- data/rbi/orb/models/item_slim.rbi +23 -0
- data/rbi/orb/models/matrix_config.rbi +50 -0
- data/rbi/orb/models/matrix_sub_line_item.rbi +87 -0
- data/rbi/orb/models/matrix_value.rbi +43 -0
- data/rbi/orb/models/matrix_with_allocation_config.rbi +61 -0
- data/rbi/orb/models/maximum.rbi +52 -0
- data/rbi/orb/models/maximum_interval.rbi +69 -0
- data/rbi/orb/models/minimum.rbi +52 -0
- data/rbi/orb/models/minimum_interval.rbi +69 -0
- data/rbi/orb/models/monetary_amount_discount_adjustment.rbi +125 -0
- data/rbi/orb/models/monetary_maximum_adjustment.rbi +123 -0
- data/rbi/orb/models/monetary_minimum_adjustment.rbi +131 -0
- data/rbi/orb/models/monetary_percentage_discount_adjustment.rbi +131 -0
- data/rbi/orb/models/monetary_usage_discount_adjustment.rbi +125 -0
- data/rbi/orb/models/mutated_subscription.rbi +412 -0
- data/rbi/orb/models/new_accounting_sync_configuration.rbi +40 -0
- data/rbi/orb/models/new_allocation_price.rbi +104 -0
- data/rbi/orb/models/new_amount_discount.rbi +179 -0
- data/rbi/orb/models/new_avalara_tax_configuration.rbi +68 -0
- data/rbi/orb/models/new_billing_cycle_configuration.rbi +79 -0
- data/rbi/orb/models/new_dimensional_price_configuration.rbi +55 -0
- data/rbi/orb/models/new_floating_bps_price.rbi +294 -0
- data/rbi/orb/models/new_floating_bulk_bps_price.rbi +309 -0
- data/rbi/orb/models/new_floating_bulk_price.rbi +298 -0
- data/rbi/orb/models/new_floating_bulk_with_proration_price.rbi +331 -0
- data/rbi/orb/models/new_floating_cumulative_grouped_bulk_price.rbi +338 -0
- data/rbi/orb/models/new_floating_grouped_allocation_price.rbi +331 -0
- data/rbi/orb/models/new_floating_grouped_tiered_package_price.rbi +337 -0
- data/rbi/orb/models/new_floating_grouped_tiered_price.rbi +325 -0
- data/rbi/orb/models/new_floating_grouped_with_metered_minimum_price.rbi +348 -0
- data/rbi/orb/models/new_floating_grouped_with_prorated_minimum_price.rbi +348 -0
- data/rbi/orb/models/new_floating_matrix_price.rbi +304 -0
- data/rbi/orb/models/new_floating_matrix_with_allocation_price.rbi +345 -0
- data/rbi/orb/models/new_floating_matrix_with_display_name_price.rbi +338 -0
- data/rbi/orb/models/new_floating_max_group_tiered_package_price.rbi +338 -0
- data/rbi/orb/models/new_floating_package_price.rbi +306 -0
- data/rbi/orb/models/new_floating_package_with_allocation_price.rbi +338 -0
- data/rbi/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbi +350 -0
- data/rbi/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbi +349 -0
- data/rbi/orb/models/new_floating_threshold_total_amount_price.rbi +337 -0
- data/rbi/orb/models/new_floating_tiered_bps_price.rbi +317 -0
- data/rbi/orb/models/new_floating_tiered_package_price.rbi +325 -0
- data/rbi/orb/models/new_floating_tiered_package_with_minimum_price.rbi +348 -0
- data/rbi/orb/models/new_floating_tiered_price.rbi +304 -0
- data/rbi/orb/models/new_floating_tiered_with_minimum_price.rbi +331 -0
- data/rbi/orb/models/new_floating_tiered_with_proration_price.rbi +337 -0
- data/rbi/orb/models/new_floating_unit_price.rbi +298 -0
- data/rbi/orb/models/new_floating_unit_with_percent_price.rbi +328 -0
- data/rbi/orb/models/new_floating_unit_with_proration_price.rbi +331 -0
- data/rbi/orb/models/new_maximum.rbi +160 -0
- data/rbi/orb/models/new_minimum.rbi +168 -0
- data/rbi/orb/models/new_percentage_discount.rbi +193 -0
- data/rbi/orb/models/new_plan_bps_price.rbi +294 -0
- data/rbi/orb/models/new_plan_bulk_bps_price.rbi +297 -0
- data/rbi/orb/models/new_plan_bulk_price.rbi +295 -0
- data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +327 -0
- data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +333 -0
- data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +327 -0
- data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +333 -0
- data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +316 -0
- data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +340 -0
- data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +345 -0
- data/rbi/orb/models/new_plan_matrix_price.rbi +297 -0
- data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +341 -0
- data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +333 -0
- data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +333 -0
- data/rbi/orb/models/new_plan_package_price.rbi +297 -0
- data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +333 -0
- data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +352 -0
- data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +351 -0
- data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +333 -0
- data/rbi/orb/models/new_plan_tier_with_proration_price.rbi +327 -0
- data/rbi/orb/models/new_plan_tiered_bps_price.rbi +304 -0
- data/rbi/orb/models/new_plan_tiered_package_price.rbi +316 -0
- data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +339 -0
- data/rbi/orb/models/new_plan_tiered_price.rbi +297 -0
- data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +327 -0
- data/rbi/orb/models/new_plan_unit_price.rbi +295 -0
- data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +325 -0
- data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +327 -0
- data/rbi/orb/models/new_reporting_configuration.rbi +23 -0
- data/rbi/orb/models/new_sphere_configuration.rbi +59 -0
- data/rbi/orb/models/new_subscription_bps_price.rbi +317 -0
- data/rbi/orb/models/new_subscription_bulk_bps_price.rbi +338 -0
- data/rbi/orb/models/new_subscription_bulk_price.rbi +321 -0
- data/rbi/orb/models/new_subscription_bulk_with_proration_price.rbi +350 -0
- data/rbi/orb/models/new_subscription_cumulative_grouped_bulk_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_grouped_allocation_price.rbi +350 -0
- data/rbi/orb/models/new_subscription_grouped_tiered_package_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_grouped_tiered_price.rbi +343 -0
- data/rbi/orb/models/new_subscription_grouped_with_metered_minimum_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_matrix_price.rbi +332 -0
- data/rbi/orb/models/new_subscription_matrix_with_allocation_price.rbi +368 -0
- data/rbi/orb/models/new_subscription_matrix_with_display_name_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_max_group_tiered_package_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_package_price.rbi +338 -0
- data/rbi/orb/models/new_subscription_package_with_allocation_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbi +362 -0
- data/rbi/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbi +361 -0
- data/rbi/orb/models/new_subscription_threshold_total_amount_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_tier_with_proration_price.rbi +350 -0
- data/rbi/orb/models/new_subscription_tiered_bps_price.rbi +340 -0
- data/rbi/orb/models/new_subscription_tiered_package_price.rbi +343 -0
- data/rbi/orb/models/new_subscription_tiered_package_with_minimum_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_tiered_price.rbi +332 -0
- data/rbi/orb/models/new_subscription_tiered_with_minimum_price.rbi +350 -0
- data/rbi/orb/models/new_subscription_unit_price.rbi +321 -0
- data/rbi/orb/models/new_subscription_unit_with_percent_price.rbi +349 -0
- data/rbi/orb/models/new_subscription_unit_with_proration_price.rbi +350 -0
- data/rbi/orb/models/new_tax_jar_configuration.rbi +59 -0
- data/rbi/orb/models/new_usage_discount.rbi +177 -0
- data/rbi/orb/models/other_sub_line_item.rbi +78 -0
- data/rbi/orb/models/package_config.rbi +39 -0
- data/rbi/orb/models/per_price_cost.rbi +96 -0
- data/rbi/orb/models/percentage_discount.rbi +3 -126
- data/rbi/orb/models/percentage_discount_interval.rbi +107 -0
- data/rbi/orb/models/plan.rbi +29 -1937
- data/rbi/orb/models/plan_create_params.rbi +112 -15428
- data/rbi/orb/models/plan_phase_amount_discount_adjustment.rbi +128 -0
- data/rbi/orb/models/plan_phase_maximum_adjustment.rbi +123 -0
- data/rbi/orb/models/plan_phase_minimum_adjustment.rbi +131 -0
- data/rbi/orb/models/plan_phase_percentage_discount_adjustment.rbi +131 -0
- data/rbi/orb/models/plan_phase_usage_discount_adjustment.rbi +125 -0
- data/rbi/orb/models/plan_version.rbi +13 -1252
- data/rbi/orb/models/price.rbi +3518 -26097
- data/rbi/orb/models/price_create_params.rbi +81 -937
- data/rbi/orb/models/price_evaluate_multiple_params.rbi +112 -15566
- data/rbi/orb/models/price_evaluate_preview_events_params.rbi +411 -0
- data/rbi/orb/models/price_evaluate_preview_events_response.rbi +101 -0
- data/rbi/orb/models/price_interval.rbi +174 -0
- data/rbi/orb/models/sub_line_item_grouping.rbi +31 -0
- data/rbi/orb/models/sub_line_item_matrix_config.rbi +33 -0
- data/rbi/orb/models/subscription.rbi +51 -2939
- data/rbi/orb/models/subscription_change_apply_response.rbi +4 -3580
- data/rbi/orb/models/subscription_change_cancel_response.rbi +4 -3580
- data/rbi/orb/models/subscription_change_minified.rbi +23 -0
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +4 -3582
- data/rbi/orb/models/subscription_create_params.rbi +686 -36613
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +5 -182
- data/rbi/orb/models/subscription_minified.rbi +23 -0
- data/rbi/orb/models/subscription_price_intervals_params.rbi +224 -17694
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +696 -36631
- data/rbi/orb/models/subscription_trial_info.rbi +23 -0
- data/rbi/orb/models/tax_amount.rbi +50 -0
- data/rbi/orb/models/threshold.rbi +30 -0
- data/rbi/orb/models/tier.rbi +50 -0
- data/rbi/orb/models/tier_config.rbi +40 -0
- data/rbi/orb/models/tier_sub_line_item.rbi +87 -0
- data/rbi/orb/models/tiered_bps_config.rbi +29 -0
- data/rbi/orb/models/tiered_config.rbi +26 -0
- data/rbi/orb/models/tiered_conversion_rate_config.rbi +73 -0
- data/rbi/orb/models/transform_price_filter.rbi +106 -0
- data/rbi/orb/models/trial_discount.rbi +3 -104
- data/rbi/orb/models/unit_config.rbi +24 -0
- data/rbi/orb/models/unit_conversion_rate_config.rbi +71 -0
- data/rbi/orb/models/usage_discount.rbi +3 -104
- data/rbi/orb/models/usage_discount_interval.rbi +99 -0
- data/rbi/orb/models.rbi +398 -0
- data/rbi/orb/resources/alerts.rbi +4 -13
- data/rbi/orb/resources/customers.rbi +27 -51
- data/rbi/orb/resources/plans.rbi +28 -28
- data/rbi/orb/resources/prices.rbi +82 -36
- data/rbi/orb/resources/subscriptions.rbi +13 -19
- data/sig/orb/models/accounting_provider_config.rbs +19 -0
- data/sig/orb/models/address.rbs +45 -0
- data/sig/orb/models/address_input.rbs +45 -0
- data/sig/orb/models/adjustment_interval.rbs +53 -0
- data/sig/orb/models/aggregated_cost.rbs +40 -0
- data/sig/orb/models/alert.rbs +12 -44
- data/sig/orb/models/alert_create_for_customer_params.rbs +4 -14
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +4 -14
- data/sig/orb/models/alert_create_for_subscription_params.rbs +4 -14
- data/sig/orb/models/alert_update_params.rbs +4 -14
- data/sig/orb/models/allocation.rbs +30 -0
- data/sig/orb/models/amount_discount.rbs +4 -57
- data/sig/orb/models/amount_discount_interval.rbs +55 -0
- data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +149 -13933
- data/sig/orb/models/beta_create_plan_version_params.rbs +146 -13914
- data/sig/orb/models/billable_metric_tiny.rbs +13 -0
- data/sig/orb/models/billing_cycle_anchor_configuration.rbs +18 -0
- data/sig/orb/models/billing_cycle_configuration.rbs +36 -0
- data/sig/orb/models/bps_config.rbs +15 -0
- data/sig/orb/models/bps_tier.rbs +35 -0
- data/sig/orb/models/bulk_bps_config.rbs +13 -0
- data/sig/orb/models/bulk_bps_tier.rbs +26 -0
- data/sig/orb/models/bulk_config.rbs +13 -0
- data/sig/orb/models/bulk_tier.rbs +15 -0
- data/sig/orb/models/changed_subscription_resources.rbs +35 -0
- data/sig/orb/models/conversion_rate_tier.rbs +26 -0
- data/sig/orb/models/conversion_rate_tiered_config.rbs +14 -0
- data/sig/orb/models/conversion_rate_unit_config.rbs +13 -0
- data/sig/orb/models/coupon_redemption.rbs +22 -0
- data/sig/orb/models/credit_note.rbs +8 -47
- data/sig/orb/models/credit_note_tiny.rbs +13 -0
- data/sig/orb/models/custom_expiration.rbs +36 -0
- data/sig/orb/models/customer.rbs +20 -471
- data/sig/orb/models/customer_create_params.rbs +27 -577
- data/sig/orb/models/customer_hierarchy_config.rbs +24 -0
- data/sig/orb/models/customer_minified.rbs +15 -0
- data/sig/orb/models/customer_tax_id.rbs +346 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +27 -577
- data/sig/orb/models/customer_update_params.rbs +27 -577
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +8 -28
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +8 -28
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +4 -84
- data/sig/orb/models/customers/cost_list_response.rbs +4 -83
- data/sig/orb/models/customers/credits/affected_block.rbs +30 -0
- data/sig/orb/models/customers/credits/amendment_ledger_entry.rbs +105 -0
- data/sig/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbs +107 -0
- data/sig/orb/models/customers/credits/decrement_ledger_entry.rbs +120 -0
- data/sig/orb/models/customers/credits/expiration_change_ledger_entry.rbs +110 -0
- data/sig/orb/models/customers/credits/increment_ledger_entry.rbs +110 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +7 -939
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +7 -939
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +7 -939
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +7 -939
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +4 -38
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +4 -38
- data/sig/orb/models/customers/credits/top_up_invoice_settings.rbs +41 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +4 -38
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +4 -38
- data/sig/orb/models/customers/credits/void_initiated_ledger_entry.rbs +120 -0
- data/sig/orb/models/customers/credits/void_ledger_entry.rbs +115 -0
- data/sig/orb/models/dimensional_price_configuration.rbs +22 -0
- data/sig/orb/models/discount_override.rbs +47 -0
- data/sig/orb/models/fixed_fee_quantity_schedule_entry.rbs +30 -0
- data/sig/orb/models/fixed_fee_quantity_transition.rbs +26 -0
- data/sig/orb/models/invoice.rbs +54 -1612
- data/sig/orb/models/invoice_create_params.rbs +4 -14
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -1612
- data/sig/orb/models/invoice_line_item_create_response.rbs +18 -927
- data/sig/orb/models/invoice_tiny.rbs +13 -0
- data/sig/orb/models/item_slim.rbs +15 -0
- data/sig/orb/models/matrix_config.rbs +30 -0
- data/sig/orb/models/matrix_sub_line_item.rbs +55 -0
- data/sig/orb/models/matrix_value.rbs +22 -0
- data/sig/orb/models/matrix_with_allocation_config.rbs +35 -0
- data/sig/orb/models/maximum.rbs +30 -0
- data/sig/orb/models/maximum_interval.rbs +40 -0
- data/sig/orb/models/minimum.rbs +30 -0
- data/sig/orb/models/minimum_interval.rbs +40 -0
- data/sig/orb/models/monetary_amount_discount_adjustment.rbs +65 -0
- data/sig/orb/models/monetary_maximum_adjustment.rbs +65 -0
- data/sig/orb/models/monetary_minimum_adjustment.rbs +70 -0
- data/sig/orb/models/monetary_percentage_discount_adjustment.rbs +65 -0
- data/sig/orb/models/monetary_usage_discount_adjustment.rbs +65 -0
- data/sig/orb/models/mutated_subscription.rbs +178 -0
- data/sig/orb/models/new_accounting_sync_configuration.rbs +25 -0
- data/sig/orb/models/new_allocation_price.rbs +56 -0
- data/sig/orb/models/new_amount_discount.rbs +97 -0
- data/sig/orb/models/new_avalara_tax_configuration.rbs +40 -0
- data/sig/orb/models/new_billing_cycle_configuration.rbs +36 -0
- data/sig/orb/models/new_dimensional_price_configuration.rbs +30 -0
- data/sig/orb/models/new_floating_bps_price.rbs +135 -0
- data/sig/orb/models/new_floating_bulk_bps_price.rbs +135 -0
- data/sig/orb/models/new_floating_bulk_price.rbs +135 -0
- data/sig/orb/models/new_floating_bulk_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_floating_cumulative_grouped_bulk_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_allocation_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_tiered_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_with_metered_minimum_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_with_prorated_minimum_price.rbs +135 -0
- data/sig/orb/models/new_floating_matrix_price.rbs +135 -0
- data/sig/orb/models/new_floating_matrix_with_allocation_price.rbs +135 -0
- data/sig/orb/models/new_floating_matrix_with_display_name_price.rbs +135 -0
- data/sig/orb/models/new_floating_max_group_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_floating_package_price.rbs +135 -0
- data/sig/orb/models/new_floating_package_with_allocation_price.rbs +135 -0
- data/sig/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
- data/sig/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbs +135 -0
- data/sig/orb/models/new_floating_threshold_total_amount_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_bps_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_package_with_minimum_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_with_minimum_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_floating_unit_price.rbs +135 -0
- data/sig/orb/models/new_floating_unit_with_percent_price.rbs +135 -0
- data/sig/orb/models/new_floating_unit_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_maximum.rbs +97 -0
- data/sig/orb/models/new_minimum.rbs +102 -0
- data/sig/orb/models/new_percentage_discount.rbs +97 -0
- data/sig/orb/models/new_plan_bps_price.rbs +135 -0
- data/sig/orb/models/new_plan_bulk_bps_price.rbs +135 -0
- data/sig/orb/models/new_plan_bulk_price.rbs +135 -0
- data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_allocation_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_tiered_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +135 -0
- data/sig/orb/models/new_plan_matrix_price.rbs +135 -0
- data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +135 -0
- data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +135 -0
- data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_plan_package_price.rbs +135 -0
- data/sig/orb/models/new_plan_package_with_allocation_price.rbs +135 -0
- data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
- data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +135 -0
- data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +135 -0
- data/sig/orb/models/new_plan_tier_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_bps_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +135 -0
- data/sig/orb/models/new_plan_unit_price.rbs +135 -0
- data/sig/orb/models/new_plan_unit_with_percent_price.rbs +135 -0
- data/sig/orb/models/new_plan_unit_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_reporting_configuration.rbs +13 -0
- data/sig/orb/models/new_sphere_configuration.rbs +35 -0
- data/sig/orb/models/new_subscription_bps_price.rbs +140 -0
- data/sig/orb/models/new_subscription_bulk_bps_price.rbs +140 -0
- data/sig/orb/models/new_subscription_bulk_price.rbs +140 -0
- data/sig/orb/models/new_subscription_bulk_with_proration_price.rbs +140 -0
- data/sig/orb/models/new_subscription_cumulative_grouped_bulk_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_allocation_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_tiered_package_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_tiered_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_with_metered_minimum_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbs +140 -0
- data/sig/orb/models/new_subscription_matrix_price.rbs +140 -0
- data/sig/orb/models/new_subscription_matrix_with_allocation_price.rbs +140 -0
- data/sig/orb/models/new_subscription_matrix_with_display_name_price.rbs +140 -0
- data/sig/orb/models/new_subscription_max_group_tiered_package_price.rbs +140 -0
- data/sig/orb/models/new_subscription_package_price.rbs +140 -0
- data/sig/orb/models/new_subscription_package_with_allocation_price.rbs +140 -0
- data/sig/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbs +140 -0
- data/sig/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbs +140 -0
- data/sig/orb/models/new_subscription_threshold_total_amount_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tier_with_proration_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_bps_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_package_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_package_with_minimum_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_with_minimum_price.rbs +140 -0
- data/sig/orb/models/new_subscription_unit_price.rbs +140 -0
- data/sig/orb/models/new_subscription_unit_with_percent_price.rbs +140 -0
- data/sig/orb/models/new_subscription_unit_with_proration_price.rbs +140 -0
- data/sig/orb/models/new_tax_jar_configuration.rbs +35 -0
- data/sig/orb/models/new_usage_discount.rbs +97 -0
- data/sig/orb/models/other_sub_line_item.rbs +50 -0
- data/sig/orb/models/package_config.rbs +15 -0
- data/sig/orb/models/per_price_cost.rbs +40 -0
- data/sig/orb/models/percentage_discount.rbs +4 -57
- data/sig/orb/models/percentage_discount_interval.rbs +55 -0
- data/sig/orb/models/plan.rbs +21 -871
- data/sig/orb/models/plan_create_params.rbs +28 -5952
- data/sig/orb/models/plan_phase_amount_discount_adjustment.rbs +65 -0
- data/sig/orb/models/plan_phase_maximum_adjustment.rbs +65 -0
- data/sig/orb/models/plan_phase_minimum_adjustment.rbs +70 -0
- data/sig/orb/models/plan_phase_percentage_discount_adjustment.rbs +65 -0
- data/sig/orb/models/plan_phase_usage_discount_adjustment.rbs +65 -0
- data/sig/orb/models/plan_version.rbs +5 -535
- data/sig/orb/models/price.rbs +2164 -11297
- data/sig/orb/models/price_create_params.rbs +58 -418
- data/sig/orb/models/price_evaluate_multiple_params.rbs +28 -6138
- data/sig/orb/models/price_evaluate_preview_events_params.rbs +166 -0
- data/sig/orb/models/price_evaluate_preview_events_response.rbs +50 -0
- data/sig/orb/models/price_interval.rbs +65 -0
- data/sig/orb/models/sub_line_item_grouping.rbs +15 -0
- data/sig/orb/models/sub_line_item_matrix_config.rbs +13 -0
- data/sig/orb/models/subscription.rbs +39 -1274
- data/sig/orb/models/subscription_change_apply_response.rbs +4 -1467
- data/sig/orb/models/subscription_change_cancel_response.rbs +4 -1467
- data/sig/orb/models/subscription_change_minified.rbs +13 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +4 -1467
- data/sig/orb/models/subscription_create_params.rbs +176 -14331
- data/sig/orb/models/subscription_fetch_costs_response.rbs +4 -82
- data/sig/orb/models/subscription_minified.rbs +13 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +61 -6945
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +178 -14333
- data/sig/orb/models/subscription_trial_info.rbs +13 -0
- data/sig/orb/models/tax_amount.rbs +30 -0
- data/sig/orb/models/threshold.rbs +13 -0
- data/sig/orb/models/tier.rbs +25 -0
- data/sig/orb/models/tier_config.rbs +26 -0
- data/sig/orb/models/tier_sub_line_item.rbs +55 -0
- data/sig/orb/models/tiered_bps_config.rbs +13 -0
- data/sig/orb/models/tiered_config.rbs +13 -0
- data/sig/orb/models/tiered_conversion_rate_config.rbs +35 -0
- data/sig/orb/models/transform_price_filter.rbs +56 -0
- data/sig/orb/models/trial_discount.rbs +4 -57
- data/sig/orb/models/unit_config.rbs +13 -0
- data/sig/orb/models/unit_conversion_rate_config.rbs +35 -0
- data/sig/orb/models/usage_discount.rbs +4 -57
- data/sig/orb/models/usage_discount_interval.rbs +55 -0
- data/sig/orb/models.rbs +342 -0
- data/sig/orb/resources/alerts.rbs +4 -4
- data/sig/orb/resources/customers.rbs +18 -18
- data/sig/orb/resources/prices.rbs +23 -13
- data/sig/orb/resources/subscriptions.rbs +13 -13
- metadata +545 -35
- data/lib/orb/models/subscription_cancel_response.rb +0 -1873
- data/lib/orb/models/subscription_create_response.rb +0 -1873
- data/lib/orb/models/subscription_price_intervals_response.rb +0 -1888
- data/lib/orb/models/subscription_redeem_coupon_response.rb +0 -1883
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +0 -1893
- data/lib/orb/models/subscription_trigger_phase_response.rb +0 -1883
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +0 -1897
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +0 -1912
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +0 -1908
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +0 -1897
- data/lib/orb/models/subscription_update_trial_response.rb +0 -1879
- data/rbi/orb/models/subscription_cancel_response.rbi +0 -3537
- data/rbi/orb/models/subscription_create_response.rbi +0 -3537
- data/rbi/orb/models/subscription_price_intervals_response.rbi +0 -3564
- data/rbi/orb/models/subscription_redeem_coupon_response.rbi +0 -3557
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +0 -3564
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +0 -3557
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +0 -3566
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +0 -3566
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +0 -3566
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +0 -3566
- data/rbi/orb/models/subscription_update_trial_response.rbi +0 -3556
- data/sig/orb/models/subscription_cancel_response.rbs +0 -1445
- data/sig/orb/models/subscription_create_response.rbs +0 -1445
- data/sig/orb/models/subscription_price_intervals_response.rbs +0 -1445
- data/sig/orb/models/subscription_redeem_coupon_response.rbs +0 -1445
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +0 -1445
- data/sig/orb/models/subscription_trigger_phase_response.rbs +0 -1445
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +0 -1445
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +0 -1445
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +0 -1445
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +0 -1445
- data/sig/orb/models/subscription_update_trial_response.rbs +0 -1445
@@ -23,8 +23,8 @@ module Orb
|
|
23
23
|
|
24
24
|
# @!attribute billing_address
|
25
25
|
#
|
26
|
-
# @return [Orb::Models::
|
27
|
-
required :billing_address, -> { Orb::
|
26
|
+
# @return [Orb::Models::Address, nil]
|
27
|
+
required :billing_address, -> { Orb::Address }, nil?: true
|
28
28
|
|
29
29
|
# @!attribute created_at
|
30
30
|
# The creation time of the resource in Orb.
|
@@ -47,8 +47,8 @@ module Orb
|
|
47
47
|
|
48
48
|
# @!attribute customer
|
49
49
|
#
|
50
|
-
# @return [Orb::Models::
|
51
|
-
required :customer, -> { Orb::
|
50
|
+
# @return [Orb::Models::CustomerMinified]
|
51
|
+
required :customer, -> { Orb::CustomerMinified }
|
52
52
|
|
53
53
|
# @!attribute customer_balance_transactions
|
54
54
|
#
|
@@ -163,8 +163,8 @@ module Orb
|
|
163
163
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
164
164
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
165
165
|
#
|
166
|
-
# @return [Orb::Models::
|
167
|
-
required :customer_tax_id, -> { Orb::
|
166
|
+
# @return [Orb::Models::CustomerTaxID, nil]
|
167
|
+
required :customer_tax_id, -> { Orb::CustomerTaxID }, nil?: true
|
168
168
|
|
169
169
|
# @!attribute discount
|
170
170
|
# @deprecated
|
@@ -245,8 +245,8 @@ module Orb
|
|
245
245
|
|
246
246
|
# @!attribute maximum
|
247
247
|
#
|
248
|
-
# @return [Orb::Models::
|
249
|
-
required :maximum, -> { Orb::
|
248
|
+
# @return [Orb::Models::Maximum, nil]
|
249
|
+
required :maximum, -> { Orb::Maximum }, nil?: true
|
250
250
|
|
251
251
|
# @!attribute maximum_amount
|
252
252
|
#
|
@@ -270,8 +270,8 @@ module Orb
|
|
270
270
|
|
271
271
|
# @!attribute minimum
|
272
272
|
#
|
273
|
-
# @return [Orb::Models::
|
274
|
-
required :minimum, -> { Orb::
|
273
|
+
# @return [Orb::Models::Minimum, nil]
|
274
|
+
required :minimum, -> { Orb::Minimum }, nil?: true
|
275
275
|
|
276
276
|
# @!attribute minimum_amount
|
277
277
|
#
|
@@ -316,8 +316,8 @@ module Orb
|
|
316
316
|
|
317
317
|
# @!attribute shipping_address
|
318
318
|
#
|
319
|
-
# @return [Orb::Models::
|
320
|
-
required :shipping_address, -> { Orb::
|
319
|
+
# @return [Orb::Models::Address, nil]
|
320
|
+
required :shipping_address, -> { Orb::Address }, nil?: true
|
321
321
|
|
322
322
|
# @!attribute status
|
323
323
|
#
|
@@ -326,8 +326,8 @@ module Orb
|
|
326
326
|
|
327
327
|
# @!attribute subscription
|
328
328
|
#
|
329
|
-
# @return [Orb::Models::
|
330
|
-
required :subscription, -> { Orb::
|
329
|
+
# @return [Orb::Models::SubscriptionMinified, nil]
|
330
|
+
required :subscription, -> { Orb::SubscriptionMinified }, nil?: true
|
331
331
|
|
332
332
|
# @!attribute subtotal
|
333
333
|
# The total before any discounts and minimums are applied.
|
@@ -379,7 +379,7 @@ module Orb
|
|
379
379
|
#
|
380
380
|
# @param auto_collection [Orb::Models::InvoiceFetchUpcomingResponse::AutoCollection]
|
381
381
|
#
|
382
|
-
# @param billing_address [Orb::Models::
|
382
|
+
# @param billing_address [Orb::Models::Address, nil]
|
383
383
|
#
|
384
384
|
# @param created_at [Time] The creation time of the resource in Orb.
|
385
385
|
#
|
@@ -387,11 +387,11 @@ module Orb
|
|
387
387
|
#
|
388
388
|
# @param currency [String] An ISO 4217 currency string or `credits`
|
389
389
|
#
|
390
|
-
# @param customer [Orb::Models::
|
390
|
+
# @param customer [Orb::Models::CustomerMinified]
|
391
391
|
#
|
392
392
|
# @param customer_balance_transactions [Array<Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction>]
|
393
393
|
#
|
394
|
-
# @param customer_tax_id [Orb::Models::
|
394
|
+
# @param customer_tax_id [Orb::Models::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
395
395
|
#
|
396
396
|
# @param discount [Object] This field is deprecated in favor of `discounts`. If a `discounts` list is provi
|
397
397
|
#
|
@@ -415,7 +415,7 @@ module Orb
|
|
415
415
|
#
|
416
416
|
# @param line_items [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem>] The breakdown of prices in this invoice.
|
417
417
|
#
|
418
|
-
# @param maximum [Orb::Models::
|
418
|
+
# @param maximum [Orb::Models::Maximum, nil]
|
419
419
|
#
|
420
420
|
# @param maximum_amount [String, nil]
|
421
421
|
#
|
@@ -423,7 +423,7 @@ module Orb
|
|
423
423
|
#
|
424
424
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
425
425
|
#
|
426
|
-
# @param minimum [Orb::Models::
|
426
|
+
# @param minimum [Orb::Models::Minimum, nil]
|
427
427
|
#
|
428
428
|
# @param minimum_amount [String, nil]
|
429
429
|
#
|
@@ -437,11 +437,11 @@ module Orb
|
|
437
437
|
#
|
438
438
|
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
439
439
|
#
|
440
|
-
# @param shipping_address [Orb::Models::
|
440
|
+
# @param shipping_address [Orb::Models::Address, nil]
|
441
441
|
#
|
442
442
|
# @param status [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Status]
|
443
443
|
#
|
444
|
-
# @param subscription [Orb::Models::
|
444
|
+
# @param subscription [Orb::Models::SubscriptionMinified, nil]
|
445
445
|
#
|
446
446
|
# @param subtotal [String] The total before any discounts and minimums are applied.
|
447
447
|
#
|
@@ -501,47 +501,6 @@ module Orb
|
|
501
501
|
# @param previously_attempted_at [Time, nil] If Orb has ever attempted payment auto-collection for this invoice, this field w
|
502
502
|
end
|
503
503
|
|
504
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse#billing_address
|
505
|
-
class BillingAddress < Orb::Internal::Type::BaseModel
|
506
|
-
# @!attribute city
|
507
|
-
#
|
508
|
-
# @return [String, nil]
|
509
|
-
required :city, String, nil?: true
|
510
|
-
|
511
|
-
# @!attribute country
|
512
|
-
#
|
513
|
-
# @return [String, nil]
|
514
|
-
required :country, String, nil?: true
|
515
|
-
|
516
|
-
# @!attribute line1
|
517
|
-
#
|
518
|
-
# @return [String, nil]
|
519
|
-
required :line1, String, nil?: true
|
520
|
-
|
521
|
-
# @!attribute line2
|
522
|
-
#
|
523
|
-
# @return [String, nil]
|
524
|
-
required :line2, String, nil?: true
|
525
|
-
|
526
|
-
# @!attribute postal_code
|
527
|
-
#
|
528
|
-
# @return [String, nil]
|
529
|
-
required :postal_code, String, nil?: true
|
530
|
-
|
531
|
-
# @!attribute state
|
532
|
-
#
|
533
|
-
# @return [String, nil]
|
534
|
-
required :state, String, nil?: true
|
535
|
-
|
536
|
-
# @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
|
537
|
-
# @param city [String, nil]
|
538
|
-
# @param country [String, nil]
|
539
|
-
# @param line1 [String, nil]
|
540
|
-
# @param line2 [String, nil]
|
541
|
-
# @param postal_code [String, nil]
|
542
|
-
# @param state [String, nil]
|
543
|
-
end
|
544
|
-
|
545
504
|
class CreditNote < Orb::Internal::Type::BaseModel
|
546
505
|
# @!attribute id
|
547
506
|
#
|
@@ -600,23 +559,6 @@ module Orb
|
|
600
559
|
# @param voided_at [Time, nil] If the credit note has a status of `void`, this gives a timestamp when the credi
|
601
560
|
end
|
602
561
|
|
603
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse#customer
|
604
|
-
class Customer < Orb::Internal::Type::BaseModel
|
605
|
-
# @!attribute id
|
606
|
-
#
|
607
|
-
# @return [String]
|
608
|
-
required :id, String
|
609
|
-
|
610
|
-
# @!attribute external_customer_id
|
611
|
-
#
|
612
|
-
# @return [String, nil]
|
613
|
-
required :external_customer_id, String, nil?: true
|
614
|
-
|
615
|
-
# @!method initialize(id:, external_customer_id:)
|
616
|
-
# @param id [String]
|
617
|
-
# @param external_customer_id [String, nil]
|
618
|
-
end
|
619
|
-
|
620
562
|
class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
|
621
563
|
# @!attribute id
|
622
564
|
# A unique id for this transaction.
|
@@ -644,10 +586,8 @@ module Orb
|
|
644
586
|
|
645
587
|
# @!attribute credit_note
|
646
588
|
#
|
647
|
-
# @return [Orb::Models::
|
648
|
-
required :credit_note,
|
649
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::CreditNote },
|
650
|
-
nil?: true
|
589
|
+
# @return [Orb::Models::CreditNoteTiny, nil]
|
590
|
+
required :credit_note, -> { Orb::CreditNoteTiny }, nil?: true
|
651
591
|
|
652
592
|
# @!attribute description
|
653
593
|
# An optional description provided for manual customer balance adjustments.
|
@@ -664,10 +604,8 @@ module Orb
|
|
664
604
|
|
665
605
|
# @!attribute invoice
|
666
606
|
#
|
667
|
-
# @return [Orb::Models::
|
668
|
-
required :invoice,
|
669
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Invoice },
|
670
|
-
nil?: true
|
607
|
+
# @return [Orb::Models::InvoiceTiny, nil]
|
608
|
+
required :invoice, -> { Orb::InvoiceTiny }, nil?: true
|
671
609
|
|
672
610
|
# @!attribute starting_balance
|
673
611
|
# The original value of the customer's balance prior to the transaction, in the
|
@@ -694,13 +632,13 @@ module Orb
|
|
694
632
|
#
|
695
633
|
# @param created_at [Time] The creation time of this transaction.
|
696
634
|
#
|
697
|
-
# @param credit_note [Orb::Models::
|
635
|
+
# @param credit_note [Orb::Models::CreditNoteTiny, nil]
|
698
636
|
#
|
699
637
|
# @param description [String, nil] An optional description provided for manual customer balance adjustments.
|
700
638
|
#
|
701
639
|
# @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
|
702
640
|
#
|
703
|
-
# @param invoice [Orb::Models::
|
641
|
+
# @param invoice [Orb::Models::InvoiceTiny, nil]
|
704
642
|
#
|
705
643
|
# @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
|
706
644
|
#
|
@@ -724,30 +662,6 @@ module Orb
|
|
724
662
|
# @return [Array<Symbol>]
|
725
663
|
end
|
726
664
|
|
727
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#credit_note
|
728
|
-
class CreditNote < Orb::Internal::Type::BaseModel
|
729
|
-
# @!attribute id
|
730
|
-
# The id of the Credit note
|
731
|
-
#
|
732
|
-
# @return [String]
|
733
|
-
required :id, String
|
734
|
-
|
735
|
-
# @!method initialize(id:)
|
736
|
-
# @param id [String] The id of the Credit note
|
737
|
-
end
|
738
|
-
|
739
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#invoice
|
740
|
-
class Invoice < Orb::Internal::Type::BaseModel
|
741
|
-
# @!attribute id
|
742
|
-
# The Invoice id
|
743
|
-
#
|
744
|
-
# @return [String]
|
745
|
-
required :id, String
|
746
|
-
|
747
|
-
# @!method initialize(id:)
|
748
|
-
# @param id [String] The Invoice id
|
749
|
-
end
|
750
|
-
|
751
665
|
# @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#type
|
752
666
|
module Type
|
753
667
|
extend Orb::Internal::Type::Enum
|
@@ -760,302 +674,6 @@ module Orb
|
|
760
674
|
end
|
761
675
|
end
|
762
676
|
|
763
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse#customer_tax_id
|
764
|
-
class CustomerTaxID < Orb::Internal::Type::BaseModel
|
765
|
-
# @!attribute country
|
766
|
-
#
|
767
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country]
|
768
|
-
required :country, enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country }
|
769
|
-
|
770
|
-
# @!attribute type
|
771
|
-
#
|
772
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type]
|
773
|
-
required :type, enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type }
|
774
|
-
|
775
|
-
# @!attribute value
|
776
|
-
#
|
777
|
-
# @return [String]
|
778
|
-
required :value, String
|
779
|
-
|
780
|
-
# @!method initialize(country:, type:, value:)
|
781
|
-
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
782
|
-
# added to the headers of invoices.
|
783
|
-
#
|
784
|
-
# ### Supported Tax ID Countries and Types
|
785
|
-
#
|
786
|
-
# | Country | Type | Description |
|
787
|
-
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
788
|
-
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
789
|
-
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
790
|
-
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
791
|
-
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
792
|
-
# | Austria | `eu_vat` | European VAT Number |
|
793
|
-
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
794
|
-
# | Belgium | `eu_vat` | European VAT Number |
|
795
|
-
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
796
|
-
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
797
|
-
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
798
|
-
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
799
|
-
# | Bulgaria | `eu_vat` | European VAT Number |
|
800
|
-
# | Canada | `ca_bn` | Canadian BN |
|
801
|
-
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
802
|
-
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
803
|
-
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
804
|
-
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
805
|
-
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
806
|
-
# | Chile | `cl_tin` | Chilean TIN |
|
807
|
-
# | China | `cn_tin` | Chinese Tax ID |
|
808
|
-
# | Colombia | `co_nit` | Colombian NIT Number |
|
809
|
-
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
810
|
-
# | Croatia | `eu_vat` | European VAT Number |
|
811
|
-
# | Cyprus | `eu_vat` | European VAT Number |
|
812
|
-
# | Czech Republic | `eu_vat` | European VAT Number |
|
813
|
-
# | Denmark | `eu_vat` | European VAT Number |
|
814
|
-
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
815
|
-
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
816
|
-
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
817
|
-
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
818
|
-
# | Estonia | `eu_vat` | European VAT Number |
|
819
|
-
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
820
|
-
# | Finland | `eu_vat` | European VAT Number |
|
821
|
-
# | France | `eu_vat` | European VAT Number |
|
822
|
-
# | Georgia | `ge_vat` | Georgian VAT |
|
823
|
-
# | Germany | `eu_vat` | European VAT Number |
|
824
|
-
# | Greece | `eu_vat` | European VAT Number |
|
825
|
-
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
826
|
-
# | Hungary | `eu_vat` | European VAT Number |
|
827
|
-
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
828
|
-
# | Iceland | `is_vat` | Icelandic VAT |
|
829
|
-
# | India | `in_gst` | Indian GST Number |
|
830
|
-
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
831
|
-
# | Ireland | `eu_vat` | European VAT Number |
|
832
|
-
# | Israel | `il_vat` | Israel VAT |
|
833
|
-
# | Italy | `eu_vat` | European VAT Number |
|
834
|
-
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
835
|
-
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
836
|
-
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
837
|
-
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
838
|
-
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
839
|
-
# | Latvia | `eu_vat` | European VAT Number |
|
840
|
-
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
841
|
-
# | Lithuania | `eu_vat` | European VAT Number |
|
842
|
-
# | Luxembourg | `eu_vat` | European VAT Number |
|
843
|
-
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
844
|
-
# | Malaysia | `my_itn` | Malaysian ITN |
|
845
|
-
# | Malaysia | `my_sst` | Malaysian SST Number |
|
846
|
-
# | Malta | `eu_vat ` | European VAT Number |
|
847
|
-
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
848
|
-
# | Netherlands | `eu_vat` | European VAT Number |
|
849
|
-
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
850
|
-
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
851
|
-
# | Norway | `no_vat` | Norwegian VAT Number |
|
852
|
-
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
853
|
-
# | Oman | `om_vat` | Omani VAT Number |
|
854
|
-
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
855
|
-
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
856
|
-
# | Poland | `eu_vat` | European VAT Number |
|
857
|
-
# | Portugal | `eu_vat` | European VAT Number |
|
858
|
-
# | Romania | `eu_vat` | European VAT Number |
|
859
|
-
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
860
|
-
# | Russia | `ru_inn` | Russian INN |
|
861
|
-
# | Russia | `ru_kpp` | Russian KPP |
|
862
|
-
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
863
|
-
# | Serbia | `rs_pib` | Serbian PIB Number |
|
864
|
-
# | Singapore | `sg_gst` | Singaporean GST |
|
865
|
-
# | Singapore | `sg_uen` | Singaporean UEN |
|
866
|
-
# | Slovakia | `eu_vat` | European VAT Number |
|
867
|
-
# | Slovenia | `eu_vat` | European VAT Number |
|
868
|
-
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
869
|
-
# | South Africa | `za_vat` | South African VAT Number |
|
870
|
-
# | South Korea | `kr_brn` | Korean BRN |
|
871
|
-
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
872
|
-
# | Spain | `eu_vat` | European VAT Number |
|
873
|
-
# | Sweden | `eu_vat` | European VAT Number |
|
874
|
-
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
875
|
-
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
876
|
-
# | Thailand | `th_vat` | Thai VAT |
|
877
|
-
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
878
|
-
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
879
|
-
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
880
|
-
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
881
|
-
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
882
|
-
# | United States | `us_ein` | United States EIN |
|
883
|
-
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
884
|
-
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
885
|
-
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
886
|
-
#
|
887
|
-
# @param country [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country]
|
888
|
-
# @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type]
|
889
|
-
# @param value [String]
|
890
|
-
|
891
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID#country
|
892
|
-
module Country
|
893
|
-
extend Orb::Internal::Type::Enum
|
894
|
-
|
895
|
-
AD = :AD
|
896
|
-
AE = :AE
|
897
|
-
AR = :AR
|
898
|
-
AT = :AT
|
899
|
-
AU = :AU
|
900
|
-
BE = :BE
|
901
|
-
BG = :BG
|
902
|
-
BH = :BH
|
903
|
-
BO = :BO
|
904
|
-
BR = :BR
|
905
|
-
CA = :CA
|
906
|
-
CH = :CH
|
907
|
-
CL = :CL
|
908
|
-
CN = :CN
|
909
|
-
CO = :CO
|
910
|
-
CR = :CR
|
911
|
-
CY = :CY
|
912
|
-
CZ = :CZ
|
913
|
-
DE = :DE
|
914
|
-
DK = :DK
|
915
|
-
EE = :EE
|
916
|
-
DO = :DO
|
917
|
-
EC = :EC
|
918
|
-
EG = :EG
|
919
|
-
ES = :ES
|
920
|
-
EU = :EU
|
921
|
-
FI = :FI
|
922
|
-
FR = :FR
|
923
|
-
GB = :GB
|
924
|
-
GE = :GE
|
925
|
-
GR = :GR
|
926
|
-
HK = :HK
|
927
|
-
HR = :HR
|
928
|
-
HU = :HU
|
929
|
-
ID = :ID
|
930
|
-
IE = :IE
|
931
|
-
IL = :IL
|
932
|
-
IN = :IN
|
933
|
-
IS = :IS
|
934
|
-
IT = :IT
|
935
|
-
JP = :JP
|
936
|
-
KE = :KE
|
937
|
-
KR = :KR
|
938
|
-
KZ = :KZ
|
939
|
-
LI = :LI
|
940
|
-
LT = :LT
|
941
|
-
LU = :LU
|
942
|
-
LV = :LV
|
943
|
-
MT = :MT
|
944
|
-
MX = :MX
|
945
|
-
MY = :MY
|
946
|
-
NG = :NG
|
947
|
-
NL = :NL
|
948
|
-
NO = :NO
|
949
|
-
NZ = :NZ
|
950
|
-
OM = :OM
|
951
|
-
PE = :PE
|
952
|
-
PH = :PH
|
953
|
-
PL = :PL
|
954
|
-
PT = :PT
|
955
|
-
RO = :RO
|
956
|
-
RS = :RS
|
957
|
-
RU = :RU
|
958
|
-
SA = :SA
|
959
|
-
SE = :SE
|
960
|
-
SG = :SG
|
961
|
-
SI = :SI
|
962
|
-
SK = :SK
|
963
|
-
SV = :SV
|
964
|
-
TH = :TH
|
965
|
-
TR = :TR
|
966
|
-
TW = :TW
|
967
|
-
UA = :UA
|
968
|
-
US = :US
|
969
|
-
UY = :UY
|
970
|
-
VE = :VE
|
971
|
-
VN = :VN
|
972
|
-
ZA = :ZA
|
973
|
-
|
974
|
-
# @!method self.values
|
975
|
-
# @return [Array<Symbol>]
|
976
|
-
end
|
977
|
-
|
978
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID#type
|
979
|
-
module Type
|
980
|
-
extend Orb::Internal::Type::Enum
|
981
|
-
|
982
|
-
AD_NRT = :ad_nrt
|
983
|
-
AE_TRN = :ae_trn
|
984
|
-
AR_CUIT = :ar_cuit
|
985
|
-
EU_VAT = :eu_vat
|
986
|
-
AU_ABN = :au_abn
|
987
|
-
AU_ARN = :au_arn
|
988
|
-
BG_UIC = :bg_uic
|
989
|
-
BH_VAT = :bh_vat
|
990
|
-
BO_TIN = :bo_tin
|
991
|
-
BR_CNPJ = :br_cnpj
|
992
|
-
BR_CPF = :br_cpf
|
993
|
-
CA_BN = :ca_bn
|
994
|
-
CA_GST_HST = :ca_gst_hst
|
995
|
-
CA_PST_BC = :ca_pst_bc
|
996
|
-
CA_PST_MB = :ca_pst_mb
|
997
|
-
CA_PST_SK = :ca_pst_sk
|
998
|
-
CA_QST = :ca_qst
|
999
|
-
CH_VAT = :ch_vat
|
1000
|
-
CL_TIN = :cl_tin
|
1001
|
-
CN_TIN = :cn_tin
|
1002
|
-
CO_NIT = :co_nit
|
1003
|
-
CR_TIN = :cr_tin
|
1004
|
-
DO_RCN = :do_rcn
|
1005
|
-
EC_RUC = :ec_ruc
|
1006
|
-
EG_TIN = :eg_tin
|
1007
|
-
ES_CIF = :es_cif
|
1008
|
-
EU_OSS_VAT = :eu_oss_vat
|
1009
|
-
GB_VAT = :gb_vat
|
1010
|
-
GE_VAT = :ge_vat
|
1011
|
-
HK_BR = :hk_br
|
1012
|
-
HU_TIN = :hu_tin
|
1013
|
-
ID_NPWP = :id_npwp
|
1014
|
-
IL_VAT = :il_vat
|
1015
|
-
IN_GST = :in_gst
|
1016
|
-
IS_VAT = :is_vat
|
1017
|
-
JP_CN = :jp_cn
|
1018
|
-
JP_RN = :jp_rn
|
1019
|
-
JP_TRN = :jp_trn
|
1020
|
-
KE_PIN = :ke_pin
|
1021
|
-
KR_BRN = :kr_brn
|
1022
|
-
KZ_BIN = :kz_bin
|
1023
|
-
LI_UID = :li_uid
|
1024
|
-
MX_RFC = :mx_rfc
|
1025
|
-
MY_FRP = :my_frp
|
1026
|
-
MY_ITN = :my_itn
|
1027
|
-
MY_SST = :my_sst
|
1028
|
-
NG_TIN = :ng_tin
|
1029
|
-
NO_VAT = :no_vat
|
1030
|
-
NO_VOEC = :no_voec
|
1031
|
-
NZ_GST = :nz_gst
|
1032
|
-
OM_VAT = :om_vat
|
1033
|
-
PE_RUC = :pe_ruc
|
1034
|
-
PH_TIN = :ph_tin
|
1035
|
-
RO_TIN = :ro_tin
|
1036
|
-
RS_PIB = :rs_pib
|
1037
|
-
RU_INN = :ru_inn
|
1038
|
-
RU_KPP = :ru_kpp
|
1039
|
-
SA_VAT = :sa_vat
|
1040
|
-
SG_GST = :sg_gst
|
1041
|
-
SG_UEN = :sg_uen
|
1042
|
-
SI_TIN = :si_tin
|
1043
|
-
SV_NIT = :sv_nit
|
1044
|
-
TH_VAT = :th_vat
|
1045
|
-
TR_TIN = :tr_tin
|
1046
|
-
TW_VAT = :tw_vat
|
1047
|
-
UA_VAT = :ua_vat
|
1048
|
-
US_EIN = :us_ein
|
1049
|
-
UY_RUC = :uy_ruc
|
1050
|
-
VE_RIF = :ve_rif
|
1051
|
-
VN_TIN = :vn_tin
|
1052
|
-
ZA_VAT = :za_vat
|
1053
|
-
|
1054
|
-
# @!method self.values
|
1055
|
-
# @return [Array<Symbol>]
|
1056
|
-
end
|
1057
|
-
end
|
1058
|
-
|
1059
677
|
# @see Orb::Models::InvoiceFetchUpcomingResponse#invoice_source
|
1060
678
|
module InvoiceSource
|
1061
679
|
extend Orb::Internal::Type::Enum
|
@@ -1087,7 +705,7 @@ module Orb
|
|
1087
705
|
# invoice calculations (ie. usage discounts -> amount discounts -> percentage
|
1088
706
|
# discounts -> minimums -> maximums).
|
1089
707
|
#
|
1090
|
-
# @return [Array<Orb::Models::
|
708
|
+
# @return [Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>]
|
1091
709
|
required :adjustments,
|
1092
710
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment] }
|
1093
711
|
|
@@ -1134,8 +752,8 @@ module Orb
|
|
1134
752
|
#
|
1135
753
|
# This field is deprecated in favor of `adjustments`.
|
1136
754
|
#
|
1137
|
-
# @return [Orb::Models::
|
1138
|
-
required :maximum, -> { Orb::
|
755
|
+
# @return [Orb::Models::Maximum, nil]
|
756
|
+
required :maximum, -> { Orb::Maximum }, nil?: true
|
1139
757
|
|
1140
758
|
# @!attribute maximum_amount
|
1141
759
|
# @deprecated
|
@@ -1150,8 +768,8 @@ module Orb
|
|
1150
768
|
#
|
1151
769
|
# This field is deprecated in favor of `adjustments`.
|
1152
770
|
#
|
1153
|
-
# @return [Orb::Models::
|
1154
|
-
required :minimum, -> { Orb::
|
771
|
+
# @return [Orb::Models::Minimum, nil]
|
772
|
+
required :minimum, -> { Orb::Minimum }, nil?: true
|
1155
773
|
|
1156
774
|
# @!attribute minimum_amount
|
1157
775
|
# @deprecated
|
@@ -1185,7 +803,7 @@ module Orb
|
|
1185
803
|
# For more on the types of prices, see
|
1186
804
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1187
805
|
#
|
1188
|
-
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::
|
806
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
|
1189
807
|
required :price, union: -> { Orb::Price }
|
1190
808
|
|
1191
809
|
# @!attribute quantity
|
@@ -1204,7 +822,7 @@ module Orb
|
|
1204
822
|
# For complex pricing structures, the line item can be broken down further in
|
1205
823
|
# `sub_line_items`.
|
1206
824
|
#
|
1207
|
-
# @return [Array<Orb::Models::
|
825
|
+
# @return [Array<Orb::Models::MatrixSubLineItem, Orb::Models::TierSubLineItem, Orb::Models::OtherSubLineItem>]
|
1208
826
|
required :sub_line_items,
|
1209
827
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem] }
|
1210
828
|
|
@@ -1218,9 +836,8 @@ module Orb
|
|
1218
836
|
# An array of tax rates and their incurred tax amounts. Empty if no tax
|
1219
837
|
# integration is configured.
|
1220
838
|
#
|
1221
|
-
# @return [Array<Orb::Models::
|
1222
|
-
required :tax_amounts,
|
1223
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::TaxAmount] }
|
839
|
+
# @return [Array<Orb::Models::TaxAmount>]
|
840
|
+
required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::TaxAmount] }
|
1224
841
|
|
1225
842
|
# @!attribute usage_customer_ids
|
1226
843
|
# A list of customer ids that were used to calculate the usage for this line item.
|
@@ -1236,7 +853,7 @@ module Orb
|
|
1236
853
|
#
|
1237
854
|
# @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
|
1238
855
|
#
|
1239
|
-
# @param adjustments [Array<Orb::Models::
|
856
|
+
# @param adjustments [Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>] All adjustments applied to the line item in the order they were applied based on
|
1240
857
|
#
|
1241
858
|
# @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
|
1242
859
|
#
|
@@ -1250,11 +867,11 @@ module Orb
|
|
1250
867
|
#
|
1251
868
|
# @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b
|
1252
869
|
#
|
1253
|
-
# @param maximum [Orb::Models::
|
870
|
+
# @param maximum [Orb::Models::Maximum, nil] This field is deprecated in favor of `adjustments`.
|
1254
871
|
#
|
1255
872
|
# @param maximum_amount [String, nil] This field is deprecated in favor of `adjustments`.
|
1256
873
|
#
|
1257
|
-
# @param minimum [Orb::Models::
|
874
|
+
# @param minimum [Orb::Models::Minimum, nil] This field is deprecated in favor of `adjustments`.
|
1258
875
|
#
|
1259
876
|
# @param minimum_amount [String, nil] This field is deprecated in favor of `adjustments`.
|
1260
877
|
#
|
@@ -1262,17 +879,17 @@ module Orb
|
|
1262
879
|
#
|
1263
880
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
1264
881
|
#
|
1265
|
-
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::
|
882
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1266
883
|
#
|
1267
884
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
1268
885
|
#
|
1269
886
|
# @param start_date [Time] The start date of the range of time applied for this line item's price.
|
1270
887
|
#
|
1271
|
-
# @param sub_line_items [Array<Orb::Models::
|
888
|
+
# @param sub_line_items [Array<Orb::Models::MatrixSubLineItem, Orb::Models::TierSubLineItem, Orb::Models::OtherSubLineItem>] For complex pricing structures, the line item can be broken down further in `sub
|
1272
889
|
#
|
1273
890
|
# @param subtotal [String] The line amount before before any adjustments.
|
1274
891
|
#
|
1275
|
-
# @param tax_amounts [Array<Orb::Models::
|
892
|
+
# @param tax_amounts [Array<Orb::Models::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
|
1276
893
|
#
|
1277
894
|
# @param usage_customer_ids [Array<String>, nil] A list of customer ids that were used to calculate the usage for this line item.
|
1278
895
|
|
@@ -1281,1336 +898,33 @@ module Orb
|
|
1281
898
|
|
1282
899
|
discriminator :adjustment_type
|
1283
900
|
|
1284
|
-
variant :usage_discount,
|
1285
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount }
|
1286
|
-
|
1287
|
-
variant :amount_discount,
|
1288
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount }
|
1289
|
-
|
1290
|
-
variant :percentage_discount,
|
1291
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount }
|
1292
|
-
|
1293
|
-
variant :minimum, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum }
|
1294
|
-
|
1295
|
-
variant :maximum, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum }
|
1296
|
-
|
1297
|
-
class UsageDiscount < Orb::Internal::Type::BaseModel
|
1298
|
-
# @!attribute id
|
1299
|
-
#
|
1300
|
-
# @return [String]
|
1301
|
-
required :id, String
|
1302
|
-
|
1303
|
-
# @!attribute adjustment_type
|
1304
|
-
#
|
1305
|
-
# @return [Symbol, :usage_discount]
|
1306
|
-
required :adjustment_type, const: :usage_discount
|
1307
|
-
|
1308
|
-
# @!attribute amount
|
1309
|
-
# The value applied by an adjustment.
|
1310
|
-
#
|
1311
|
-
# @return [String]
|
1312
|
-
required :amount, String
|
1313
|
-
|
1314
|
-
# @!attribute applies_to_price_ids
|
1315
|
-
# @deprecated
|
1316
|
-
#
|
1317
|
-
# The price IDs that this adjustment applies to.
|
1318
|
-
#
|
1319
|
-
# @return [Array<String>]
|
1320
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
1321
|
-
|
1322
|
-
# @!attribute filters
|
1323
|
-
# The filters that determine which prices to apply this adjustment to.
|
1324
|
-
#
|
1325
|
-
# @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount::Filter>]
|
1326
|
-
required :filters,
|
1327
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount::Filter] }
|
1328
|
-
|
1329
|
-
# @!attribute is_invoice_level
|
1330
|
-
# True for adjustments that apply to an entire invocice, false for adjustments
|
1331
|
-
# that apply to only one price.
|
1332
|
-
#
|
1333
|
-
# @return [Boolean]
|
1334
|
-
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1335
|
-
|
1336
|
-
# @!attribute reason
|
1337
|
-
# The reason for the adjustment.
|
1338
|
-
#
|
1339
|
-
# @return [String, nil]
|
1340
|
-
required :reason, String, nil?: true
|
1341
|
-
|
1342
|
-
# @!attribute usage_discount
|
1343
|
-
# The number of usage units by which to discount the price this adjustment applies
|
1344
|
-
# to in a given billing period.
|
1345
|
-
#
|
1346
|
-
# @return [Float]
|
1347
|
-
required :usage_discount, Float
|
1348
|
-
|
1349
|
-
# @!method initialize(id:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
1350
|
-
# Some parameter documentations has been truncated, see
|
1351
|
-
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount}
|
1352
|
-
# for more details.
|
1353
|
-
#
|
1354
|
-
# @param id [String]
|
1355
|
-
#
|
1356
|
-
# @param amount [String] The value applied by an adjustment.
|
1357
|
-
#
|
1358
|
-
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1359
|
-
#
|
1360
|
-
# @param filters [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
1361
|
-
#
|
1362
|
-
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1363
|
-
#
|
1364
|
-
# @param reason [String, nil] The reason for the adjustment.
|
1365
|
-
#
|
1366
|
-
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
1367
|
-
#
|
1368
|
-
# @param adjustment_type [Symbol, :usage_discount]
|
1369
|
-
|
1370
|
-
class Filter < Orb::Internal::Type::BaseModel
|
1371
|
-
# @!attribute field
|
1372
|
-
# The property of the price to filter on.
|
1373
|
-
#
|
1374
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount::Filter::Field]
|
1375
|
-
required :field,
|
1376
|
-
enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount::Filter::Field }
|
1377
|
-
|
1378
|
-
# @!attribute operator
|
1379
|
-
# Should prices that match the filter be included or excluded.
|
1380
|
-
#
|
1381
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount::Filter::Operator]
|
1382
|
-
required :operator,
|
1383
|
-
enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount::Filter::Operator }
|
1384
|
-
|
1385
|
-
# @!attribute values
|
1386
|
-
# The IDs or values that match this filter.
|
1387
|
-
#
|
1388
|
-
# @return [Array<String>]
|
1389
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
1390
|
-
|
1391
|
-
# @!method initialize(field:, operator:, values:)
|
1392
|
-
# @param field [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount::Filter::Field] The property of the price to filter on.
|
1393
|
-
#
|
1394
|
-
# @param operator [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
1395
|
-
#
|
1396
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
1397
|
-
|
1398
|
-
# The property of the price to filter on.
|
1399
|
-
#
|
1400
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount::Filter#field
|
1401
|
-
module Field
|
1402
|
-
extend Orb::Internal::Type::Enum
|
1403
|
-
|
1404
|
-
PRICE_ID = :price_id
|
1405
|
-
ITEM_ID = :item_id
|
1406
|
-
PRICE_TYPE = :price_type
|
1407
|
-
CURRENCY = :currency
|
1408
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
1409
|
-
|
1410
|
-
# @!method self.values
|
1411
|
-
# @return [Array<Symbol>]
|
1412
|
-
end
|
1413
|
-
|
1414
|
-
# Should prices that match the filter be included or excluded.
|
1415
|
-
#
|
1416
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount::Filter#operator
|
1417
|
-
module Operator
|
1418
|
-
extend Orb::Internal::Type::Enum
|
1419
|
-
|
1420
|
-
INCLUDES = :includes
|
1421
|
-
EXCLUDES = :excludes
|
1422
|
-
|
1423
|
-
# @!method self.values
|
1424
|
-
# @return [Array<Symbol>]
|
1425
|
-
end
|
1426
|
-
end
|
1427
|
-
end
|
1428
|
-
|
1429
|
-
class AmountDiscount < Orb::Internal::Type::BaseModel
|
1430
|
-
# @!attribute id
|
1431
|
-
#
|
1432
|
-
# @return [String]
|
1433
|
-
required :id, String
|
1434
|
-
|
1435
|
-
# @!attribute adjustment_type
|
1436
|
-
#
|
1437
|
-
# @return [Symbol, :amount_discount]
|
1438
|
-
required :adjustment_type, const: :amount_discount
|
1439
|
-
|
1440
|
-
# @!attribute amount
|
1441
|
-
# The value applied by an adjustment.
|
1442
|
-
#
|
1443
|
-
# @return [String]
|
1444
|
-
required :amount, String
|
1445
|
-
|
1446
|
-
# @!attribute amount_discount
|
1447
|
-
# The amount by which to discount the prices this adjustment applies to in a given
|
1448
|
-
# billing period.
|
1449
|
-
#
|
1450
|
-
# @return [String]
|
1451
|
-
required :amount_discount, String
|
1452
|
-
|
1453
|
-
# @!attribute applies_to_price_ids
|
1454
|
-
# @deprecated
|
1455
|
-
#
|
1456
|
-
# The price IDs that this adjustment applies to.
|
1457
|
-
#
|
1458
|
-
# @return [Array<String>]
|
1459
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
1460
|
-
|
1461
|
-
# @!attribute filters
|
1462
|
-
# The filters that determine which prices to apply this adjustment to.
|
1463
|
-
#
|
1464
|
-
# @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount::Filter>]
|
1465
|
-
required :filters,
|
1466
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount::Filter] }
|
1467
|
-
|
1468
|
-
# @!attribute is_invoice_level
|
1469
|
-
# True for adjustments that apply to an entire invocice, false for adjustments
|
1470
|
-
# that apply to only one price.
|
1471
|
-
#
|
1472
|
-
# @return [Boolean]
|
1473
|
-
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1474
|
-
|
1475
|
-
# @!attribute reason
|
1476
|
-
# The reason for the adjustment.
|
1477
|
-
#
|
1478
|
-
# @return [String, nil]
|
1479
|
-
required :reason, String, nil?: true
|
1480
|
-
|
1481
|
-
# @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, filters:, is_invoice_level:, reason:, adjustment_type: :amount_discount)
|
1482
|
-
# Some parameter documentations has been truncated, see
|
1483
|
-
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount}
|
1484
|
-
# for more details.
|
1485
|
-
#
|
1486
|
-
# @param id [String]
|
1487
|
-
#
|
1488
|
-
# @param amount [String] The value applied by an adjustment.
|
1489
|
-
#
|
1490
|
-
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
1491
|
-
#
|
1492
|
-
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1493
|
-
#
|
1494
|
-
# @param filters [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
1495
|
-
#
|
1496
|
-
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1497
|
-
#
|
1498
|
-
# @param reason [String, nil] The reason for the adjustment.
|
1499
|
-
#
|
1500
|
-
# @param adjustment_type [Symbol, :amount_discount]
|
1501
|
-
|
1502
|
-
class Filter < Orb::Internal::Type::BaseModel
|
1503
|
-
# @!attribute field
|
1504
|
-
# The property of the price to filter on.
|
1505
|
-
#
|
1506
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount::Filter::Field]
|
1507
|
-
required :field,
|
1508
|
-
enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount::Filter::Field }
|
1509
|
-
|
1510
|
-
# @!attribute operator
|
1511
|
-
# Should prices that match the filter be included or excluded.
|
1512
|
-
#
|
1513
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount::Filter::Operator]
|
1514
|
-
required :operator,
|
1515
|
-
enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount::Filter::Operator }
|
1516
|
-
|
1517
|
-
# @!attribute values
|
1518
|
-
# The IDs or values that match this filter.
|
1519
|
-
#
|
1520
|
-
# @return [Array<String>]
|
1521
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
1522
|
-
|
1523
|
-
# @!method initialize(field:, operator:, values:)
|
1524
|
-
# @param field [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount::Filter::Field] The property of the price to filter on.
|
1525
|
-
#
|
1526
|
-
# @param operator [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
1527
|
-
#
|
1528
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
1529
|
-
|
1530
|
-
# The property of the price to filter on.
|
1531
|
-
#
|
1532
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount::Filter#field
|
1533
|
-
module Field
|
1534
|
-
extend Orb::Internal::Type::Enum
|
1535
|
-
|
1536
|
-
PRICE_ID = :price_id
|
1537
|
-
ITEM_ID = :item_id
|
1538
|
-
PRICE_TYPE = :price_type
|
1539
|
-
CURRENCY = :currency
|
1540
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
1541
|
-
|
1542
|
-
# @!method self.values
|
1543
|
-
# @return [Array<Symbol>]
|
1544
|
-
end
|
1545
|
-
|
1546
|
-
# Should prices that match the filter be included or excluded.
|
1547
|
-
#
|
1548
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount::Filter#operator
|
1549
|
-
module Operator
|
1550
|
-
extend Orb::Internal::Type::Enum
|
1551
|
-
|
1552
|
-
INCLUDES = :includes
|
1553
|
-
EXCLUDES = :excludes
|
1554
|
-
|
1555
|
-
# @!method self.values
|
1556
|
-
# @return [Array<Symbol>]
|
1557
|
-
end
|
1558
|
-
end
|
1559
|
-
end
|
1560
|
-
|
1561
|
-
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
1562
|
-
# @!attribute id
|
1563
|
-
#
|
1564
|
-
# @return [String]
|
1565
|
-
required :id, String
|
1566
|
-
|
1567
|
-
# @!attribute adjustment_type
|
1568
|
-
#
|
1569
|
-
# @return [Symbol, :percentage_discount]
|
1570
|
-
required :adjustment_type, const: :percentage_discount
|
1571
|
-
|
1572
|
-
# @!attribute amount
|
1573
|
-
# The value applied by an adjustment.
|
1574
|
-
#
|
1575
|
-
# @return [String]
|
1576
|
-
required :amount, String
|
1577
|
-
|
1578
|
-
# @!attribute applies_to_price_ids
|
1579
|
-
# @deprecated
|
1580
|
-
#
|
1581
|
-
# The price IDs that this adjustment applies to.
|
1582
|
-
#
|
1583
|
-
# @return [Array<String>]
|
1584
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
1585
|
-
|
1586
|
-
# @!attribute filters
|
1587
|
-
# The filters that determine which prices to apply this adjustment to.
|
1588
|
-
#
|
1589
|
-
# @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount::Filter>]
|
1590
|
-
required :filters,
|
1591
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount::Filter] }
|
1592
|
-
|
1593
|
-
# @!attribute is_invoice_level
|
1594
|
-
# True for adjustments that apply to an entire invocice, false for adjustments
|
1595
|
-
# that apply to only one price.
|
1596
|
-
#
|
1597
|
-
# @return [Boolean]
|
1598
|
-
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1599
|
-
|
1600
|
-
# @!attribute percentage_discount
|
1601
|
-
# The percentage (as a value between 0 and 1) by which to discount the price
|
1602
|
-
# intervals this adjustment applies to in a given billing period.
|
1603
|
-
#
|
1604
|
-
# @return [Float]
|
1605
|
-
required :percentage_discount, Float
|
1606
|
-
|
1607
|
-
# @!attribute reason
|
1608
|
-
# The reason for the adjustment.
|
1609
|
-
#
|
1610
|
-
# @return [String, nil]
|
1611
|
-
required :reason, String, nil?: true
|
1612
|
-
|
1613
|
-
# @!method initialize(id:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount)
|
1614
|
-
# Some parameter documentations has been truncated, see
|
1615
|
-
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount}
|
1616
|
-
# for more details.
|
1617
|
-
#
|
1618
|
-
# @param id [String]
|
1619
|
-
#
|
1620
|
-
# @param amount [String] The value applied by an adjustment.
|
1621
|
-
#
|
1622
|
-
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1623
|
-
#
|
1624
|
-
# @param filters [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
1625
|
-
#
|
1626
|
-
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1627
|
-
#
|
1628
|
-
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
1629
|
-
#
|
1630
|
-
# @param reason [String, nil] The reason for the adjustment.
|
1631
|
-
#
|
1632
|
-
# @param adjustment_type [Symbol, :percentage_discount]
|
1633
|
-
|
1634
|
-
class Filter < Orb::Internal::Type::BaseModel
|
1635
|
-
# @!attribute field
|
1636
|
-
# The property of the price to filter on.
|
1637
|
-
#
|
1638
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount::Filter::Field]
|
1639
|
-
required :field,
|
1640
|
-
enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount::Filter::Field }
|
1641
|
-
|
1642
|
-
# @!attribute operator
|
1643
|
-
# Should prices that match the filter be included or excluded.
|
1644
|
-
#
|
1645
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount::Filter::Operator]
|
1646
|
-
required :operator,
|
1647
|
-
enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount::Filter::Operator }
|
1648
|
-
|
1649
|
-
# @!attribute values
|
1650
|
-
# The IDs or values that match this filter.
|
1651
|
-
#
|
1652
|
-
# @return [Array<String>]
|
1653
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
1654
|
-
|
1655
|
-
# @!method initialize(field:, operator:, values:)
|
1656
|
-
# @param field [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount::Filter::Field] The property of the price to filter on.
|
1657
|
-
#
|
1658
|
-
# @param operator [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
1659
|
-
#
|
1660
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
1661
|
-
|
1662
|
-
# The property of the price to filter on.
|
1663
|
-
#
|
1664
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount::Filter#field
|
1665
|
-
module Field
|
1666
|
-
extend Orb::Internal::Type::Enum
|
1667
|
-
|
1668
|
-
PRICE_ID = :price_id
|
1669
|
-
ITEM_ID = :item_id
|
1670
|
-
PRICE_TYPE = :price_type
|
1671
|
-
CURRENCY = :currency
|
1672
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
1673
|
-
|
1674
|
-
# @!method self.values
|
1675
|
-
# @return [Array<Symbol>]
|
1676
|
-
end
|
1677
|
-
|
1678
|
-
# Should prices that match the filter be included or excluded.
|
1679
|
-
#
|
1680
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount::Filter#operator
|
1681
|
-
module Operator
|
1682
|
-
extend Orb::Internal::Type::Enum
|
1683
|
-
|
1684
|
-
INCLUDES = :includes
|
1685
|
-
EXCLUDES = :excludes
|
1686
|
-
|
1687
|
-
# @!method self.values
|
1688
|
-
# @return [Array<Symbol>]
|
1689
|
-
end
|
1690
|
-
end
|
1691
|
-
end
|
1692
|
-
|
1693
|
-
class Minimum < Orb::Internal::Type::BaseModel
|
1694
|
-
# @!attribute id
|
1695
|
-
#
|
1696
|
-
# @return [String]
|
1697
|
-
required :id, String
|
1698
|
-
|
1699
|
-
# @!attribute adjustment_type
|
1700
|
-
#
|
1701
|
-
# @return [Symbol, :minimum]
|
1702
|
-
required :adjustment_type, const: :minimum
|
1703
|
-
|
1704
|
-
# @!attribute amount
|
1705
|
-
# The value applied by an adjustment.
|
1706
|
-
#
|
1707
|
-
# @return [String]
|
1708
|
-
required :amount, String
|
1709
|
-
|
1710
|
-
# @!attribute applies_to_price_ids
|
1711
|
-
# @deprecated
|
1712
|
-
#
|
1713
|
-
# The price IDs that this adjustment applies to.
|
1714
|
-
#
|
1715
|
-
# @return [Array<String>]
|
1716
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
1717
|
-
|
1718
|
-
# @!attribute filters
|
1719
|
-
# The filters that determine which prices to apply this adjustment to.
|
1720
|
-
#
|
1721
|
-
# @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum::Filter>]
|
1722
|
-
required :filters,
|
1723
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum::Filter] }
|
1724
|
-
|
1725
|
-
# @!attribute is_invoice_level
|
1726
|
-
# True for adjustments that apply to an entire invocice, false for adjustments
|
1727
|
-
# that apply to only one price.
|
1728
|
-
#
|
1729
|
-
# @return [Boolean]
|
1730
|
-
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1731
|
-
|
1732
|
-
# @!attribute item_id
|
1733
|
-
# The item ID that revenue from this minimum will be attributed to.
|
1734
|
-
#
|
1735
|
-
# @return [String]
|
1736
|
-
required :item_id, String
|
1737
|
-
|
1738
|
-
# @!attribute minimum_amount
|
1739
|
-
# The minimum amount to charge in a given billing period for the prices this
|
1740
|
-
# adjustment applies to.
|
1741
|
-
#
|
1742
|
-
# @return [String]
|
1743
|
-
required :minimum_amount, String
|
1744
|
-
|
1745
|
-
# @!attribute reason
|
1746
|
-
# The reason for the adjustment.
|
1747
|
-
#
|
1748
|
-
# @return [String, nil]
|
1749
|
-
required :reason, String, nil?: true
|
1750
|
-
|
1751
|
-
# @!method initialize(id:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum)
|
1752
|
-
# Some parameter documentations has been truncated, see
|
1753
|
-
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum} for
|
1754
|
-
# more details.
|
1755
|
-
#
|
1756
|
-
# @param id [String]
|
1757
|
-
#
|
1758
|
-
# @param amount [String] The value applied by an adjustment.
|
1759
|
-
#
|
1760
|
-
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1761
|
-
#
|
1762
|
-
# @param filters [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum::Filter>] The filters that determine which prices to apply this adjustment to.
|
1763
|
-
#
|
1764
|
-
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1765
|
-
#
|
1766
|
-
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
1767
|
-
#
|
1768
|
-
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
1769
|
-
#
|
1770
|
-
# @param reason [String, nil] The reason for the adjustment.
|
1771
|
-
#
|
1772
|
-
# @param adjustment_type [Symbol, :minimum]
|
1773
|
-
|
1774
|
-
class Filter < Orb::Internal::Type::BaseModel
|
1775
|
-
# @!attribute field
|
1776
|
-
# The property of the price to filter on.
|
1777
|
-
#
|
1778
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum::Filter::Field]
|
1779
|
-
required :field,
|
1780
|
-
enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum::Filter::Field }
|
1781
|
-
|
1782
|
-
# @!attribute operator
|
1783
|
-
# Should prices that match the filter be included or excluded.
|
1784
|
-
#
|
1785
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum::Filter::Operator]
|
1786
|
-
required :operator,
|
1787
|
-
enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum::Filter::Operator }
|
1788
|
-
|
1789
|
-
# @!attribute values
|
1790
|
-
# The IDs or values that match this filter.
|
1791
|
-
#
|
1792
|
-
# @return [Array<String>]
|
1793
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
1794
|
-
|
1795
|
-
# @!method initialize(field:, operator:, values:)
|
1796
|
-
# @param field [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum::Filter::Field] The property of the price to filter on.
|
1797
|
-
#
|
1798
|
-
# @param operator [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
|
1799
|
-
#
|
1800
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
1801
|
-
|
1802
|
-
# The property of the price to filter on.
|
1803
|
-
#
|
1804
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum::Filter#field
|
1805
|
-
module Field
|
1806
|
-
extend Orb::Internal::Type::Enum
|
1807
|
-
|
1808
|
-
PRICE_ID = :price_id
|
1809
|
-
ITEM_ID = :item_id
|
1810
|
-
PRICE_TYPE = :price_type
|
1811
|
-
CURRENCY = :currency
|
1812
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
1813
|
-
|
1814
|
-
# @!method self.values
|
1815
|
-
# @return [Array<Symbol>]
|
1816
|
-
end
|
1817
|
-
|
1818
|
-
# Should prices that match the filter be included or excluded.
|
1819
|
-
#
|
1820
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum::Filter#operator
|
1821
|
-
module Operator
|
1822
|
-
extend Orb::Internal::Type::Enum
|
1823
|
-
|
1824
|
-
INCLUDES = :includes
|
1825
|
-
EXCLUDES = :excludes
|
1826
|
-
|
1827
|
-
# @!method self.values
|
1828
|
-
# @return [Array<Symbol>]
|
1829
|
-
end
|
1830
|
-
end
|
1831
|
-
end
|
1832
|
-
|
1833
|
-
class Maximum < Orb::Internal::Type::BaseModel
|
1834
|
-
# @!attribute id
|
1835
|
-
#
|
1836
|
-
# @return [String]
|
1837
|
-
required :id, String
|
1838
|
-
|
1839
|
-
# @!attribute adjustment_type
|
1840
|
-
#
|
1841
|
-
# @return [Symbol, :maximum]
|
1842
|
-
required :adjustment_type, const: :maximum
|
1843
|
-
|
1844
|
-
# @!attribute amount
|
1845
|
-
# The value applied by an adjustment.
|
1846
|
-
#
|
1847
|
-
# @return [String]
|
1848
|
-
required :amount, String
|
1849
|
-
|
1850
|
-
# @!attribute applies_to_price_ids
|
1851
|
-
# @deprecated
|
1852
|
-
#
|
1853
|
-
# The price IDs that this adjustment applies to.
|
1854
|
-
#
|
1855
|
-
# @return [Array<String>]
|
1856
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
1857
|
-
|
1858
|
-
# @!attribute filters
|
1859
|
-
# The filters that determine which prices to apply this adjustment to.
|
1860
|
-
#
|
1861
|
-
# @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum::Filter>]
|
1862
|
-
required :filters,
|
1863
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum::Filter] }
|
1864
|
-
|
1865
|
-
# @!attribute is_invoice_level
|
1866
|
-
# True for adjustments that apply to an entire invocice, false for adjustments
|
1867
|
-
# that apply to only one price.
|
1868
|
-
#
|
1869
|
-
# @return [Boolean]
|
1870
|
-
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1871
|
-
|
1872
|
-
# @!attribute maximum_amount
|
1873
|
-
# The maximum amount to charge in a given billing period for the prices this
|
1874
|
-
# adjustment applies to.
|
1875
|
-
#
|
1876
|
-
# @return [String]
|
1877
|
-
required :maximum_amount, String
|
1878
|
-
|
1879
|
-
# @!attribute reason
|
1880
|
-
# The reason for the adjustment.
|
1881
|
-
#
|
1882
|
-
# @return [String, nil]
|
1883
|
-
required :reason, String, nil?: true
|
1884
|
-
|
1885
|
-
# @!method initialize(id:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum)
|
1886
|
-
# Some parameter documentations has been truncated, see
|
1887
|
-
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum} for
|
1888
|
-
# more details.
|
1889
|
-
#
|
1890
|
-
# @param id [String]
|
1891
|
-
#
|
1892
|
-
# @param amount [String] The value applied by an adjustment.
|
1893
|
-
#
|
1894
|
-
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1895
|
-
#
|
1896
|
-
# @param filters [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum::Filter>] The filters that determine which prices to apply this adjustment to.
|
1897
|
-
#
|
1898
|
-
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1899
|
-
#
|
1900
|
-
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
1901
|
-
#
|
1902
|
-
# @param reason [String, nil] The reason for the adjustment.
|
1903
|
-
#
|
1904
|
-
# @param adjustment_type [Symbol, :maximum]
|
1905
|
-
|
1906
|
-
class Filter < Orb::Internal::Type::BaseModel
|
1907
|
-
# @!attribute field
|
1908
|
-
# The property of the price to filter on.
|
1909
|
-
#
|
1910
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum::Filter::Field]
|
1911
|
-
required :field,
|
1912
|
-
enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum::Filter::Field }
|
1913
|
-
|
1914
|
-
# @!attribute operator
|
1915
|
-
# Should prices that match the filter be included or excluded.
|
1916
|
-
#
|
1917
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum::Filter::Operator]
|
1918
|
-
required :operator,
|
1919
|
-
enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum::Filter::Operator }
|
1920
|
-
|
1921
|
-
# @!attribute values
|
1922
|
-
# The IDs or values that match this filter.
|
1923
|
-
#
|
1924
|
-
# @return [Array<String>]
|
1925
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
1926
|
-
|
1927
|
-
# @!method initialize(field:, operator:, values:)
|
1928
|
-
# @param field [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum::Filter::Field] The property of the price to filter on.
|
1929
|
-
#
|
1930
|
-
# @param operator [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
|
1931
|
-
#
|
1932
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
1933
|
-
|
1934
|
-
# The property of the price to filter on.
|
1935
|
-
#
|
1936
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum::Filter#field
|
1937
|
-
module Field
|
1938
|
-
extend Orb::Internal::Type::Enum
|
1939
|
-
|
1940
|
-
PRICE_ID = :price_id
|
1941
|
-
ITEM_ID = :item_id
|
1942
|
-
PRICE_TYPE = :price_type
|
1943
|
-
CURRENCY = :currency
|
1944
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
1945
|
-
|
1946
|
-
# @!method self.values
|
1947
|
-
# @return [Array<Symbol>]
|
1948
|
-
end
|
1949
|
-
|
1950
|
-
# Should prices that match the filter be included or excluded.
|
1951
|
-
#
|
1952
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum::Filter#operator
|
1953
|
-
module Operator
|
1954
|
-
extend Orb::Internal::Type::Enum
|
1955
|
-
|
1956
|
-
INCLUDES = :includes
|
1957
|
-
EXCLUDES = :excludes
|
1958
|
-
|
1959
|
-
# @!method self.values
|
1960
|
-
# @return [Array<Symbol>]
|
1961
|
-
end
|
1962
|
-
end
|
1963
|
-
end
|
1964
|
-
|
1965
|
-
# @!method self.variants
|
1966
|
-
# @return [Array(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum)]
|
1967
|
-
end
|
1968
|
-
|
1969
|
-
# @deprecated
|
1970
|
-
#
|
1971
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem#maximum
|
1972
|
-
class Maximum < Orb::Internal::Type::BaseModel
|
1973
|
-
# @!attribute applies_to_price_ids
|
1974
|
-
# @deprecated
|
1975
|
-
#
|
1976
|
-
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
1977
|
-
# maximums, this can be a subset of prices.
|
1978
|
-
#
|
1979
|
-
# @return [Array<String>]
|
1980
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
1981
|
-
|
1982
|
-
# @!attribute filters
|
1983
|
-
# The filters that determine which prices to apply this maximum to.
|
1984
|
-
#
|
1985
|
-
# @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum::Filter>]
|
1986
|
-
required :filters,
|
1987
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum::Filter] }
|
1988
|
-
|
1989
|
-
# @!attribute maximum_amount
|
1990
|
-
# Maximum amount applied
|
1991
|
-
#
|
1992
|
-
# @return [String]
|
1993
|
-
required :maximum_amount, String
|
1994
|
-
|
1995
|
-
# @!method initialize(applies_to_price_ids:, filters:, maximum_amount:)
|
1996
|
-
# Some parameter documentations has been truncated, see
|
1997
|
-
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum} for more details.
|
1998
|
-
#
|
1999
|
-
# This field is deprecated in favor of `adjustments`.
|
2000
|
-
#
|
2001
|
-
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
2002
|
-
#
|
2003
|
-
# @param filters [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum::Filter>] The filters that determine which prices to apply this maximum to.
|
2004
|
-
#
|
2005
|
-
# @param maximum_amount [String] Maximum amount applied
|
2006
|
-
|
2007
|
-
class Filter < Orb::Internal::Type::BaseModel
|
2008
|
-
# @!attribute field
|
2009
|
-
# The property of the price to filter on.
|
2010
|
-
#
|
2011
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum::Filter::Field]
|
2012
|
-
required :field, enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum::Filter::Field }
|
2013
|
-
|
2014
|
-
# @!attribute operator
|
2015
|
-
# Should prices that match the filter be included or excluded.
|
2016
|
-
#
|
2017
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum::Filter::Operator]
|
2018
|
-
required :operator,
|
2019
|
-
enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum::Filter::Operator }
|
2020
|
-
|
2021
|
-
# @!attribute values
|
2022
|
-
# The IDs or values that match this filter.
|
2023
|
-
#
|
2024
|
-
# @return [Array<String>]
|
2025
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
2026
|
-
|
2027
|
-
# @!method initialize(field:, operator:, values:)
|
2028
|
-
# @param field [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum::Filter::Field] The property of the price to filter on.
|
2029
|
-
#
|
2030
|
-
# @param operator [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
|
2031
|
-
#
|
2032
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
2033
|
-
|
2034
|
-
# The property of the price to filter on.
|
2035
|
-
#
|
2036
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum::Filter#field
|
2037
|
-
module Field
|
2038
|
-
extend Orb::Internal::Type::Enum
|
2039
|
-
|
2040
|
-
PRICE_ID = :price_id
|
2041
|
-
ITEM_ID = :item_id
|
2042
|
-
PRICE_TYPE = :price_type
|
2043
|
-
CURRENCY = :currency
|
2044
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
2045
|
-
|
2046
|
-
# @!method self.values
|
2047
|
-
# @return [Array<Symbol>]
|
2048
|
-
end
|
2049
|
-
|
2050
|
-
# Should prices that match the filter be included or excluded.
|
2051
|
-
#
|
2052
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum::Filter#operator
|
2053
|
-
module Operator
|
2054
|
-
extend Orb::Internal::Type::Enum
|
2055
|
-
|
2056
|
-
INCLUDES = :includes
|
2057
|
-
EXCLUDES = :excludes
|
2058
|
-
|
2059
|
-
# @!method self.values
|
2060
|
-
# @return [Array<Symbol>]
|
2061
|
-
end
|
2062
|
-
end
|
2063
|
-
end
|
901
|
+
variant :usage_discount, -> { Orb::MonetaryUsageDiscountAdjustment }
|
2064
902
|
|
2065
|
-
|
2066
|
-
#
|
2067
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem#minimum
|
2068
|
-
class Minimum < Orb::Internal::Type::BaseModel
|
2069
|
-
# @!attribute applies_to_price_ids
|
2070
|
-
# @deprecated
|
2071
|
-
#
|
2072
|
-
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
2073
|
-
# minimums, this can be a subset of prices.
|
2074
|
-
#
|
2075
|
-
# @return [Array<String>]
|
2076
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
2077
|
-
|
2078
|
-
# @!attribute filters
|
2079
|
-
# The filters that determine which prices to apply this minimum to.
|
2080
|
-
#
|
2081
|
-
# @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum::Filter>]
|
2082
|
-
required :filters,
|
2083
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum::Filter] }
|
2084
|
-
|
2085
|
-
# @!attribute minimum_amount
|
2086
|
-
# Minimum amount applied
|
2087
|
-
#
|
2088
|
-
# @return [String]
|
2089
|
-
required :minimum_amount, String
|
2090
|
-
|
2091
|
-
# @!method initialize(applies_to_price_ids:, filters:, minimum_amount:)
|
2092
|
-
# Some parameter documentations has been truncated, see
|
2093
|
-
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum} for more details.
|
2094
|
-
#
|
2095
|
-
# This field is deprecated in favor of `adjustments`.
|
2096
|
-
#
|
2097
|
-
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
2098
|
-
#
|
2099
|
-
# @param filters [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum::Filter>] The filters that determine which prices to apply this minimum to.
|
2100
|
-
#
|
2101
|
-
# @param minimum_amount [String] Minimum amount applied
|
2102
|
-
|
2103
|
-
class Filter < Orb::Internal::Type::BaseModel
|
2104
|
-
# @!attribute field
|
2105
|
-
# The property of the price to filter on.
|
2106
|
-
#
|
2107
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum::Filter::Field]
|
2108
|
-
required :field, enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum::Filter::Field }
|
2109
|
-
|
2110
|
-
# @!attribute operator
|
2111
|
-
# Should prices that match the filter be included or excluded.
|
2112
|
-
#
|
2113
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum::Filter::Operator]
|
2114
|
-
required :operator,
|
2115
|
-
enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum::Filter::Operator }
|
2116
|
-
|
2117
|
-
# @!attribute values
|
2118
|
-
# The IDs or values that match this filter.
|
2119
|
-
#
|
2120
|
-
# @return [Array<String>]
|
2121
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
2122
|
-
|
2123
|
-
# @!method initialize(field:, operator:, values:)
|
2124
|
-
# @param field [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum::Filter::Field] The property of the price to filter on.
|
2125
|
-
#
|
2126
|
-
# @param operator [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
|
2127
|
-
#
|
2128
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
2129
|
-
|
2130
|
-
# The property of the price to filter on.
|
2131
|
-
#
|
2132
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum::Filter#field
|
2133
|
-
module Field
|
2134
|
-
extend Orb::Internal::Type::Enum
|
2135
|
-
|
2136
|
-
PRICE_ID = :price_id
|
2137
|
-
ITEM_ID = :item_id
|
2138
|
-
PRICE_TYPE = :price_type
|
2139
|
-
CURRENCY = :currency
|
2140
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
2141
|
-
|
2142
|
-
# @!method self.values
|
2143
|
-
# @return [Array<Symbol>]
|
2144
|
-
end
|
2145
|
-
|
2146
|
-
# Should prices that match the filter be included or excluded.
|
2147
|
-
#
|
2148
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum::Filter#operator
|
2149
|
-
module Operator
|
2150
|
-
extend Orb::Internal::Type::Enum
|
2151
|
-
|
2152
|
-
INCLUDES = :includes
|
2153
|
-
EXCLUDES = :excludes
|
2154
|
-
|
2155
|
-
# @!method self.values
|
2156
|
-
# @return [Array<Symbol>]
|
2157
|
-
end
|
2158
|
-
end
|
2159
|
-
end
|
903
|
+
variant :amount_discount, -> { Orb::MonetaryAmountDiscountAdjustment }
|
2160
904
|
|
2161
|
-
|
2162
|
-
extend Orb::Internal::Type::Union
|
905
|
+
variant :percentage_discount, -> { Orb::MonetaryPercentageDiscountAdjustment }
|
2163
906
|
|
2164
|
-
|
907
|
+
variant :minimum, -> { Orb::MonetaryMinimumAdjustment }
|
2165
908
|
|
2166
|
-
variant :
|
2167
|
-
|
2168
|
-
variant :tier, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier }
|
2169
|
-
|
2170
|
-
variant :"'null'", -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null }
|
2171
|
-
|
2172
|
-
class Matrix < Orb::Internal::Type::BaseModel
|
2173
|
-
# @!attribute amount
|
2174
|
-
# The total amount for this sub line item.
|
2175
|
-
#
|
2176
|
-
# @return [String]
|
2177
|
-
required :amount, String
|
2178
|
-
|
2179
|
-
# @!attribute grouping
|
2180
|
-
#
|
2181
|
-
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::Grouping, nil]
|
2182
|
-
required :grouping,
|
2183
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::Grouping },
|
2184
|
-
nil?: true
|
2185
|
-
|
2186
|
-
# @!attribute matrix_config
|
2187
|
-
#
|
2188
|
-
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::MatrixConfig]
|
2189
|
-
required :matrix_config,
|
2190
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::MatrixConfig }
|
2191
|
-
|
2192
|
-
# @!attribute name
|
2193
|
-
#
|
2194
|
-
# @return [String]
|
2195
|
-
required :name, String
|
2196
|
-
|
2197
|
-
# @!attribute quantity
|
2198
|
-
#
|
2199
|
-
# @return [Float]
|
2200
|
-
required :quantity, Float
|
2201
|
-
|
2202
|
-
# @!attribute type
|
2203
|
-
#
|
2204
|
-
# @return [Symbol, :matrix]
|
2205
|
-
required :type, const: :matrix
|
2206
|
-
|
2207
|
-
# @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
|
2208
|
-
# @param amount [String] The total amount for this sub line item.
|
2209
|
-
#
|
2210
|
-
# @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::Grouping, nil]
|
2211
|
-
#
|
2212
|
-
# @param matrix_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::MatrixConfig]
|
2213
|
-
#
|
2214
|
-
# @param name [String]
|
2215
|
-
#
|
2216
|
-
# @param quantity [Float]
|
2217
|
-
#
|
2218
|
-
# @param type [Symbol, :matrix]
|
2219
|
-
|
2220
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix#grouping
|
2221
|
-
class Grouping < Orb::Internal::Type::BaseModel
|
2222
|
-
# @!attribute key
|
2223
|
-
#
|
2224
|
-
# @return [String]
|
2225
|
-
required :key, String
|
2226
|
-
|
2227
|
-
# @!attribute value
|
2228
|
-
# No value indicates the default group
|
2229
|
-
#
|
2230
|
-
# @return [String, nil]
|
2231
|
-
required :value, String, nil?: true
|
2232
|
-
|
2233
|
-
# @!method initialize(key:, value:)
|
2234
|
-
# @param key [String]
|
2235
|
-
#
|
2236
|
-
# @param value [String, nil] No value indicates the default group
|
2237
|
-
end
|
2238
|
-
|
2239
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix#matrix_config
|
2240
|
-
class MatrixConfig < Orb::Internal::Type::BaseModel
|
2241
|
-
# @!attribute dimension_values
|
2242
|
-
# The ordered dimension values for this line item.
|
2243
|
-
#
|
2244
|
-
# @return [Array<String, nil>]
|
2245
|
-
required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
|
2246
|
-
|
2247
|
-
# @!method initialize(dimension_values:)
|
2248
|
-
# @param dimension_values [Array<String, nil>] The ordered dimension values for this line item.
|
2249
|
-
end
|
2250
|
-
end
|
2251
|
-
|
2252
|
-
class Tier < Orb::Internal::Type::BaseModel
|
2253
|
-
# @!attribute amount
|
2254
|
-
# The total amount for this sub line item.
|
2255
|
-
#
|
2256
|
-
# @return [String]
|
2257
|
-
required :amount, String
|
2258
|
-
|
2259
|
-
# @!attribute grouping
|
2260
|
-
#
|
2261
|
-
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::Grouping, nil]
|
2262
|
-
required :grouping,
|
2263
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::Grouping },
|
2264
|
-
nil?: true
|
2265
|
-
|
2266
|
-
# @!attribute name
|
2267
|
-
#
|
2268
|
-
# @return [String]
|
2269
|
-
required :name, String
|
2270
|
-
|
2271
|
-
# @!attribute quantity
|
2272
|
-
#
|
2273
|
-
# @return [Float]
|
2274
|
-
required :quantity, Float
|
2275
|
-
|
2276
|
-
# @!attribute tier_config
|
2277
|
-
#
|
2278
|
-
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::TierConfig]
|
2279
|
-
required :tier_config,
|
2280
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::TierConfig }
|
2281
|
-
|
2282
|
-
# @!attribute type
|
2283
|
-
#
|
2284
|
-
# @return [Symbol, :tier]
|
2285
|
-
required :type, const: :tier
|
2286
|
-
|
2287
|
-
# @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier)
|
2288
|
-
# @param amount [String] The total amount for this sub line item.
|
2289
|
-
#
|
2290
|
-
# @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::Grouping, nil]
|
2291
|
-
#
|
2292
|
-
# @param name [String]
|
2293
|
-
#
|
2294
|
-
# @param quantity [Float]
|
2295
|
-
#
|
2296
|
-
# @param tier_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::TierConfig]
|
2297
|
-
#
|
2298
|
-
# @param type [Symbol, :tier]
|
2299
|
-
|
2300
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier#grouping
|
2301
|
-
class Grouping < Orb::Internal::Type::BaseModel
|
2302
|
-
# @!attribute key
|
2303
|
-
#
|
2304
|
-
# @return [String]
|
2305
|
-
required :key, String
|
2306
|
-
|
2307
|
-
# @!attribute value
|
2308
|
-
# No value indicates the default group
|
2309
|
-
#
|
2310
|
-
# @return [String, nil]
|
2311
|
-
required :value, String, nil?: true
|
2312
|
-
|
2313
|
-
# @!method initialize(key:, value:)
|
2314
|
-
# @param key [String]
|
2315
|
-
#
|
2316
|
-
# @param value [String, nil] No value indicates the default group
|
2317
|
-
end
|
2318
|
-
|
2319
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier#tier_config
|
2320
|
-
class TierConfig < Orb::Internal::Type::BaseModel
|
2321
|
-
# @!attribute first_unit
|
2322
|
-
#
|
2323
|
-
# @return [Float]
|
2324
|
-
required :first_unit, Float
|
2325
|
-
|
2326
|
-
# @!attribute last_unit
|
2327
|
-
#
|
2328
|
-
# @return [Float, nil]
|
2329
|
-
required :last_unit, Float, nil?: true
|
2330
|
-
|
2331
|
-
# @!attribute unit_amount
|
2332
|
-
#
|
2333
|
-
# @return [String]
|
2334
|
-
required :unit_amount, String
|
2335
|
-
|
2336
|
-
# @!method initialize(first_unit:, last_unit:, unit_amount:)
|
2337
|
-
# @param first_unit [Float]
|
2338
|
-
# @param last_unit [Float, nil]
|
2339
|
-
# @param unit_amount [String]
|
2340
|
-
end
|
2341
|
-
end
|
2342
|
-
|
2343
|
-
class Null < Orb::Internal::Type::BaseModel
|
2344
|
-
# @!attribute amount
|
2345
|
-
# The total amount for this sub line item.
|
2346
|
-
#
|
2347
|
-
# @return [String]
|
2348
|
-
required :amount, String
|
2349
|
-
|
2350
|
-
# @!attribute grouping
|
2351
|
-
#
|
2352
|
-
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null::Grouping, nil]
|
2353
|
-
required :grouping,
|
2354
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null::Grouping },
|
2355
|
-
nil?: true
|
2356
|
-
|
2357
|
-
# @!attribute name
|
2358
|
-
#
|
2359
|
-
# @return [String]
|
2360
|
-
required :name, String
|
2361
|
-
|
2362
|
-
# @!attribute quantity
|
2363
|
-
#
|
2364
|
-
# @return [Float]
|
2365
|
-
required :quantity, Float
|
2366
|
-
|
2367
|
-
# @!attribute type
|
2368
|
-
#
|
2369
|
-
# @return [Symbol, :"'null'"]
|
2370
|
-
required :type, const: :"'null'"
|
2371
|
-
|
2372
|
-
# @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'")
|
2373
|
-
# @param amount [String] The total amount for this sub line item.
|
2374
|
-
#
|
2375
|
-
# @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null::Grouping, nil]
|
2376
|
-
#
|
2377
|
-
# @param name [String]
|
2378
|
-
#
|
2379
|
-
# @param quantity [Float]
|
2380
|
-
#
|
2381
|
-
# @param type [Symbol, :"'null'"]
|
2382
|
-
|
2383
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null#grouping
|
2384
|
-
class Grouping < Orb::Internal::Type::BaseModel
|
2385
|
-
# @!attribute key
|
2386
|
-
#
|
2387
|
-
# @return [String]
|
2388
|
-
required :key, String
|
2389
|
-
|
2390
|
-
# @!attribute value
|
2391
|
-
# No value indicates the default group
|
2392
|
-
#
|
2393
|
-
# @return [String, nil]
|
2394
|
-
required :value, String, nil?: true
|
2395
|
-
|
2396
|
-
# @!method initialize(key:, value:)
|
2397
|
-
# @param key [String]
|
2398
|
-
#
|
2399
|
-
# @param value [String, nil] No value indicates the default group
|
2400
|
-
end
|
2401
|
-
end
|
909
|
+
variant :maximum, -> { Orb::MonetaryMaximumAdjustment }
|
2402
910
|
|
2403
911
|
# @!method self.variants
|
2404
|
-
# @return [Array(Orb::Models::
|
912
|
+
# @return [Array(Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment)]
|
2405
913
|
end
|
2406
914
|
|
2407
|
-
|
2408
|
-
|
2409
|
-
# The amount of additional tax incurred by this tax rate.
|
2410
|
-
#
|
2411
|
-
# @return [String]
|
2412
|
-
required :amount, String
|
2413
|
-
|
2414
|
-
# @!attribute tax_rate_description
|
2415
|
-
# The human-readable description of the applied tax rate.
|
2416
|
-
#
|
2417
|
-
# @return [String]
|
2418
|
-
required :tax_rate_description, String
|
2419
|
-
|
2420
|
-
# @!attribute tax_rate_percentage
|
2421
|
-
# The tax rate percentage, out of 100.
|
2422
|
-
#
|
2423
|
-
# @return [String, nil]
|
2424
|
-
required :tax_rate_percentage, String, nil?: true
|
2425
|
-
|
2426
|
-
# @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:)
|
2427
|
-
# @param amount [String] The amount of additional tax incurred by this tax rate.
|
2428
|
-
#
|
2429
|
-
# @param tax_rate_description [String] The human-readable description of the applied tax rate.
|
2430
|
-
#
|
2431
|
-
# @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100.
|
2432
|
-
end
|
2433
|
-
end
|
2434
|
-
|
2435
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse#maximum
|
2436
|
-
class Maximum < Orb::Internal::Type::BaseModel
|
2437
|
-
# @!attribute applies_to_price_ids
|
2438
|
-
# @deprecated
|
2439
|
-
#
|
2440
|
-
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
2441
|
-
# maximums, this can be a subset of prices.
|
2442
|
-
#
|
2443
|
-
# @return [Array<String>]
|
2444
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
2445
|
-
|
2446
|
-
# @!attribute filters
|
2447
|
-
# The filters that determine which prices to apply this maximum to.
|
2448
|
-
#
|
2449
|
-
# @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::Maximum::Filter>]
|
2450
|
-
required :filters,
|
2451
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceFetchUpcomingResponse::Maximum::Filter] }
|
2452
|
-
|
2453
|
-
# @!attribute maximum_amount
|
2454
|
-
# Maximum amount applied
|
2455
|
-
#
|
2456
|
-
# @return [String]
|
2457
|
-
required :maximum_amount, String
|
915
|
+
module SubLineItem
|
916
|
+
extend Orb::Internal::Type::Union
|
2458
917
|
|
2459
|
-
|
2460
|
-
# Some parameter documentations has been truncated, see
|
2461
|
-
# {Orb::Models::InvoiceFetchUpcomingResponse::Maximum} for more details.
|
2462
|
-
#
|
2463
|
-
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
2464
|
-
#
|
2465
|
-
# @param filters [Array<Orb::Models::InvoiceFetchUpcomingResponse::Maximum::Filter>] The filters that determine which prices to apply this maximum to.
|
2466
|
-
#
|
2467
|
-
# @param maximum_amount [String] Maximum amount applied
|
2468
|
-
|
2469
|
-
class Filter < Orb::Internal::Type::BaseModel
|
2470
|
-
# @!attribute field
|
2471
|
-
# The property of the price to filter on.
|
2472
|
-
#
|
2473
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Maximum::Filter::Field]
|
2474
|
-
required :field, enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::Maximum::Filter::Field }
|
2475
|
-
|
2476
|
-
# @!attribute operator
|
2477
|
-
# Should prices that match the filter be included or excluded.
|
2478
|
-
#
|
2479
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Maximum::Filter::Operator]
|
2480
|
-
required :operator, enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::Maximum::Filter::Operator }
|
2481
|
-
|
2482
|
-
# @!attribute values
|
2483
|
-
# The IDs or values that match this filter.
|
2484
|
-
#
|
2485
|
-
# @return [Array<String>]
|
2486
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
2487
|
-
|
2488
|
-
# @!method initialize(field:, operator:, values:)
|
2489
|
-
# @param field [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Maximum::Filter::Field] The property of the price to filter on.
|
2490
|
-
#
|
2491
|
-
# @param operator [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
|
2492
|
-
#
|
2493
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
2494
|
-
|
2495
|
-
# The property of the price to filter on.
|
2496
|
-
#
|
2497
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::Maximum::Filter#field
|
2498
|
-
module Field
|
2499
|
-
extend Orb::Internal::Type::Enum
|
2500
|
-
|
2501
|
-
PRICE_ID = :price_id
|
2502
|
-
ITEM_ID = :item_id
|
2503
|
-
PRICE_TYPE = :price_type
|
2504
|
-
CURRENCY = :currency
|
2505
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
2506
|
-
|
2507
|
-
# @!method self.values
|
2508
|
-
# @return [Array<Symbol>]
|
2509
|
-
end
|
2510
|
-
|
2511
|
-
# Should prices that match the filter be included or excluded.
|
2512
|
-
#
|
2513
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::Maximum::Filter#operator
|
2514
|
-
module Operator
|
2515
|
-
extend Orb::Internal::Type::Enum
|
2516
|
-
|
2517
|
-
INCLUDES = :includes
|
2518
|
-
EXCLUDES = :excludes
|
2519
|
-
|
2520
|
-
# @!method self.values
|
2521
|
-
# @return [Array<Symbol>]
|
2522
|
-
end
|
2523
|
-
end
|
2524
|
-
end
|
918
|
+
discriminator :type
|
2525
919
|
|
2526
|
-
|
2527
|
-
class Minimum < Orb::Internal::Type::BaseModel
|
2528
|
-
# @!attribute applies_to_price_ids
|
2529
|
-
# @deprecated
|
2530
|
-
#
|
2531
|
-
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
2532
|
-
# minimums, this can be a subset of prices.
|
2533
|
-
#
|
2534
|
-
# @return [Array<String>]
|
2535
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
920
|
+
variant :matrix, -> { Orb::MatrixSubLineItem }
|
2536
921
|
|
2537
|
-
|
2538
|
-
# The filters that determine which prices to apply this minimum to.
|
2539
|
-
#
|
2540
|
-
# @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::Minimum::Filter>]
|
2541
|
-
required :filters,
|
2542
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceFetchUpcomingResponse::Minimum::Filter] }
|
922
|
+
variant :tier, -> { Orb::TierSubLineItem }
|
2543
923
|
|
2544
|
-
|
2545
|
-
# Minimum amount applied
|
2546
|
-
#
|
2547
|
-
# @return [String]
|
2548
|
-
required :minimum_amount, String
|
924
|
+
variant :"'null'", -> { Orb::OtherSubLineItem }
|
2549
925
|
|
2550
|
-
|
2551
|
-
|
2552
|
-
# {Orb::Models::InvoiceFetchUpcomingResponse::Minimum} for more details.
|
2553
|
-
#
|
2554
|
-
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
2555
|
-
#
|
2556
|
-
# @param filters [Array<Orb::Models::InvoiceFetchUpcomingResponse::Minimum::Filter>] The filters that determine which prices to apply this minimum to.
|
2557
|
-
#
|
2558
|
-
# @param minimum_amount [String] Minimum amount applied
|
2559
|
-
|
2560
|
-
class Filter < Orb::Internal::Type::BaseModel
|
2561
|
-
# @!attribute field
|
2562
|
-
# The property of the price to filter on.
|
2563
|
-
#
|
2564
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Minimum::Filter::Field]
|
2565
|
-
required :field, enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::Minimum::Filter::Field }
|
2566
|
-
|
2567
|
-
# @!attribute operator
|
2568
|
-
# Should prices that match the filter be included or excluded.
|
2569
|
-
#
|
2570
|
-
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Minimum::Filter::Operator]
|
2571
|
-
required :operator, enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::Minimum::Filter::Operator }
|
2572
|
-
|
2573
|
-
# @!attribute values
|
2574
|
-
# The IDs or values that match this filter.
|
2575
|
-
#
|
2576
|
-
# @return [Array<String>]
|
2577
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
2578
|
-
|
2579
|
-
# @!method initialize(field:, operator:, values:)
|
2580
|
-
# @param field [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Minimum::Filter::Field] The property of the price to filter on.
|
2581
|
-
#
|
2582
|
-
# @param operator [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
|
2583
|
-
#
|
2584
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
2585
|
-
|
2586
|
-
# The property of the price to filter on.
|
2587
|
-
#
|
2588
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::Minimum::Filter#field
|
2589
|
-
module Field
|
2590
|
-
extend Orb::Internal::Type::Enum
|
2591
|
-
|
2592
|
-
PRICE_ID = :price_id
|
2593
|
-
ITEM_ID = :item_id
|
2594
|
-
PRICE_TYPE = :price_type
|
2595
|
-
CURRENCY = :currency
|
2596
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
2597
|
-
|
2598
|
-
# @!method self.values
|
2599
|
-
# @return [Array<Symbol>]
|
2600
|
-
end
|
2601
|
-
|
2602
|
-
# Should prices that match the filter be included or excluded.
|
2603
|
-
#
|
2604
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::Minimum::Filter#operator
|
2605
|
-
module Operator
|
2606
|
-
extend Orb::Internal::Type::Enum
|
2607
|
-
|
2608
|
-
INCLUDES = :includes
|
2609
|
-
EXCLUDES = :excludes
|
2610
|
-
|
2611
|
-
# @!method self.values
|
2612
|
-
# @return [Array<Symbol>]
|
2613
|
-
end
|
926
|
+
# @!method self.variants
|
927
|
+
# @return [Array(Orb::Models::MatrixSubLineItem, Orb::Models::TierSubLineItem, Orb::Models::OtherSubLineItem)]
|
2614
928
|
end
|
2615
929
|
end
|
2616
930
|
|
@@ -2679,47 +993,6 @@ module Orb
|
|
2679
993
|
end
|
2680
994
|
end
|
2681
995
|
|
2682
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse#shipping_address
|
2683
|
-
class ShippingAddress < Orb::Internal::Type::BaseModel
|
2684
|
-
# @!attribute city
|
2685
|
-
#
|
2686
|
-
# @return [String, nil]
|
2687
|
-
required :city, String, nil?: true
|
2688
|
-
|
2689
|
-
# @!attribute country
|
2690
|
-
#
|
2691
|
-
# @return [String, nil]
|
2692
|
-
required :country, String, nil?: true
|
2693
|
-
|
2694
|
-
# @!attribute line1
|
2695
|
-
#
|
2696
|
-
# @return [String, nil]
|
2697
|
-
required :line1, String, nil?: true
|
2698
|
-
|
2699
|
-
# @!attribute line2
|
2700
|
-
#
|
2701
|
-
# @return [String, nil]
|
2702
|
-
required :line2, String, nil?: true
|
2703
|
-
|
2704
|
-
# @!attribute postal_code
|
2705
|
-
#
|
2706
|
-
# @return [String, nil]
|
2707
|
-
required :postal_code, String, nil?: true
|
2708
|
-
|
2709
|
-
# @!attribute state
|
2710
|
-
#
|
2711
|
-
# @return [String, nil]
|
2712
|
-
required :state, String, nil?: true
|
2713
|
-
|
2714
|
-
# @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
|
2715
|
-
# @param city [String, nil]
|
2716
|
-
# @param country [String, nil]
|
2717
|
-
# @param line1 [String, nil]
|
2718
|
-
# @param line2 [String, nil]
|
2719
|
-
# @param postal_code [String, nil]
|
2720
|
-
# @param state [String, nil]
|
2721
|
-
end
|
2722
|
-
|
2723
996
|
# @see Orb::Models::InvoiceFetchUpcomingResponse#status
|
2724
997
|
module Status
|
2725
998
|
extend Orb::Internal::Type::Enum
|
@@ -2733,17 +1006,6 @@ module Orb
|
|
2733
1006
|
# @!method self.values
|
2734
1007
|
# @return [Array<Symbol>]
|
2735
1008
|
end
|
2736
|
-
|
2737
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse#subscription
|
2738
|
-
class Subscription < Orb::Internal::Type::BaseModel
|
2739
|
-
# @!attribute id
|
2740
|
-
#
|
2741
|
-
# @return [String]
|
2742
|
-
required :id, String
|
2743
|
-
|
2744
|
-
# @!method initialize(id:)
|
2745
|
-
# @param id [String]
|
2746
|
-
end
|
2747
1009
|
end
|
2748
1010
|
end
|
2749
1011
|
end
|