orb-billing 1.14.0 → 1.15.0
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 +12 -0
- data/lib/orb/client.rb +14 -0
- data/lib/orb/internal/transport/base_client.rb +5 -0
- data/lib/orb/internal/type/union.rb +13 -27
- data/lib/orb/models/accounting_provider_config.rb +14 -3
- data/lib/orb/models/adjustment_interval.rb +185 -3
- data/lib/orb/models/alert.rb +105 -1
- data/lib/orb/models/alert_create_for_subscription_params.rb +120 -7
- data/lib/orb/models/alert_update_params.rb +113 -1
- data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +2419 -17109
- data/lib/orb/models/beta_create_plan_version_params.rb +2361 -16947
- data/lib/orb/models/changed_subscription_resources.rb +200 -10
- data/lib/orb/models/conversion_rate_config.rb +18 -0
- data/lib/orb/models/credit_block_list_invoices_response.rb +155 -1
- data/lib/orb/models/credit_block_retrieve_response.rb +150 -1
- data/lib/orb/models/customer.rb +111 -4
- data/lib/orb/models/customer_create_params.rb +6 -1
- data/lib/orb/models/customer_tax_id.rb +15 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +16 -2
- data/lib/orb/models/customer_update_params.rb +16 -2
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +155 -1
- data/lib/orb/models/customers/credit_list_response.rb +152 -1
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +4 -4
- data/lib/orb/models/dimensional_price_group.rb +1 -1
- data/lib/orb/models/discount.rb +145 -1
- data/lib/orb/models/event_ingest_params.rb +5 -2
- data/lib/orb/models/invoice.rb +198 -10
- data/lib/orb/models/invoice_create_params.rb +6 -5
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +200 -10
- data/lib/orb/models/invoice_issue_summary_response.rb +9 -3
- data/lib/orb/models/invoice_level_discount.rb +145 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +189 -5
- data/lib/orb/models/invoice_list_summary_response.rb +9 -3
- data/lib/orb/models/licenses/external_license_get_usage_params.rb +3 -3
- data/lib/orb/models/licenses/usage_get_all_usage_params.rb +3 -3
- data/lib/orb/models/licenses/usage_get_usage_params.rb +3 -3
- data/lib/orb/models/mutated_subscription.rb +169 -4
- data/lib/orb/models/new_allocation_price.rb +11 -1
- data/lib/orb/models/new_floating_bulk_price.rb +1 -3
- data/lib/orb/models/new_floating_bulk_with_proration_price.rb +1 -3
- data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +1 -3
- data/lib/orb/models/new_floating_grouped_allocation_price.rb +1 -3
- data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_floating_grouped_tiered_price.rb +1 -3
- data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +1 -3
- data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +1 -3
- data/lib/orb/models/new_floating_matrix_price.rb +1 -3
- data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +1 -3
- data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +1 -3
- data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_floating_minimum_composite_price.rb +1 -3
- data/lib/orb/models/new_floating_package_price.rb +1 -3
- data/lib/orb/models/new_floating_package_with_allocation_price.rb +1 -3
- data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +1 -3
- data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +1 -3
- data/lib/orb/models/new_floating_threshold_total_amount_price.rb +1 -3
- data/lib/orb/models/new_floating_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +1 -3
- data/lib/orb/models/new_floating_tiered_price.rb +1 -3
- data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +1 -3
- data/lib/orb/models/new_floating_tiered_with_proration_price.rb +1 -3
- data/lib/orb/models/new_floating_unit_price.rb +1 -3
- data/lib/orb/models/new_floating_unit_with_percent_price.rb +1 -3
- data/lib/orb/models/new_floating_unit_with_proration_price.rb +1 -3
- data/lib/orb/models/new_plan_bulk_price.rb +1 -1
- data/lib/orb/models/new_plan_bulk_with_proration_price.rb +1 -3
- data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +1 -3
- data/lib/orb/models/new_plan_grouped_allocation_price.rb +1 -3
- data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_plan_grouped_tiered_price.rb +1 -3
- data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +1 -3
- data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +1 -3
- data/lib/orb/models/new_plan_matrix_price.rb +1 -5
- data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +1 -3
- data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +1 -3
- data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_plan_minimum_composite_price.rb +1 -3
- data/lib/orb/models/new_plan_package_price.rb +1 -5
- data/lib/orb/models/new_plan_package_with_allocation_price.rb +1 -3
- data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +1 -3
- data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +1 -3
- data/lib/orb/models/new_plan_threshold_total_amount_price.rb +1 -3
- data/lib/orb/models/new_plan_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +1 -3
- data/lib/orb/models/new_plan_tiered_price.rb +1 -5
- data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +1 -3
- data/lib/orb/models/new_plan_unit_price.rb +1 -1
- data/lib/orb/models/new_plan_unit_with_percent_price.rb +1 -3
- data/lib/orb/models/new_plan_unit_with_proration_price.rb +1 -3
- data/lib/orb/models/new_subscription_bulk_price.rb +1 -3
- data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +1 -3
- data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +1 -3
- data/lib/orb/models/new_subscription_grouped_allocation_price.rb +1 -3
- data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_subscription_grouped_tiered_price.rb +1 -3
- data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +1 -3
- data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +1 -3
- data/lib/orb/models/new_subscription_matrix_price.rb +1 -3
- data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +1 -3
- data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +1 -3
- data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_subscription_minimum_composite_price.rb +1 -3
- data/lib/orb/models/new_subscription_package_price.rb +1 -3
- data/lib/orb/models/new_subscription_package_with_allocation_price.rb +1 -3
- data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +1 -3
- data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +1 -3
- data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +1 -3
- data/lib/orb/models/new_subscription_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +1 -3
- data/lib/orb/models/new_subscription_tiered_price.rb +1 -3
- data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +1 -3
- data/lib/orb/models/new_subscription_unit_price.rb +1 -3
- data/lib/orb/models/new_subscription_unit_with_percent_price.rb +1 -3
- data/lib/orb/models/new_subscription_unit_with_proration_price.rb +1 -3
- data/lib/orb/models/per_price_cost.rb +2 -2
- data/lib/orb/models/plan.rb +189 -9
- data/lib/orb/models/plan_create_params.rb +1047 -8228
- data/lib/orb/models/plan_update_params.rb +9 -1
- data/lib/orb/models/plan_version.rb +186 -5
- data/lib/orb/models/plans/external_plan_id_update_params.rb +9 -1
- data/lib/orb/models/plans/migration_cancel_response.rb +22 -4
- data/lib/orb/models/plans/migration_list_response.rb +22 -4
- data/lib/orb/models/plans/migration_retrieve_response.rb +22 -4
- data/lib/orb/models/price.rb +2614 -1268
- data/lib/orb/models/price_create_params.rb +866 -49
- data/lib/orb/models/price_evaluate_multiple_params.rb +889 -54
- data/lib/orb/models/price_evaluate_preview_events_params.rb +881 -46
- data/lib/orb/models/price_interval.rb +2 -2
- data/lib/orb/models/subscription.rb +168 -4
- data/lib/orb/models/subscription_create_params.rb +2818 -674
- data/lib/orb/models/subscription_price_intervals_params.rb +1098 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +2834 -687
- data/lib/orb/models/subscription_update_params.rb +12 -1
- data/lib/orb/models.rb +2 -0
- data/lib/orb/resources/alerts.rb +14 -3
- data/lib/orb/resources/customers/credits/ledger.rb +28 -14
- data/lib/orb/resources/customers.rb +6 -2
- data/lib/orb/resources/events.rb +7 -34
- data/lib/orb/resources/invoices.rb +6 -2
- data/lib/orb/resources/licenses/external_licenses.rb +1 -1
- data/lib/orb/resources/licenses/usage.rb +2 -2
- data/lib/orb/resources/metrics.rb +5 -5
- data/lib/orb/resources/plans/external_plan_id.rb +5 -3
- data/lib/orb/resources/plans.rb +9 -5
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +5 -5
- data/lib/orb/resources/subscriptions.rb +20 -3
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/orb/models/accounting_provider_config.rbi +38 -5
- data/rbi/orb/models/adjustment_interval.rbi +336 -0
- data/rbi/orb/models/alert.rbi +172 -3
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +268 -9
- data/rbi/orb/models/alert_update_params.rbi +208 -0
- data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +3833 -28395
- data/rbi/orb/models/beta_create_plan_version_params.rbi +3833 -28363
- data/rbi/orb/models/changed_subscription_resources.rbi +360 -5
- data/rbi/orb/models/conversion_rate_config.rbi +18 -0
- data/rbi/orb/models/credit_block_list_invoices_response.rbi +346 -3
- data/rbi/orb/models/credit_block_retrieve_response.rbi +344 -3
- data/rbi/orb/models/customer.rbi +190 -10
- data/rbi/orb/models/customer_create_params.rbi +12 -2
- data/rbi/orb/models/customer_tax_id.rbi +15 -1
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +22 -2
- data/rbi/orb/models/customer_update_params.rbi +22 -2
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +346 -3
- data/rbi/orb/models/customers/credit_list_response.rbi +347 -3
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +6 -6
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +6 -6
- data/rbi/orb/models/dimensional_price_group.rbi +1 -1
- data/rbi/orb/models/discount.rbi +269 -1
- data/rbi/orb/models/event_ingest_params.rbi +4 -2
- data/rbi/orb/models/invoice.rbi +360 -5
- data/rbi/orb/models/invoice_create_params.rbi +12 -7
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +360 -5
- data/rbi/orb/models/invoice_issue_summary_response.rbi +19 -4
- data/rbi/orb/models/invoice_level_discount.rbi +298 -1
- data/rbi/orb/models/invoice_line_item_create_response.rbi +339 -0
- data/rbi/orb/models/invoice_list_summary_response.rbi +19 -4
- data/rbi/orb/models/licenses/external_license_get_usage_params.rbi +3 -3
- data/rbi/orb/models/licenses/usage_get_all_usage_params.rbi +3 -3
- data/rbi/orb/models/licenses/usage_get_usage_params.rbi +3 -3
- data/rbi/orb/models/mutated_subscription.rbi +324 -2
- data/rbi/orb/models/new_allocation_price.rbi +12 -0
- data/rbi/orb/models/per_price_cost.rbi +3 -0
- data/rbi/orb/models/plan.rbi +339 -2
- data/rbi/orb/models/plan_create_params.rbi +1877 -14138
- data/rbi/orb/models/plan_update_params.rbi +8 -0
- data/rbi/orb/models/plan_version.rbi +339 -0
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +8 -0
- data/rbi/orb/models/plans/migration_cancel_response.rbi +22 -1
- data/rbi/orb/models/plans/migration_list_response.rbi +22 -1
- data/rbi/orb/models/plans/migration_retrieve_response.rbi +22 -1
- data/rbi/orb/models/price.rbi +4552 -2285
- data/rbi/orb/models/price_create_params.rbi +1540 -114
- data/rbi/orb/models/price_evaluate_multiple_params.rbi +1540 -114
- data/rbi/orb/models/price_evaluate_preview_events_params.rbi +1540 -114
- data/rbi/orb/models/price_interval.rbi +3 -0
- data/rbi/orb/models/subscription.rbi +324 -2
- data/rbi/orb/models/subscription_create_params.rbi +4998 -1186
- data/rbi/orb/models/subscription_price_intervals_params.rbi +2127 -264
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +4997 -1185
- data/rbi/orb/models/subscription_update_params.rbi +14 -0
- data/rbi/orb/models.rbi +2 -0
- data/rbi/orb/resources/alerts.rbi +39 -4
- data/rbi/orb/resources/customers/credits/ledger.rbi +28 -14
- data/rbi/orb/resources/customers.rbi +23 -0
- data/rbi/orb/resources/events.rbi +8 -35
- data/rbi/orb/resources/invoices.rbi +9 -3
- data/rbi/orb/resources/licenses/external_licenses.rbi +1 -1
- data/rbi/orb/resources/licenses/usage.rbi +2 -2
- data/rbi/orb/resources/metrics.rbi +5 -5
- data/rbi/orb/resources/plans/external_plan_id.rbi +5 -2
- data/rbi/orb/resources/plans.rbi +9 -3
- data/rbi/orb/resources/prices.rbi +3 -0
- data/rbi/orb/resources/subscriptions.rbi +29 -0
- data/sig/orb/models/accounting_provider_config.rbs +21 -4
- data/sig/orb/models/adjustment_interval.rbs +134 -0
- data/sig/orb/models/alert.rbs +85 -3
- data/sig/orb/models/alert_create_for_subscription_params.rbs +86 -4
- data/sig/orb/models/alert_update_params.rbs +86 -1
- data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +1803 -11601
- data/sig/orb/models/beta_create_plan_version_params.rbs +1747 -11541
- data/sig/orb/models/changed_subscription_resources.rbs +140 -1
- data/sig/orb/models/conversion_rate_config.rbs +12 -0
- data/sig/orb/models/credit_block_list_invoices_response.rbs +124 -3
- data/sig/orb/models/credit_block_retrieve_response.rbs +124 -3
- data/sig/orb/models/customer.rbs +70 -4
- data/sig/orb/models/customer_create_params.rbs +2 -2
- data/sig/orb/models/customer_tax_id.rbs +20 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +7 -2
- data/sig/orb/models/customer_update_params.rbs +7 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +124 -3
- data/sig/orb/models/customers/credit_list_response.rbs +124 -3
- data/sig/orb/models/discount.rbs +114 -0
- data/sig/orb/models/invoice.rbs +140 -1
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +140 -1
- data/sig/orb/models/invoice_issue_summary_response.rbs +2 -1
- data/sig/orb/models/invoice_level_discount.rbs +117 -1
- data/sig/orb/models/invoice_line_item_create_response.rbs +134 -0
- data/sig/orb/models/invoice_list_summary_response.rbs +2 -1
- data/sig/orb/models/licenses/external_license_get_usage_params.rbs +4 -4
- data/sig/orb/models/licenses/usage_get_all_usage_params.rbs +4 -4
- data/sig/orb/models/licenses/usage_get_usage_params.rbs +4 -4
- data/sig/orb/models/mutated_subscription.rbs +124 -0
- data/sig/orb/models/new_allocation_price.rbs +5 -0
- data/sig/orb/models/new_floating_bulk_price.rbs +4 -4
- data/sig/orb/models/new_floating_bulk_with_proration_price.rbs +4 -4
- data/sig/orb/models/new_floating_cumulative_grouped_bulk_price.rbs +4 -4
- data/sig/orb/models/new_floating_grouped_allocation_price.rbs +4 -4
- data/sig/orb/models/new_floating_grouped_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_floating_grouped_tiered_price.rbs +4 -4
- data/sig/orb/models/new_floating_grouped_with_metered_minimum_price.rbs +4 -4
- data/sig/orb/models/new_floating_grouped_with_prorated_minimum_price.rbs +4 -4
- data/sig/orb/models/new_floating_matrix_price.rbs +4 -4
- data/sig/orb/models/new_floating_matrix_with_allocation_price.rbs +4 -4
- data/sig/orb/models/new_floating_matrix_with_display_name_price.rbs +4 -4
- data/sig/orb/models/new_floating_max_group_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_floating_minimum_composite_price.rbs +4 -4
- data/sig/orb/models/new_floating_package_price.rbs +4 -4
- data/sig/orb/models/new_floating_package_with_allocation_price.rbs +4 -4
- data/sig/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbs +4 -4
- data/sig/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbs +4 -4
- data/sig/orb/models/new_floating_threshold_total_amount_price.rbs +4 -4
- data/sig/orb/models/new_floating_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_floating_tiered_package_with_minimum_price.rbs +4 -4
- data/sig/orb/models/new_floating_tiered_price.rbs +4 -4
- data/sig/orb/models/new_floating_tiered_with_minimum_price.rbs +4 -4
- data/sig/orb/models/new_floating_tiered_with_proration_price.rbs +4 -4
- data/sig/orb/models/new_floating_unit_price.rbs +4 -4
- data/sig/orb/models/new_floating_unit_with_percent_price.rbs +4 -4
- data/sig/orb/models/new_floating_unit_with_proration_price.rbs +4 -4
- data/sig/orb/models/new_plan_bulk_price.rbs +4 -4
- data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +4 -4
- data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +4 -4
- data/sig/orb/models/new_plan_grouped_allocation_price.rbs +4 -4
- data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_plan_grouped_tiered_price.rbs +4 -4
- data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +4 -4
- data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +4 -4
- data/sig/orb/models/new_plan_matrix_price.rbs +4 -4
- data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +4 -4
- data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +4 -4
- data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_plan_minimum_composite_price.rbs +4 -4
- data/sig/orb/models/new_plan_package_price.rbs +4 -4
- data/sig/orb/models/new_plan_package_with_allocation_price.rbs +4 -4
- data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +4 -4
- data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +4 -4
- data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +4 -4
- data/sig/orb/models/new_plan_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +4 -4
- data/sig/orb/models/new_plan_tiered_price.rbs +4 -4
- data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +4 -4
- data/sig/orb/models/new_plan_unit_price.rbs +4 -4
- data/sig/orb/models/new_plan_unit_with_percent_price.rbs +4 -4
- data/sig/orb/models/new_plan_unit_with_proration_price.rbs +4 -4
- data/sig/orb/models/new_subscription_bulk_price.rbs +4 -4
- data/sig/orb/models/new_subscription_bulk_with_proration_price.rbs +4 -4
- data/sig/orb/models/new_subscription_cumulative_grouped_bulk_price.rbs +4 -4
- data/sig/orb/models/new_subscription_grouped_allocation_price.rbs +4 -4
- data/sig/orb/models/new_subscription_grouped_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_subscription_grouped_tiered_price.rbs +4 -4
- data/sig/orb/models/new_subscription_grouped_with_metered_minimum_price.rbs +4 -4
- data/sig/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbs +4 -4
- data/sig/orb/models/new_subscription_matrix_price.rbs +4 -4
- data/sig/orb/models/new_subscription_matrix_with_allocation_price.rbs +4 -4
- data/sig/orb/models/new_subscription_matrix_with_display_name_price.rbs +4 -4
- data/sig/orb/models/new_subscription_max_group_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_subscription_minimum_composite_price.rbs +4 -4
- data/sig/orb/models/new_subscription_package_price.rbs +4 -4
- data/sig/orb/models/new_subscription_package_with_allocation_price.rbs +4 -4
- data/sig/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbs +4 -4
- data/sig/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbs +4 -4
- data/sig/orb/models/new_subscription_threshold_total_amount_price.rbs +4 -4
- data/sig/orb/models/new_subscription_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_subscription_tiered_package_with_minimum_price.rbs +4 -4
- data/sig/orb/models/new_subscription_tiered_price.rbs +4 -4
- data/sig/orb/models/new_subscription_tiered_with_minimum_price.rbs +4 -4
- data/sig/orb/models/new_subscription_unit_price.rbs +4 -4
- data/sig/orb/models/new_subscription_unit_with_percent_price.rbs +4 -4
- data/sig/orb/models/new_subscription_unit_with_proration_price.rbs +4 -4
- data/sig/orb/models/plan.rbs +134 -0
- data/sig/orb/models/plan_create_params.rbs +836 -5728
- data/sig/orb/models/plan_update_params.rbs +5 -0
- data/sig/orb/models/plan_version.rbs +134 -0
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +5 -0
- data/sig/orb/models/price.rbs +2200 -1150
- data/sig/orb/models/price_create_params.rbs +611 -23
- data/sig/orb/models/price_evaluate_multiple_params.rbs +626 -23
- data/sig/orb/models/price_evaluate_preview_events_params.rbs +626 -23
- data/sig/orb/models/subscription.rbs +124 -0
- data/sig/orb/models/subscription_create_params.rbs +2009 -430
- data/sig/orb/models/subscription_price_intervals_params.rbs +795 -23
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2009 -430
- data/sig/orb/models/subscription_update_params.rbs +5 -0
- data/sig/orb/models.rbs +2 -0
- data/sig/orb/resources/alerts.rbs +5 -1
- data/sig/orb/resources/customers.rbs +2 -0
- data/sig/orb/resources/licenses/external_licenses.rbs +1 -1
- data/sig/orb/resources/licenses/usage.rbs +2 -2
- data/sig/orb/resources/plans/external_plan_id.rbs +1 -0
- data/sig/orb/resources/plans.rbs +2 -0
- data/sig/orb/resources/subscriptions.rbs +3 -0
- metadata +6 -7
|
@@ -20,6 +20,15 @@ module Orb
|
|
|
20
20
|
# @return [Boolean, nil]
|
|
21
21
|
optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true
|
|
22
22
|
|
|
23
|
+
# @!attribute auto_issuance
|
|
24
|
+
# Used to determine if invoices for this subscription will be automatically
|
|
25
|
+
# issued. If true, invoices will be automatically issued. If false, invoices will
|
|
26
|
+
# require manual approval. If `null` is specified, this defaults to the behavior
|
|
27
|
+
# configured for this customer.
|
|
28
|
+
#
|
|
29
|
+
# @return [Boolean, nil]
|
|
30
|
+
optional :auto_issuance, Orb::Internal::Type::Boolean, nil?: true
|
|
31
|
+
|
|
23
32
|
# @!attribute default_invoice_memo
|
|
24
33
|
# Determines the default memo on this subscription's invoices. Note that if this
|
|
25
34
|
# is not provided, it is determined by the plan configuration.
|
|
@@ -52,7 +61,7 @@ module Orb
|
|
|
52
61
|
# @return [Integer, nil]
|
|
53
62
|
optional :net_terms, Integer, nil?: true
|
|
54
63
|
|
|
55
|
-
# @!method initialize(subscription_id:, auto_collection: nil, default_invoice_memo: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, request_options: {})
|
|
64
|
+
# @!method initialize(subscription_id:, auto_collection: nil, auto_issuance: nil, default_invoice_memo: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, request_options: {})
|
|
56
65
|
# Some parameter documentations has been truncated, see
|
|
57
66
|
# {Orb::Models::SubscriptionUpdateParams} for more details.
|
|
58
67
|
#
|
|
@@ -60,6 +69,8 @@ module Orb
|
|
|
60
69
|
#
|
|
61
70
|
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
|
62
71
|
#
|
|
72
|
+
# @param auto_issuance [Boolean, nil] Used to determine if invoices for this subscription will be automatically issued
|
|
73
|
+
#
|
|
63
74
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscription's invoices. Note that if this i
|
|
64
75
|
#
|
|
65
76
|
# @param invoicing_threshold [String, nil] When this subscription's accrued usage reaches this threshold, an invoice will b
|
data/lib/orb/models.rb
CHANGED
|
@@ -97,6 +97,8 @@ module Orb
|
|
|
97
97
|
|
|
98
98
|
ChangedSubscriptionResources = Orb::Models::ChangedSubscriptionResources
|
|
99
99
|
|
|
100
|
+
ConversionRateConfig = Orb::Models::ConversionRateConfig
|
|
101
|
+
|
|
100
102
|
ConversionRateTier = Orb::Models::ConversionRateTier
|
|
101
103
|
|
|
102
104
|
ConversionRateTieredConfig = Orb::Models::ConversionRateTieredConfig
|
data/lib/orb/resources/alerts.rb
CHANGED
|
@@ -27,14 +27,21 @@ module Orb
|
|
|
27
27
|
)
|
|
28
28
|
end
|
|
29
29
|
|
|
30
|
+
# Some parameter documentations has been truncated, see
|
|
31
|
+
# {Orb::Models::AlertUpdateParams} for more details.
|
|
32
|
+
#
|
|
30
33
|
# This endpoint updates the thresholds of an alert.
|
|
31
34
|
#
|
|
32
|
-
# @overload update(alert_configuration_id, thresholds:, request_options: {})
|
|
35
|
+
# @overload update(alert_configuration_id, thresholds:, price_filters: nil, threshold_overrides: nil, request_options: {})
|
|
33
36
|
#
|
|
34
37
|
# @param alert_configuration_id [String]
|
|
35
38
|
#
|
|
36
39
|
# @param thresholds [Array<Orb::Models::Threshold>] The thresholds that define the values at which the alert will be triggered.
|
|
37
40
|
#
|
|
41
|
+
# @param price_filters [Array<Orb::Models::AlertUpdateParams::PriceFilter>, nil] Replaces the price filters on a grouped cost alert; an empty list clears them. O
|
|
42
|
+
#
|
|
43
|
+
# @param threshold_overrides [Array<Orb::Models::AlertUpdateParams::ThresholdOverride>, nil] Replaces the per-group threshold overrides on a grouped cost alert; an empty lis
|
|
44
|
+
#
|
|
38
45
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
39
46
|
#
|
|
40
47
|
# @return [Orb::Models::Alert]
|
|
@@ -194,7 +201,7 @@ module Orb
|
|
|
194
201
|
# per metric that is a part of the subscription. Alerts are triggered based on
|
|
195
202
|
# usage or cost conditions met during the current billing cycle.
|
|
196
203
|
#
|
|
197
|
-
# @overload create_for_subscription(subscription_id, thresholds:, type:, grouping_keys: nil, metric_id: nil,
|
|
204
|
+
# @overload create_for_subscription(subscription_id, thresholds:, type:, currency: nil, grouping_keys: nil, metric_id: nil, price_filters: nil, threshold_overrides: nil, request_options: {})
|
|
198
205
|
#
|
|
199
206
|
# @param subscription_id [String]
|
|
200
207
|
#
|
|
@@ -202,11 +209,15 @@ module Orb
|
|
|
202
209
|
#
|
|
203
210
|
# @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
|
|
204
211
|
#
|
|
212
|
+
# @param currency [String, nil] The case sensitive currency or custom pricing unit to use for grouped cost alert
|
|
213
|
+
#
|
|
205
214
|
# @param grouping_keys [Array<String>, nil] The property keys to group cost alerts by. Only applicable for cost_exceeded ale
|
|
206
215
|
#
|
|
207
216
|
# @param metric_id [String, nil] The metric to track usage for.
|
|
208
217
|
#
|
|
209
|
-
# @param
|
|
218
|
+
# @param price_filters [Array<Orb::Models::AlertCreateForSubscriptionParams::PriceFilter>, nil] Filters to scope which prices are included in grouped cost alert evaluation. Sup
|
|
219
|
+
#
|
|
220
|
+
# @param threshold_overrides [Array<Orb::Models::AlertCreateForSubscriptionParams::ThresholdOverride>, nil] Per-group threshold overrides. Each override maps a specific combination of grou
|
|
210
221
|
#
|
|
211
222
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
212
223
|
#
|
|
@@ -177,8 +177,9 @@ module Orb
|
|
|
177
177
|
# }
|
|
178
178
|
# ```
|
|
179
179
|
#
|
|
180
|
-
# Note that
|
|
181
|
-
#
|
|
180
|
+
# Note that an `increment` entry always creates a new credit block (defined by the
|
|
181
|
+
# optional `effective_date` and `expiry_date`); it never modifies an existing
|
|
182
|
+
# block.
|
|
182
183
|
#
|
|
183
184
|
# ### Invoicing for credits
|
|
184
185
|
#
|
|
@@ -199,11 +200,17 @@ module Orb
|
|
|
199
200
|
# ## Deducting Credits
|
|
200
201
|
#
|
|
201
202
|
# Orb allows you to deduct credits from a customer by creating an entry of type
|
|
202
|
-
# `decrement`.
|
|
203
|
-
#
|
|
204
|
-
#
|
|
205
|
-
#
|
|
206
|
-
#
|
|
203
|
+
# `decrement`. A `decrement` entry records credits as usage and immediately
|
|
204
|
+
# recognizes revenue at the block's `per_unit_cost_basis`.
|
|
205
|
+
#
|
|
206
|
+
# For most credit removals, use `void` (no revenue impact) or `expiration_change`
|
|
207
|
+
# (revenue recognized on expiration) instead. Only use `decrement` when credits
|
|
208
|
+
# were genuinely consumed outside of normal event ingestion.
|
|
209
|
+
#
|
|
210
|
+
# Orb matches the algorithm for automatic deductions for determining which credit
|
|
211
|
+
# blocks to decrement from. In the case that the deduction leads to multiple
|
|
212
|
+
# ledger entries, the response from this endpoint will be the final deduction. Orb
|
|
213
|
+
# also optionally allows specifying a description to assist with auditing.
|
|
207
214
|
#
|
|
208
215
|
# The following snippet illustrates a sample request body to decrement credits.
|
|
209
216
|
#
|
|
@@ -315,8 +322,9 @@ module Orb
|
|
|
315
322
|
# }
|
|
316
323
|
# ```
|
|
317
324
|
#
|
|
318
|
-
# Note that
|
|
319
|
-
#
|
|
325
|
+
# Note that an `increment` entry always creates a new credit block (defined by the
|
|
326
|
+
# optional `effective_date` and `expiry_date`); it never modifies an existing
|
|
327
|
+
# block.
|
|
320
328
|
#
|
|
321
329
|
# ### Invoicing for credits
|
|
322
330
|
#
|
|
@@ -337,11 +345,17 @@ module Orb
|
|
|
337
345
|
# ## Deducting Credits
|
|
338
346
|
#
|
|
339
347
|
# Orb allows you to deduct credits from a customer by creating an entry of type
|
|
340
|
-
# `decrement`.
|
|
341
|
-
#
|
|
342
|
-
#
|
|
343
|
-
#
|
|
344
|
-
#
|
|
348
|
+
# `decrement`. A `decrement` entry records credits as usage and immediately
|
|
349
|
+
# recognizes revenue at the block's `per_unit_cost_basis`.
|
|
350
|
+
#
|
|
351
|
+
# For most credit removals, use `void` (no revenue impact) or `expiration_change`
|
|
352
|
+
# (revenue recognized on expiration) instead. Only use `decrement` when credits
|
|
353
|
+
# were genuinely consumed outside of normal event ingestion.
|
|
354
|
+
#
|
|
355
|
+
# Orb matches the algorithm for automatic deductions for determining which credit
|
|
356
|
+
# blocks to decrement from. In the case that the deduction leads to multiple
|
|
357
|
+
# ledger entries, the response from this endpoint will be the final deduction. Orb
|
|
358
|
+
# also optionally allows specifying a description to assist with auditing.
|
|
345
359
|
#
|
|
346
360
|
# The following snippet illustrates a sample request body to decrement credits.
|
|
347
361
|
#
|
|
@@ -152,7 +152,7 @@ module Orb
|
|
|
152
152
|
# be set if it has not already been set on the customer. Other fields on a
|
|
153
153
|
# customer are currently immutable.
|
|
154
154
|
#
|
|
155
|
-
# @overload update(customer_id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, auto_issuance: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_configuration: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
|
|
155
|
+
# @overload update(customer_id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, auto_issuance: nil, billing_address: nil, currency: nil, default_payment_method_id: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_configuration: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
|
|
156
156
|
#
|
|
157
157
|
# @param customer_id [String]
|
|
158
158
|
#
|
|
@@ -168,6 +168,8 @@ module Orb
|
|
|
168
168
|
#
|
|
169
169
|
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. This c
|
|
170
170
|
#
|
|
171
|
+
# @param default_payment_method_id [String, nil] The Orb ID of the payment method to set as this customer's default. Pass `null`
|
|
172
|
+
#
|
|
171
173
|
# @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
|
|
172
174
|
#
|
|
173
175
|
# @param email_delivery [Boolean, nil]
|
|
@@ -393,7 +395,7 @@ module Orb
|
|
|
393
395
|
# resource and semantics of this endpoint exactly mirror
|
|
394
396
|
# [Update Customer](update-customer).
|
|
395
397
|
#
|
|
396
|
-
# @overload update_by_external_id(id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, auto_issuance: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_configuration: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
|
|
398
|
+
# @overload update_by_external_id(id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, auto_issuance: nil, billing_address: nil, currency: nil, default_payment_method_id: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_configuration: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
|
|
397
399
|
#
|
|
398
400
|
# @param id [String]
|
|
399
401
|
#
|
|
@@ -409,6 +411,8 @@ module Orb
|
|
|
409
411
|
#
|
|
410
412
|
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. This c
|
|
411
413
|
#
|
|
414
|
+
# @param default_payment_method_id [String, nil] The Orb ID of the payment method to set as this customer's default. Pass `null`
|
|
415
|
+
#
|
|
412
416
|
# @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
|
|
413
417
|
#
|
|
414
418
|
# @param email_delivery [Boolean, nil]
|
data/lib/orb/resources/events.rb
CHANGED
|
@@ -273,8 +273,8 @@ module Orb
|
|
|
273
273
|
# billed for in the corresponding billing period.
|
|
274
274
|
#
|
|
275
275
|
# In general, Orb does not expect events with future dated timestamps. In cases
|
|
276
|
-
# where the timestamp is
|
|
277
|
-
#
|
|
276
|
+
# where the timestamp is 5 minutes ahead of the current time, the event will not
|
|
277
|
+
# be accepted as a valid event, and will throw validation errors.
|
|
278
278
|
#
|
|
279
279
|
# ## Event validation
|
|
280
280
|
#
|
|
@@ -289,9 +289,9 @@ module Orb
|
|
|
289
289
|
# - If the `external_customer_id` is specified, the customer in Orb does not need
|
|
290
290
|
# to exist. Events will be attributed to any future customers with the
|
|
291
291
|
# `external_customer_id` on subscription creation.
|
|
292
|
-
# - `timestamp` must conform to ISO 8601 and represent a timestamp at most
|
|
293
|
-
# in the future. This timestamp should be sent in UTC timezone (no
|
|
294
|
-
# offset).
|
|
292
|
+
# - `timestamp` must conform to ISO 8601 and represent a timestamp at most 5
|
|
293
|
+
# minutes in the future. This timestamp should be sent in UTC timezone (no
|
|
294
|
+
# timezone offset).
|
|
295
295
|
#
|
|
296
296
|
# ## Idempotency and retry semantics
|
|
297
297
|
#
|
|
@@ -328,34 +328,7 @@ module Orb
|
|
|
328
328
|
# request payload size, but please give us a heads up if you’re changing either of
|
|
329
329
|
# these factors by an order of magnitude from initial setup.
|
|
330
330
|
#
|
|
331
|
-
#
|
|
332
|
-
#
|
|
333
|
-
# The ingestion API supports a debug mode, which returns additional verbose output
|
|
334
|
-
# to indicate which event idempotency keys were newly ingested or duplicates from
|
|
335
|
-
# previous requests. To enable this mode, mark `debug=true` as a query parameter.
|
|
336
|
-
#
|
|
337
|
-
# If `debug=true` is not specified, the response will only contain
|
|
338
|
-
# `validation_failed`. Orb will still honor the idempotency guarantees set
|
|
339
|
-
# [here](/events-and-metrics/event-ingestion#event-volume-and-concurrency) in all
|
|
340
|
-
# cases.
|
|
341
|
-
#
|
|
342
|
-
# We strongly recommend that you only use debug mode as part of testing your
|
|
343
|
-
# initial Orb integration. Once you're ready to switch to production, disable
|
|
344
|
-
# debug mode to take advantage of improved performance and maximal throughput.
|
|
345
|
-
#
|
|
346
|
-
# #### Example: ingestion response with `debug=true`
|
|
347
|
-
#
|
|
348
|
-
# ```json
|
|
349
|
-
# {
|
|
350
|
-
# "debug": {
|
|
351
|
-
# "duplicate": [],
|
|
352
|
-
# "ingested": ["B7E83HDMfJPAunXW", "SJs5DQJ3TnwSqEZE", "8SivfDsNKwCeAXim"]
|
|
353
|
-
# },
|
|
354
|
-
# "validation_failed": []
|
|
355
|
-
# }
|
|
356
|
-
# ```
|
|
357
|
-
#
|
|
358
|
-
# #### Example: ingestion response with `debug=false`
|
|
331
|
+
# #### Example: ingestion response
|
|
359
332
|
#
|
|
360
333
|
# ```json
|
|
361
334
|
# {
|
|
@@ -369,7 +342,7 @@ module Orb
|
|
|
369
342
|
#
|
|
370
343
|
# @param backfill_id [String, nil] Query param: If this ingestion request is part of a backfill, this parameter tie
|
|
371
344
|
#
|
|
372
|
-
# @param debug [Boolean] Query param: Flag to enable additional debug information in
|
|
345
|
+
# @param debug [Boolean] Query param: Pending Deprecation: Flag to enable additional debug information in
|
|
373
346
|
#
|
|
374
347
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
375
348
|
#
|
|
@@ -17,7 +17,7 @@ module Orb
|
|
|
17
17
|
#
|
|
18
18
|
# @param currency [String] An ISO 4217 currency string. Must be the same as the customer's currency if it i
|
|
19
19
|
#
|
|
20
|
-
# @param invoice_date [Time]
|
|
20
|
+
# @param invoice_date [Time] An ISO 8601 date or timestamp, interpreted in the customer's timezone. Must be i
|
|
21
21
|
#
|
|
22
22
|
# @param line_items [Array<Orb::Models::InvoiceCreateParams::LineItem>]
|
|
23
23
|
#
|
|
@@ -25,7 +25,7 @@ module Orb
|
|
|
25
25
|
#
|
|
26
26
|
# @param customer_id [String, nil] The id of the `Customer` to create this invoice for. One of `customer_id` and `e
|
|
27
27
|
#
|
|
28
|
-
# @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] An optional discount to attach to the invoice.
|
|
28
|
+
# @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, Orb::Models::Discount::TieredPercentage, nil] An optional discount to attach to the invoice.
|
|
29
29
|
#
|
|
30
30
|
# @param due_date [Date, Time, nil] An optional custom due date for the invoice. If not set, the due date will be ca
|
|
31
31
|
#
|
|
@@ -108,6 +108,10 @@ module Orb
|
|
|
108
108
|
# values for each draft invoice, which may not always be up-to-date since Orb
|
|
109
109
|
# regularly refreshes invoices asynchronously.
|
|
110
110
|
#
|
|
111
|
+
# If you don't need line item details, minimums, maximums, or discounts, prefer
|
|
112
|
+
# the [list invoices summary](/api-reference/invoice/list-invoices-summary)
|
|
113
|
+
# endpoint for better performance.
|
|
114
|
+
#
|
|
111
115
|
# @overload list(amount: nil, amount_gt: nil, amount_lt: nil, cursor: nil, customer_id: nil, date_type: nil, due_date: nil, due_date_window: nil, due_date_gt: nil, due_date_lt: nil, external_customer_id: nil, invoice_date_gt: nil, invoice_date_gte: nil, invoice_date_lt: nil, invoice_date_lte: nil, is_recurring: nil, limit: nil, status: nil, subscription_id: nil, request_options: {})
|
|
112
116
|
#
|
|
113
117
|
# @param amount [String, nil]
|
|
@@ -24,7 +24,7 @@ module Orb
|
|
|
24
24
|
#
|
|
25
25
|
# @param end_date [Date, nil] End date for the usage period (YYYY-MM-DD). Defaults to end of current billing p
|
|
26
26
|
#
|
|
27
|
-
# @param group_by [
|
|
27
|
+
# @param group_by [String, nil] How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
|
|
28
28
|
#
|
|
29
29
|
# @param limit [Integer] Maximum number of rows in the response data (default 20, max 100).
|
|
30
30
|
#
|
|
@@ -22,7 +22,7 @@ module Orb
|
|
|
22
22
|
#
|
|
23
23
|
# @param end_date [Date, nil] End date for the usage period (YYYY-MM-DD). Defaults to end of current billing p
|
|
24
24
|
#
|
|
25
|
-
# @param group_by [
|
|
25
|
+
# @param group_by [String, nil] How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
|
|
26
26
|
#
|
|
27
27
|
# @param limit [Integer] Maximum number of rows in the response data (default 20, max 100).
|
|
28
28
|
#
|
|
@@ -60,7 +60,7 @@ module Orb
|
|
|
60
60
|
#
|
|
61
61
|
# @param end_date [Date, nil] End date for the usage period (YYYY-MM-DD). Defaults to end of current billing p
|
|
62
62
|
#
|
|
63
|
-
# @param group_by [
|
|
63
|
+
# @param group_by [String, nil] How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
|
|
64
64
|
#
|
|
65
65
|
# @param limit [Integer] Maximum number of rows in the response data (default 20, max 100).
|
|
66
66
|
#
|
|
@@ -73,9 +73,8 @@ module Orb
|
|
|
73
73
|
# Some parameter documentations has been truncated, see
|
|
74
74
|
# {Orb::Models::MetricListParams} for more details.
|
|
75
75
|
#
|
|
76
|
-
# This endpoint is used to
|
|
77
|
-
#
|
|
78
|
-
# description, and item.
|
|
76
|
+
# This endpoint is used to list [metrics](/core-concepts#metric). It returns
|
|
77
|
+
# information about the metrics including its name, description, and item.
|
|
79
78
|
#
|
|
80
79
|
# @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
|
|
81
80
|
#
|
|
@@ -114,8 +113,9 @@ module Orb
|
|
|
114
113
|
)
|
|
115
114
|
end
|
|
116
115
|
|
|
117
|
-
# This endpoint is used to
|
|
118
|
-
# information about the metrics including its name,
|
|
116
|
+
# This endpoint is used to fetch [metric](/core-concepts#metric) details given a
|
|
117
|
+
# metric identifier. It returns information about the metrics including its name,
|
|
118
|
+
# description, and item.
|
|
119
119
|
#
|
|
120
120
|
# @overload fetch(metric_id, request_options: {})
|
|
121
121
|
#
|
|
@@ -11,15 +11,17 @@ module Orb
|
|
|
11
11
|
# Some parameter documentations has been truncated, see
|
|
12
12
|
# {Orb::Models::Plans::ExternalPlanIDUpdateParams} for more details.
|
|
13
13
|
#
|
|
14
|
-
# This endpoint can be used to update the `external_plan_id`,
|
|
15
|
-
# existing plan.
|
|
14
|
+
# This endpoint can be used to update the `external_plan_id`, `description`, and
|
|
15
|
+
# `metadata` of an existing plan.
|
|
16
16
|
#
|
|
17
17
|
# Other fields on a plan are currently immutable.
|
|
18
18
|
#
|
|
19
|
-
# @overload update(other_external_plan_id, external_plan_id: nil, metadata: nil, request_options: {})
|
|
19
|
+
# @overload update(other_external_plan_id, description: nil, external_plan_id: nil, metadata: nil, request_options: {})
|
|
20
20
|
#
|
|
21
21
|
# @param other_external_plan_id [String]
|
|
22
22
|
#
|
|
23
|
+
# @param description [String, nil] An optional user-defined description of the plan.
|
|
24
|
+
#
|
|
23
25
|
# @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
|
|
24
26
|
#
|
|
25
27
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
data/lib/orb/resources/plans.rb
CHANGED
|
@@ -26,7 +26,7 @@ module Orb
|
|
|
26
26
|
#
|
|
27
27
|
# This endpoint allows creation of plans including their prices.
|
|
28
28
|
#
|
|
29
|
-
# @overload create(currency:, name:, prices:, adjustments: nil, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, plan_phases: nil, status: nil, request_options: {})
|
|
29
|
+
# @overload create(currency:, name:, prices:, adjustments: nil, default_invoice_memo: nil, description: nil, external_plan_id: nil, metadata: nil, net_terms: nil, plan_phases: nil, status: nil, request_options: {})
|
|
30
30
|
#
|
|
31
31
|
# @param currency [String] An ISO 4217 currency string for invoices generated by subscriptions on this plan
|
|
32
32
|
#
|
|
@@ -38,6 +38,8 @@ module Orb
|
|
|
38
38
|
#
|
|
39
39
|
# @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
|
40
40
|
#
|
|
41
|
+
# @param description [String, nil] An optional user-defined description of the plan.
|
|
42
|
+
#
|
|
41
43
|
# @param external_plan_id [String, nil]
|
|
42
44
|
#
|
|
43
45
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
@@ -61,15 +63,17 @@ module Orb
|
|
|
61
63
|
# Some parameter documentations has been truncated, see
|
|
62
64
|
# {Orb::Models::PlanUpdateParams} for more details.
|
|
63
65
|
#
|
|
64
|
-
# This endpoint can be used to update the `external_plan_id`,
|
|
65
|
-
# existing plan.
|
|
66
|
+
# This endpoint can be used to update the `external_plan_id`, `description`, and
|
|
67
|
+
# `metadata` of an existing plan.
|
|
66
68
|
#
|
|
67
69
|
# Other fields on a plan are currently immutable.
|
|
68
70
|
#
|
|
69
|
-
# @overload update(plan_id, external_plan_id: nil, metadata: nil, request_options: {})
|
|
71
|
+
# @overload update(plan_id, description: nil, external_plan_id: nil, metadata: nil, request_options: {})
|
|
70
72
|
#
|
|
71
73
|
# @param plan_id [String]
|
|
72
74
|
#
|
|
75
|
+
# @param description [String, nil] An optional user-defined description of the plan.
|
|
76
|
+
#
|
|
73
77
|
# @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
|
|
74
78
|
#
|
|
75
79
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
@@ -96,7 +100,7 @@ module Orb
|
|
|
96
100
|
# This endpoint returns a list of all [plans](/core-concepts#plan-and-price) for
|
|
97
101
|
# an account in a list format. The list of plans is ordered starting from the most
|
|
98
102
|
# recently created plan. The response also includes
|
|
99
|
-
# [`pagination_metadata`](/api-reference/pagination)
|
|
103
|
+
# [`pagination_metadata`](/api-reference/pagination) which lets the caller
|
|
100
104
|
# retrieve the next page of results if they exist.
|
|
101
105
|
#
|
|
102
106
|
# @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, status: nil, request_options: {})
|
|
@@ -29,7 +29,7 @@ module Orb
|
|
|
29
29
|
#
|
|
30
30
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
31
31
|
#
|
|
32
|
-
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, 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::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
32
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
33
33
|
#
|
|
34
34
|
# @see Orb::Models::Prices::ExternalPriceIDUpdateParams
|
|
35
35
|
def update(external_price_id, params = {})
|
|
@@ -52,7 +52,7 @@ module Orb
|
|
|
52
52
|
# @param external_price_id [String]
|
|
53
53
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
54
54
|
#
|
|
55
|
-
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, 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::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
55
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
56
56
|
#
|
|
57
57
|
# @see Orb::Models::Prices::ExternalPriceIDFetchParams
|
|
58
58
|
def fetch(external_price_id, params = {})
|
data/lib/orb/resources/prices.rb
CHANGED
|
@@ -39,11 +39,11 @@ module Orb
|
|
|
39
39
|
#
|
|
40
40
|
# @overload create(body:, request_options: {})
|
|
41
41
|
#
|
|
42
|
-
# @param body [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceCreateParams::Body::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceCreateParams::Body::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceCreateParams::Body::CumulativeGroupedAllocation, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceCreateParams::Body::Percent, Orb::Models::PriceCreateParams::Body::EventOutput] New floating price request body params.
|
|
42
|
+
# @param body [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceCreateParams::Body::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceCreateParams::Body::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceCreateParams::Body::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceCreateParams::Body::CumulativeGroupedAllocation, Orb::Models::PriceCreateParams::Body::DailyCreditAllowance, Orb::Models::PriceCreateParams::Body::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceCreateParams::Body::Percent, Orb::Models::PriceCreateParams::Body::EventOutput] New floating price request body params.
|
|
43
43
|
#
|
|
44
44
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
45
45
|
#
|
|
46
|
-
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, 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::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
46
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
47
47
|
#
|
|
48
48
|
# @see Orb::Models::PriceCreateParams
|
|
49
49
|
def create(params)
|
|
@@ -72,7 +72,7 @@ module Orb
|
|
|
72
72
|
#
|
|
73
73
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
74
74
|
#
|
|
75
|
-
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, 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::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
75
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
76
76
|
#
|
|
77
77
|
# @see Orb::Models::PriceUpdateParams
|
|
78
78
|
def update(price_id, params = {})
|
|
@@ -100,7 +100,7 @@ module Orb
|
|
|
100
100
|
#
|
|
101
101
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
102
102
|
#
|
|
103
|
-
# @return [Orb::Internal::Page<Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, 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::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput>]
|
|
103
|
+
# @return [Orb::Internal::Page<Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput>]
|
|
104
104
|
#
|
|
105
105
|
# @see Orb::Models::PriceListParams
|
|
106
106
|
def list(params = {})
|
|
@@ -293,7 +293,7 @@ module Orb
|
|
|
293
293
|
# @param price_id [String]
|
|
294
294
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
295
295
|
#
|
|
296
|
-
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, 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::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
296
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
297
297
|
#
|
|
298
298
|
# @see Orb::Models::PriceFetchParams
|
|
299
299
|
def fetch(price_id, params = {})
|
|
@@ -267,7 +267,7 @@ module Orb
|
|
|
267
267
|
#
|
|
268
268
|
# By default, Orb limits the number of subscriptions per customer to 100.
|
|
269
269
|
#
|
|
270
|
-
# @overload create(add_adjustments: nil, add_prices: nil, align_billing_with_subscription_start_date: nil, auto_collection: nil, aws_region: nil, billing_cycle_anchor_configuration: nil, coupon_redemption_code: nil, credits_overage_rate: nil, currency: nil, customer_id: nil, default_invoice_memo: nil, end_date: nil, external_customer_id: nil, external_marketplace: nil, external_marketplace_reporting_id: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, metadata: nil, name: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, start_date: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {})
|
|
270
|
+
# @overload create(add_adjustments: nil, add_prices: nil, align_billing_with_subscription_start_date: nil, auto_collection: nil, auto_issuance: nil, aws_region: nil, billing_cycle_anchor_configuration: nil, coupon_redemption_code: nil, credits_overage_rate: nil, currency: nil, customer_id: nil, default_invoice_memo: nil, end_date: nil, external_customer_id: nil, external_marketplace: nil, external_marketplace_reporting_id: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, metadata: nil, name: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, start_date: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {})
|
|
271
271
|
#
|
|
272
272
|
# @param add_adjustments [Array<Orb::Models::SubscriptionCreateParams::AddAdjustment>, nil] Additional adjustments to be added to the subscription. (Only available for acco
|
|
273
273
|
#
|
|
@@ -277,6 +277,8 @@ module Orb
|
|
|
277
277
|
#
|
|
278
278
|
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
|
279
279
|
#
|
|
280
|
+
# @param auto_issuance [Boolean, nil] Used to determine if invoices for this subscription will be automatically issued
|
|
281
|
+
#
|
|
280
282
|
# @param aws_region [String, nil]
|
|
281
283
|
#
|
|
282
284
|
# @param billing_cycle_anchor_configuration [Orb::Models::BillingCycleAnchorConfiguration, nil]
|
|
@@ -358,12 +360,14 @@ module Orb
|
|
|
358
360
|
# `auto_collection`, `invoicing_threshold`, and `default_invoice_memo` properties
|
|
359
361
|
# on a subscription.
|
|
360
362
|
#
|
|
361
|
-
# @overload update(subscription_id, auto_collection: nil, default_invoice_memo: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, request_options: {})
|
|
363
|
+
# @overload update(subscription_id, auto_collection: nil, auto_issuance: nil, default_invoice_memo: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, request_options: {})
|
|
362
364
|
#
|
|
363
365
|
# @param subscription_id [String]
|
|
364
366
|
#
|
|
365
367
|
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
|
366
368
|
#
|
|
369
|
+
# @param auto_issuance [Boolean, nil] Used to determine if invoices for this subscription will be automatically issued
|
|
370
|
+
#
|
|
367
371
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscription's invoices. Note that if this i
|
|
368
372
|
#
|
|
369
373
|
# @param invoicing_threshold [String, nil] When this subscription's accrued usage reaches this threshold, an invoice will b
|
|
@@ -401,6 +405,11 @@ module Orb
|
|
|
401
405
|
# for multiple customers, use the customer_id[] or external_customer_id[] query
|
|
402
406
|
# parameters.
|
|
403
407
|
#
|
|
408
|
+
# Subscriptions can be filtered by status using the status query parameter (one of
|
|
409
|
+
# `active`, `ended`, or `upcoming`). To filter for multiple statuses in a single
|
|
410
|
+
# request, use the status[] query parameter, e.g.
|
|
411
|
+
# `status[]=active&status[]=ended`.
|
|
412
|
+
#
|
|
404
413
|
# @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, external_plan_id: nil, limit: nil, plan_id: nil, status: nil, request_options: {})
|
|
405
414
|
#
|
|
406
415
|
# @param created_at_gt [Time, nil]
|
|
@@ -1218,7 +1227,7 @@ module Orb
|
|
|
1218
1227
|
# behavior, see
|
|
1219
1228
|
# [Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees).
|
|
1220
1229
|
#
|
|
1221
|
-
# @overload schedule_plan_change(subscription_id, change_option:, add_adjustments: nil, add_prices: nil, align_billing_with_plan_change_date: nil, auto_collection: nil, billing_cycle_alignment: nil, billing_cycle_anchor_configuration: nil, change_date: nil, coupon_redemption_code: nil, credits_overage_rate: nil, default_invoice_memo: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {})
|
|
1230
|
+
# @overload schedule_plan_change(subscription_id, change_option:, add_adjustments: nil, add_prices: nil, align_billing_with_plan_change_date: nil, auto_collection: nil, auto_issuance: nil, billing_cycle_alignment: nil, billing_cycle_anchor_configuration: nil, change_date: nil, coupon_redemption_code: nil, credits_overage_rate: nil, default_invoice_memo: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {})
|
|
1222
1231
|
#
|
|
1223
1232
|
# @param subscription_id [String]
|
|
1224
1233
|
#
|
|
@@ -1232,6 +1241,8 @@ module Orb
|
|
|
1232
1241
|
#
|
|
1233
1242
|
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
|
1234
1243
|
#
|
|
1244
|
+
# @param auto_issuance [Boolean, nil] Used to determine if invoices for this subscription will be automatically issued
|
|
1245
|
+
#
|
|
1235
1246
|
# @param billing_cycle_alignment [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment, nil] Reset billing periods to be aligned with the plan change's effective date or sta
|
|
1236
1247
|
#
|
|
1237
1248
|
# @param billing_cycle_anchor_configuration [Orb::Models::BillingCycleAnchorConfiguration, nil]
|
|
@@ -1327,6 +1338,12 @@ module Orb
|
|
|
1327
1338
|
# cancellation. This operation will turn on auto-renew, ensuring that the
|
|
1328
1339
|
# subscription does not end at the currently scheduled cancellation time.
|
|
1329
1340
|
#
|
|
1341
|
+
# Note: uncancellation is a lossy operation. Price intervals that were cut short
|
|
1342
|
+
# by the cancellation are extended to infinity (original end dates are lost), and
|
|
1343
|
+
# future intervals or phases scheduled after the cancellation time are permanently
|
|
1344
|
+
# deleted. For complex subscriptions with phases or scheduled plan changes,
|
|
1345
|
+
# consider creating a new plan change instead of uncancelling.
|
|
1346
|
+
#
|
|
1330
1347
|
# @overload unschedule_cancellation(subscription_id, request_options: {})
|
|
1331
1348
|
#
|
|
1332
1349
|
# @param subscription_id [String]
|
data/lib/orb/version.rb
CHANGED
data/lib/orb.rb
CHANGED
|
@@ -84,6 +84,7 @@ require_relative "orb/models/billing_cycle_relative_date"
|
|
|
84
84
|
require_relative "orb/models/bulk_config"
|
|
85
85
|
require_relative "orb/models/bulk_tier"
|
|
86
86
|
require_relative "orb/models/changed_subscription_resources"
|
|
87
|
+
require_relative "orb/models/conversion_rate_config"
|
|
87
88
|
require_relative "orb/models/conversion_rate_tier"
|
|
88
89
|
require_relative "orb/models/conversion_rate_tiered_config"
|
|
89
90
|
require_relative "orb/models/conversion_rate_unit_config"
|