orb-billing 0.2.0 → 0.3.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 +67 -0
- data/README.md +63 -53
- data/lib/orb/client.rb +4 -4
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +7 -11
- data/lib/orb/internal/transport/base_client.rb +10 -10
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +11 -0
- data/lib/orb/internal/type/base_model.rb +33 -23
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +14 -11
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +19 -16
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
- data/lib/orb/internal/type/hash_of.rb +11 -0
- data/lib/orb/internal/type/request_parameters.rb +3 -10
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +14 -11
- data/lib/orb/internal/util.rb +88 -64
- data/lib/orb/internal.rb +0 -1
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +29 -34
- data/lib/orb/models/coupon_fetch_params.rb +3 -8
- data/lib/orb/models/coupon_list_params.rb +17 -17
- data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
- data/lib/orb/models/credit_note.rb +100 -166
- data/lib/orb/models/credit_note_create_params.rb +15 -23
- data/lib/orb/models/credit_note_fetch_params.rb +3 -8
- data/lib/orb/models/credit_note_list_params.rb +20 -30
- data/lib/orb/models/customer.rb +224 -271
- data/lib/orb/models/customer_create_params.rb +216 -257
- data/lib/orb/models/customer_delete_params.rb +3 -8
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
- data/lib/orb/models/customer_fetch_params.rb +3 -8
- data/lib/orb/models/customer_list_params.rb +20 -30
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
- data/lib/orb/models/customer_update_by_external_id_params.rb +212 -257
- data/lib/orb/models/customer_update_params.rb +212 -255
- data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
- data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
- data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
- data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +23 -27
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +23 -27
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
- data/lib/orb/models/customers/credit_list_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_response.rb +10 -17
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +384 -491
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +384 -498
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +384 -494
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
- data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
- data/lib/orb/models/dimensional_price_group.rb +21 -15
- data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
- data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups.rb +3 -7
- data/lib/orb/models/discount.rb +2 -3
- data/lib/orb/models/evaluate_price_group.rb +8 -11
- data/lib/orb/models/event_deprecate_params.rb +3 -8
- data/lib/orb/models/event_deprecate_response.rb +2 -6
- data/lib/orb/models/event_ingest_params.rb +33 -27
- data/lib/orb/models/event_ingest_response.rb +23 -24
- data/lib/orb/models/event_search_params.rb +15 -11
- data/lib/orb/models/event_search_response.rb +27 -22
- data/lib/orb/models/event_update_params.rb +19 -13
- data/lib/orb/models/event_update_response.rb +2 -6
- data/lib/orb/models/events/backfill_close_params.rb +3 -8
- data/lib/orb/models/events/backfill_close_response.rb +34 -39
- data/lib/orb/models/events/backfill_create_params.rb +28 -32
- data/lib/orb/models/events/backfill_create_response.rb +34 -39
- data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
- data/lib/orb/models/events/backfill_list_params.rb +12 -15
- data/lib/orb/models/events/backfill_list_response.rb +34 -39
- data/lib/orb/models/events/backfill_revert_params.rb +3 -8
- data/lib/orb/models/events/backfill_revert_response.rb +34 -39
- data/lib/orb/models/events/event_volumes.rb +11 -17
- data/lib/orb/models/events/volume_list_params.rb +19 -22
- data/lib/orb/models/invoice.rb +619 -681
- data/lib/orb/models/invoice_create_params.rb +52 -61
- data/lib/orb/models/invoice_fetch_params.rb +3 -8
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +618 -669
- data/lib/orb/models/invoice_issue_params.rb +10 -14
- data/lib/orb/models/invoice_level_discount.rb +2 -3
- data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
- data/lib/orb/models/invoice_line_item_create_response.rb +281 -306
- data/lib/orb/models/invoice_list_params.rb +51 -66
- data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
- data/lib/orb/models/invoice_pay_params.rb +3 -8
- data/lib/orb/models/invoice_update_params.rb +9 -9
- data/lib/orb/models/invoice_void_params.rb +3 -8
- data/lib/orb/models/item.rb +14 -25
- data/lib/orb/models/item_create_params.rb +5 -9
- data/lib/orb/models/item_fetch_params.rb +3 -8
- data/lib/orb/models/item_list_params.rb +12 -15
- data/lib/orb/models/item_update_params.rb +10 -22
- data/lib/orb/models/metric_create_params.rb +17 -13
- data/lib/orb/models/metric_fetch_params.rb +3 -8
- data/lib/orb/models/metric_list_params.rb +20 -30
- data/lib/orb/models/metric_update_params.rb +9 -9
- data/lib/orb/models/pagination_metadata.rb +3 -7
- data/lib/orb/models/percentage_discount.rb +15 -14
- data/lib/orb/models/plan.rb +259 -291
- data/lib/orb/models/plan_create_params.rb +2070 -2466
- data/lib/orb/models/plan_fetch_params.rb +3 -8
- data/lib/orb/models/plan_list_params.rb +25 -42
- data/lib/orb/models/plan_update_params.rb +12 -10
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
- data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
- data/lib/orb/models/price.rb +3842 -5005
- data/lib/orb/models/price_create_params.rb +203 -244
- data/lib/orb/models/price_evaluate_params.rb +21 -30
- data/lib/orb/models/price_evaluate_response.rb +2 -6
- data/lib/orb/models/price_fetch_params.rb +3 -8
- data/lib/orb/models/price_list_params.rb +12 -15
- data/lib/orb/models/price_update_params.rb +9 -9
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
- data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
- data/lib/orb/models/subscription.rb +360 -405
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +358 -399
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +384 -418
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
- data/lib/orb/models/subscription_create_params.rb +4735 -5417
- data/lib/orb/models/subscription_create_response.rb +358 -399
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
- data/lib/orb/models/subscription_fetch_params.rb +3 -8
- data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
- data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
- data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
- data/lib/orb/models/subscription_list_params.rb +28 -41
- data/lib/orb/models/subscription_price_intervals_params.rb +2560 -3040
- data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +362 -396
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +362 -396
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +361 -398
- data/lib/orb/models/subscription_update_params.rb +21 -23
- data/lib/orb/models/subscription_update_trial_params.rb +15 -18
- data/lib/orb/models/subscription_update_trial_response.rb +360 -399
- data/lib/orb/models/subscription_usage.rb +37 -80
- data/lib/orb/models/subscriptions.rb +3 -7
- data/lib/orb/models/top_level_ping_params.rb +3 -8
- data/lib/orb/models/top_level_ping_response.rb +2 -6
- data/lib/orb/models/trial_discount.rb +16 -24
- data/lib/orb/models/usage_discount.rb +15 -14
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -6
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +26 -8
- data/lib/orb/resources/credit_notes.rb +17 -4
- data/lib/orb/resources/customers/balance_transactions.rb +18 -3
- data/lib/orb/resources/customers/costs.rb +26 -8
- data/lib/orb/resources/customers/credits/ledger.rb +112 -32
- data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
- data/lib/orb/resources/customers/credits.rb +28 -8
- data/lib/orb/resources/customers.rb +138 -39
- data/lib/orb/resources/dimensional_price_groups.rb +19 -4
- data/lib/orb/resources/events/backfills.rb +32 -9
- data/lib/orb/resources/events/volume.rb +14 -4
- data/lib/orb/resources/events.rb +40 -11
- data/lib/orb/resources/invoice_line_items.rb +16 -6
- data/lib/orb/resources/invoices.rb +77 -17
- data/lib/orb/resources/items.rb +10 -3
- data/lib/orb/resources/metrics.rb +33 -8
- data/lib/orb/resources/plans/external_plan_id.rb +10 -2
- data/lib/orb/resources/plans.rb +47 -11
- data/lib/orb/resources/prices/external_price_id.rb +9 -3
- data/lib/orb/resources/prices.rb +101 -26
- data/lib/orb/resources/subscription_changes.rb +5 -2
- data/lib/orb/resources/subscriptions.rb +292 -78
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -10
- data/rbi/{lib/orb → orb}/client.rbi +4 -4
- data/rbi/{lib/orb → orb}/errors.rbi +1 -1
- data/rbi/orb/file_part.rbi +34 -0
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
- data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
- data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
- data/rbi/{lib/orb → orb}/internal.rbi +0 -1
- data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
- data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
- data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
- data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
- data/rbi/orb/models.rbi +220 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
- data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
- data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
- data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
- data/sig/orb/file_part.rbs +21 -0
- data/sig/orb/internal/transport/base_client.rbs +9 -3
- data/sig/orb/internal/type/array_of.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +2 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +2 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/util.rbs +16 -12
- data/sig/orb/models/coupon_create_params.rbs +9 -10
- data/sig/orb/models/customer_create_params.rbs +9 -10
- data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
- data/sig/orb/models/customer_update_params.rbs +9 -10
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
- data/sig/orb/models/invoice.rbs +54 -54
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
- data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
- data/sig/orb/models/plan.rbs +21 -21
- data/sig/orb/models/plan_create_params.rbs +653 -653
- data/sig/orb/models/price.rbs +1517 -1521
- data/sig/orb/models/subscription.rbs +34 -34
- data/sig/orb/models/subscription_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
- data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
- data/sig/orb/models/subscription_create_params.rbs +1348 -1348
- data/sig/orb/models/subscription_create_response.rbs +34 -34
- data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
- data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
- data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
- data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
- data/sig/orb/models.rbs +215 -0
- metadata +230 -224
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -92,9 +92,9 @@ module Orb
|
|
92
92
|
returns(
|
93
93
|
T::Array[
|
94
94
|
T.any(
|
95
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::
|
96
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::
|
97
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::
|
95
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Amount,
|
96
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Percentage,
|
97
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Usage
|
98
98
|
)
|
99
99
|
]
|
100
100
|
)
|
@@ -244,10 +244,10 @@ module Orb
|
|
244
244
|
default_invoice_memo: T.nilable(String),
|
245
245
|
discount_intervals: T::Array[
|
246
246
|
T.any(
|
247
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::
|
247
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Amount,
|
248
248
|
Orb::Internal::AnyHash,
|
249
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::
|
250
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::
|
249
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Percentage,
|
250
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Usage
|
251
251
|
)
|
252
252
|
],
|
253
253
|
end_date: T.nilable(Time),
|
@@ -305,31 +305,90 @@ module Orb
|
|
305
305
|
end
|
306
306
|
def self.new(
|
307
307
|
id:,
|
308
|
+
# The current plan phase that is active, only if the subscription's plan has
|
309
|
+
# phases.
|
308
310
|
active_plan_phase_order:,
|
311
|
+
# The adjustment intervals for this subscription sorted by the start_date of the
|
312
|
+
# adjustment interval.
|
309
313
|
adjustment_intervals:,
|
314
|
+
# Determines whether issued invoices for this subscription will automatically be
|
315
|
+
# charged with the saved payment method on the due date. This property defaults to
|
316
|
+
# the plan's behavior. If null, defaults to the customer's setting.
|
310
317
|
auto_collection:,
|
311
318
|
billing_cycle_anchor_configuration:,
|
319
|
+
# The day of the month on which the billing cycle is anchored. If the maximum
|
320
|
+
# number of days in a month is greater than this value, the last day of the month
|
321
|
+
# is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
|
322
|
+
# period begins on the 30th.
|
312
323
|
billing_cycle_day:,
|
313
324
|
created_at:,
|
325
|
+
# The end of the current billing period. This is an exclusive timestamp, such that
|
326
|
+
# the instant returned is not part of the billing period. Set to null for
|
327
|
+
# subscriptions that are not currently active.
|
314
328
|
current_billing_period_end_date:,
|
329
|
+
# The start date of the current billing period. This is an inclusive timestamp;
|
330
|
+
# the instant returned is exactly the beginning of the billing period. Set to null
|
331
|
+
# if the subscription is not currently active.
|
315
332
|
current_billing_period_start_date:,
|
333
|
+
# A customer is a buyer of your products, and the other party to the billing
|
334
|
+
# relationship.
|
335
|
+
#
|
336
|
+
# In Orb, customers are assigned system generated identifiers automatically, but
|
337
|
+
# it's often desirable to have these match existing identifiers in your system. To
|
338
|
+
# avoid having to denormalize Orb ID information, you can pass in an
|
339
|
+
# `external_customer_id` with your own identifier. See
|
340
|
+
# [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
341
|
+
# information about how these aliases work in Orb.
|
342
|
+
#
|
343
|
+
# In addition to having an identifier in your system, a customer may exist in a
|
344
|
+
# payment provider solution like Stripe. Use the `payment_provider_id` and the
|
345
|
+
# `payment_provider` enum field to express this mapping.
|
346
|
+
#
|
347
|
+
# A customer also has a timezone (from the standard
|
348
|
+
# [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
349
|
+
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
350
|
+
# information on what this timezone parameter influences within Orb.
|
316
351
|
customer:,
|
352
|
+
# Determines the default memo on this subscriptions' invoices. Note that if this
|
353
|
+
# is not provided, it is determined by the plan configuration.
|
317
354
|
default_invoice_memo:,
|
355
|
+
# The discount intervals for this subscription sorted by the start_date.
|
318
356
|
discount_intervals:,
|
357
|
+
# The date Orb stops billing for this subscription.
|
319
358
|
end_date:,
|
320
359
|
fixed_fee_quantity_schedule:,
|
321
360
|
invoicing_threshold:,
|
361
|
+
# The maximum intervals for this subscription sorted by the start_date.
|
322
362
|
maximum_intervals:,
|
363
|
+
# User specified key-value pairs for the resource. If not present, this defaults
|
364
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
365
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
366
|
+
# `null`.
|
323
367
|
metadata:,
|
368
|
+
# The minimum intervals for this subscription sorted by the start_date.
|
324
369
|
minimum_intervals:,
|
370
|
+
# Determines the difference between the invoice issue date for subscription
|
371
|
+
# invoices as the date that they are due. A value of `0` here represents that the
|
372
|
+
# invoice is due on issue, whereas a value of `30` represents that the customer
|
373
|
+
# has a month to pay the invoice.
|
325
374
|
net_terms:,
|
375
|
+
# A pending subscription change if one exists on this subscription.
|
326
376
|
pending_subscription_change:,
|
377
|
+
# The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
378
|
+
# subscribed to by a customer. Plans define the billing behavior of the
|
379
|
+
# subscription. You can see more about how to configure prices in the
|
380
|
+
# [Price resource](/reference/price).
|
327
381
|
plan:,
|
382
|
+
# The price intervals for this subscription.
|
328
383
|
price_intervals:,
|
329
384
|
redeemed_coupon:,
|
385
|
+
# The date Orb starts billing for this subscription.
|
330
386
|
start_date:,
|
331
387
|
status:,
|
332
388
|
trial_info:,
|
389
|
+
# The resources that were changed as part of this operation. Only present when
|
390
|
+
# fetched through the subscription changes API or if the
|
391
|
+
# `include_changed_resources` parameter was passed in the request.
|
333
392
|
changed_resources: nil
|
334
393
|
); end
|
335
394
|
sig do
|
@@ -349,9 +408,9 @@ module Orb
|
|
349
408
|
default_invoice_memo: T.nilable(String),
|
350
409
|
discount_intervals: T::Array[
|
351
410
|
T.any(
|
352
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::
|
353
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::
|
354
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::
|
411
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Amount,
|
412
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Percentage,
|
413
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Usage
|
355
414
|
)
|
356
415
|
],
|
357
416
|
end_date: T.nilable(Time),
|
@@ -381,11 +440,11 @@ module Orb
|
|
381
440
|
sig do
|
382
441
|
returns(
|
383
442
|
T.any(
|
384
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
385
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
386
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
387
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
388
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
443
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
444
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
445
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
446
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Minimum,
|
447
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Maximum
|
389
448
|
)
|
390
449
|
)
|
391
450
|
end
|
@@ -407,12 +466,12 @@ module Orb
|
|
407
466
|
params(
|
408
467
|
id: String,
|
409
468
|
adjustment: T.any(
|
410
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
469
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
411
470
|
Orb::Internal::AnyHash,
|
412
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
413
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
414
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
415
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
471
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
472
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
473
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Minimum,
|
474
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Maximum
|
416
475
|
),
|
417
476
|
applies_to_price_interval_ids: T::Array[String],
|
418
477
|
end_date: T.nilable(Time),
|
@@ -420,19 +479,27 @@ module Orb
|
|
420
479
|
)
|
421
480
|
.returns(T.attached_class)
|
422
481
|
end
|
423
|
-
def self.new(
|
424
|
-
|
482
|
+
def self.new(
|
483
|
+
id:,
|
484
|
+
adjustment:,
|
485
|
+
# The price interval IDs that this adjustment applies to.
|
486
|
+
applies_to_price_interval_ids:,
|
487
|
+
# The end date of the adjustment interval.
|
488
|
+
end_date:,
|
489
|
+
# The start date of the adjustment interval.
|
490
|
+
start_date:
|
491
|
+
); end
|
425
492
|
sig do
|
426
493
|
override
|
427
494
|
.returns(
|
428
495
|
{
|
429
496
|
id: String,
|
430
497
|
adjustment: T.any(
|
431
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
432
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
433
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
434
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
435
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
498
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
499
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
500
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
501
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Minimum,
|
502
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Maximum
|
436
503
|
),
|
437
504
|
applies_to_price_interval_ids: T::Array[String],
|
438
505
|
end_date: T.nilable(Time),
|
@@ -445,7 +512,7 @@ module Orb
|
|
445
512
|
module Adjustment
|
446
513
|
extend Orb::Internal::Type::Union
|
447
514
|
|
448
|
-
class
|
515
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
449
516
|
sig { returns(String) }
|
450
517
|
attr_accessor :id
|
451
518
|
|
@@ -488,10 +555,17 @@ module Orb
|
|
488
555
|
end
|
489
556
|
def self.new(
|
490
557
|
id:,
|
558
|
+
# The price IDs that this adjustment applies to.
|
491
559
|
applies_to_price_ids:,
|
560
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
561
|
+
# that apply to only one price.
|
492
562
|
is_invoice_level:,
|
563
|
+
# The plan phase in which this adjustment is active.
|
493
564
|
plan_phase_order:,
|
565
|
+
# The reason for the adjustment.
|
494
566
|
reason:,
|
567
|
+
# The number of usage units by which to discount the price this adjustment applies
|
568
|
+
# to in a given billing period.
|
495
569
|
usage_discount:,
|
496
570
|
adjustment_type: :usage_discount
|
497
571
|
); end
|
@@ -512,7 +586,7 @@ module Orb
|
|
512
586
|
def to_hash; end
|
513
587
|
end
|
514
588
|
|
515
|
-
class
|
589
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
516
590
|
sig { returns(String) }
|
517
591
|
attr_accessor :id
|
518
592
|
|
@@ -555,10 +629,17 @@ module Orb
|
|
555
629
|
end
|
556
630
|
def self.new(
|
557
631
|
id:,
|
632
|
+
# The amount by which to discount the prices this adjustment applies to in a given
|
633
|
+
# billing period.
|
558
634
|
amount_discount:,
|
635
|
+
# The price IDs that this adjustment applies to.
|
559
636
|
applies_to_price_ids:,
|
637
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
638
|
+
# that apply to only one price.
|
560
639
|
is_invoice_level:,
|
640
|
+
# The plan phase in which this adjustment is active.
|
561
641
|
plan_phase_order:,
|
642
|
+
# The reason for the adjustment.
|
562
643
|
reason:,
|
563
644
|
adjustment_type: :amount_discount
|
564
645
|
); end
|
@@ -579,7 +660,7 @@ module Orb
|
|
579
660
|
def to_hash; end
|
580
661
|
end
|
581
662
|
|
582
|
-
class
|
663
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
583
664
|
sig { returns(String) }
|
584
665
|
attr_accessor :id
|
585
666
|
|
@@ -622,10 +703,17 @@ module Orb
|
|
622
703
|
end
|
623
704
|
def self.new(
|
624
705
|
id:,
|
706
|
+
# The price IDs that this adjustment applies to.
|
625
707
|
applies_to_price_ids:,
|
708
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
709
|
+
# that apply to only one price.
|
626
710
|
is_invoice_level:,
|
711
|
+
# The percentage (as a value between 0 and 1) by which to discount the price
|
712
|
+
# intervals this adjustment applies to in a given billing period.
|
627
713
|
percentage_discount:,
|
714
|
+
# The plan phase in which this adjustment is active.
|
628
715
|
plan_phase_order:,
|
716
|
+
# The reason for the adjustment.
|
629
717
|
reason:,
|
630
718
|
adjustment_type: :percentage_discount
|
631
719
|
); end
|
@@ -646,7 +734,7 @@ module Orb
|
|
646
734
|
def to_hash; end
|
647
735
|
end
|
648
736
|
|
649
|
-
class
|
737
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
650
738
|
sig { returns(String) }
|
651
739
|
attr_accessor :id
|
652
740
|
|
@@ -694,11 +782,19 @@ module Orb
|
|
694
782
|
end
|
695
783
|
def self.new(
|
696
784
|
id:,
|
785
|
+
# The price IDs that this adjustment applies to.
|
697
786
|
applies_to_price_ids:,
|
787
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
788
|
+
# that apply to only one price.
|
698
789
|
is_invoice_level:,
|
790
|
+
# The item ID that revenue from this minimum will be attributed to.
|
699
791
|
item_id:,
|
792
|
+
# The minimum amount to charge in a given billing period for the prices this
|
793
|
+
# adjustment applies to.
|
700
794
|
minimum_amount:,
|
795
|
+
# The plan phase in which this adjustment is active.
|
701
796
|
plan_phase_order:,
|
797
|
+
# The reason for the adjustment.
|
702
798
|
reason:,
|
703
799
|
adjustment_type: :minimum
|
704
800
|
); end
|
@@ -720,7 +816,7 @@ module Orb
|
|
720
816
|
def to_hash; end
|
721
817
|
end
|
722
818
|
|
723
|
-
class
|
819
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
724
820
|
sig { returns(String) }
|
725
821
|
attr_accessor :id
|
726
822
|
|
@@ -763,10 +859,17 @@ module Orb
|
|
763
859
|
end
|
764
860
|
def self.new(
|
765
861
|
id:,
|
862
|
+
# The price IDs that this adjustment applies to.
|
766
863
|
applies_to_price_ids:,
|
864
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
865
|
+
# that apply to only one price.
|
767
866
|
is_invoice_level:,
|
867
|
+
# The maximum amount to charge in a given billing period for the prices this
|
868
|
+
# adjustment applies to.
|
768
869
|
maximum_amount:,
|
870
|
+
# The plan phase in which this adjustment is active.
|
769
871
|
plan_phase_order:,
|
872
|
+
# The reason for the adjustment.
|
770
873
|
reason:,
|
771
874
|
adjustment_type: :maximum
|
772
875
|
); end
|
@@ -790,7 +893,7 @@ module Orb
|
|
790
893
|
sig do
|
791
894
|
override
|
792
895
|
.returns(
|
793
|
-
[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::
|
896
|
+
[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Maximum]
|
794
897
|
)
|
795
898
|
end
|
796
899
|
def self.variants; end
|
@@ -819,8 +922,20 @@ module Orb
|
|
819
922
|
sig do
|
820
923
|
params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class)
|
821
924
|
end
|
822
|
-
def self.new(
|
823
|
-
|
925
|
+
def self.new(
|
926
|
+
# The day of the month on which the billing cycle is anchored. If the maximum
|
927
|
+
# number of days in a month is greater than this value, the last day of the month
|
928
|
+
# is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
|
929
|
+
# period begins on the 30th.
|
930
|
+
day:,
|
931
|
+
# The month on which the billing cycle is anchored (e.g. a quarterly price
|
932
|
+
# anchored in February would have cycles starting February, May, August, and
|
933
|
+
# November).
|
934
|
+
month: nil,
|
935
|
+
# The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
|
936
|
+
# anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
|
937
|
+
year: nil
|
938
|
+
); end
|
824
939
|
sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) }
|
825
940
|
def to_hash; end
|
826
941
|
end
|
@@ -828,7 +943,7 @@ module Orb
|
|
828
943
|
module DiscountInterval
|
829
944
|
extend Orb::Internal::Type::Union
|
830
945
|
|
831
|
-
class
|
946
|
+
class Amount < Orb::Internal::Type::BaseModel
|
832
947
|
# Only available if discount_type is `amount`.
|
833
948
|
sig { returns(String) }
|
834
949
|
attr_accessor :amount_discount
|
@@ -864,10 +979,15 @@ module Orb
|
|
864
979
|
.returns(T.attached_class)
|
865
980
|
end
|
866
981
|
def self.new(
|
982
|
+
# Only available if discount_type is `amount`.
|
867
983
|
amount_discount:,
|
984
|
+
# The price ids that this discount interval applies to.
|
868
985
|
applies_to_price_ids:,
|
986
|
+
# The price interval ids that this discount interval applies to.
|
869
987
|
applies_to_price_interval_ids:,
|
988
|
+
# The end date of the discount interval.
|
870
989
|
end_date:,
|
990
|
+
# The start date of the discount interval.
|
871
991
|
start_date:,
|
872
992
|
discount_type: :amount
|
873
993
|
); end
|
@@ -887,7 +1007,7 @@ module Orb
|
|
887
1007
|
def to_hash; end
|
888
1008
|
end
|
889
1009
|
|
890
|
-
class
|
1010
|
+
class Percentage < Orb::Internal::Type::BaseModel
|
891
1011
|
# The price ids that this discount interval applies to.
|
892
1012
|
sig { returns(T::Array[String]) }
|
893
1013
|
attr_accessor :applies_to_price_ids
|
@@ -924,10 +1044,16 @@ module Orb
|
|
924
1044
|
.returns(T.attached_class)
|
925
1045
|
end
|
926
1046
|
def self.new(
|
1047
|
+
# The price ids that this discount interval applies to.
|
927
1048
|
applies_to_price_ids:,
|
1049
|
+
# The price interval ids that this discount interval applies to.
|
928
1050
|
applies_to_price_interval_ids:,
|
1051
|
+
# The end date of the discount interval.
|
929
1052
|
end_date:,
|
1053
|
+
# Only available if discount_type is `percentage`.This is a number between 0
|
1054
|
+
# and 1.
|
930
1055
|
percentage_discount:,
|
1056
|
+
# The start date of the discount interval.
|
931
1057
|
start_date:,
|
932
1058
|
discount_type: :percentage
|
933
1059
|
); end
|
@@ -947,7 +1073,7 @@ module Orb
|
|
947
1073
|
def to_hash; end
|
948
1074
|
end
|
949
1075
|
|
950
|
-
class
|
1076
|
+
class Usage < Orb::Internal::Type::BaseModel
|
951
1077
|
# The price ids that this discount interval applies to.
|
952
1078
|
sig { returns(T::Array[String]) }
|
953
1079
|
attr_accessor :applies_to_price_ids
|
@@ -984,10 +1110,16 @@ module Orb
|
|
984
1110
|
.returns(T.attached_class)
|
985
1111
|
end
|
986
1112
|
def self.new(
|
1113
|
+
# The price ids that this discount interval applies to.
|
987
1114
|
applies_to_price_ids:,
|
1115
|
+
# The price interval ids that this discount interval applies to.
|
988
1116
|
applies_to_price_interval_ids:,
|
1117
|
+
# The end date of the discount interval.
|
989
1118
|
end_date:,
|
1119
|
+
# The start date of the discount interval.
|
990
1120
|
start_date:,
|
1121
|
+
# Only available if discount_type is `usage`. Number of usage units that this
|
1122
|
+
# discount is for
|
991
1123
|
usage_discount:,
|
992
1124
|
discount_type: :usage
|
993
1125
|
); end
|
@@ -1010,7 +1142,7 @@ module Orb
|
|
1010
1142
|
sig do
|
1011
1143
|
override
|
1012
1144
|
.returns(
|
1013
|
-
[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::
|
1145
|
+
[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Usage]
|
1014
1146
|
)
|
1015
1147
|
end
|
1016
1148
|
def self.variants; end
|
@@ -1074,14 +1206,18 @@ module Orb
|
|
1074
1206
|
.returns(T.attached_class)
|
1075
1207
|
end
|
1076
1208
|
def self.new(
|
1209
|
+
# The price ids that this maximum interval applies to.
|
1077
1210
|
applies_to_price_ids:,
|
1211
|
+
# The price interval ids that this maximum interval applies to.
|
1078
1212
|
applies_to_price_interval_ids:,
|
1213
|
+
# The end date of the maximum interval.
|
1079
1214
|
end_date:,
|
1215
|
+
# The maximum amount to charge in a given billing period for the price intervals
|
1216
|
+
# this transform applies to.
|
1080
1217
|
maximum_amount:,
|
1218
|
+
# The start date of the maximum interval.
|
1081
1219
|
start_date:
|
1082
|
-
)
|
1083
|
-
end
|
1084
|
-
|
1220
|
+
); end
|
1085
1221
|
sig do
|
1086
1222
|
override
|
1087
1223
|
.returns(
|
@@ -1130,14 +1266,18 @@ module Orb
|
|
1130
1266
|
.returns(T.attached_class)
|
1131
1267
|
end
|
1132
1268
|
def self.new(
|
1269
|
+
# The price ids that this minimum interval applies to.
|
1133
1270
|
applies_to_price_ids:,
|
1271
|
+
# The price interval ids that this minimum interval applies to.
|
1134
1272
|
applies_to_price_interval_ids:,
|
1273
|
+
# The end date of the minimum interval.
|
1135
1274
|
end_date:,
|
1275
|
+
# The minimum amount to charge in a given billing period for the price intervals
|
1276
|
+
# this minimum applies to.
|
1136
1277
|
minimum_amount:,
|
1278
|
+
# The start date of the minimum interval.
|
1137
1279
|
start_date:
|
1138
|
-
)
|
1139
|
-
end
|
1140
|
-
|
1280
|
+
); end
|
1141
1281
|
sig do
|
1142
1282
|
override
|
1143
1283
|
.returns(
|
@@ -1218,34 +1358,34 @@ module Orb
|
|
1218
1358
|
sig do
|
1219
1359
|
returns(
|
1220
1360
|
T.any(
|
1221
|
-
Orb::Models::Price::
|
1222
|
-
Orb::Models::Price::
|
1223
|
-
Orb::Models::Price::
|
1224
|
-
Orb::Models::Price::
|
1225
|
-
Orb::Models::Price::
|
1226
|
-
Orb::Models::Price::
|
1227
|
-
Orb::Models::Price::
|
1228
|
-
Orb::Models::Price::
|
1229
|
-
Orb::Models::Price::
|
1230
|
-
Orb::Models::Price::
|
1231
|
-
Orb::Models::Price::
|
1232
|
-
Orb::Models::Price::
|
1233
|
-
Orb::Models::Price::
|
1234
|
-
Orb::Models::Price::
|
1235
|
-
Orb::Models::Price::
|
1236
|
-
Orb::Models::Price::
|
1237
|
-
Orb::Models::Price::
|
1238
|
-
Orb::Models::Price::
|
1239
|
-
Orb::Models::Price::
|
1240
|
-
Orb::Models::Price::
|
1241
|
-
Orb::Models::Price::
|
1242
|
-
Orb::Models::Price::
|
1243
|
-
Orb::Models::Price::
|
1244
|
-
Orb::Models::Price::
|
1245
|
-
Orb::Models::Price::
|
1246
|
-
Orb::Models::Price::
|
1247
|
-
Orb::Models::Price::
|
1248
|
-
Orb::Models::Price::
|
1361
|
+
Orb::Models::Price::Unit,
|
1362
|
+
Orb::Models::Price::Package,
|
1363
|
+
Orb::Models::Price::Matrix,
|
1364
|
+
Orb::Models::Price::Tiered,
|
1365
|
+
Orb::Models::Price::TieredBps,
|
1366
|
+
Orb::Models::Price::Bps,
|
1367
|
+
Orb::Models::Price::BulkBps,
|
1368
|
+
Orb::Models::Price::Bulk,
|
1369
|
+
Orb::Models::Price::ThresholdTotalAmount,
|
1370
|
+
Orb::Models::Price::TieredPackage,
|
1371
|
+
Orb::Models::Price::GroupedTiered,
|
1372
|
+
Orb::Models::Price::TieredWithMinimum,
|
1373
|
+
Orb::Models::Price::TieredPackageWithMinimum,
|
1374
|
+
Orb::Models::Price::PackageWithAllocation,
|
1375
|
+
Orb::Models::Price::UnitWithPercent,
|
1376
|
+
Orb::Models::Price::MatrixWithAllocation,
|
1377
|
+
Orb::Models::Price::TieredWithProration,
|
1378
|
+
Orb::Models::Price::UnitWithProration,
|
1379
|
+
Orb::Models::Price::GroupedAllocation,
|
1380
|
+
Orb::Models::Price::GroupedWithProratedMinimum,
|
1381
|
+
Orb::Models::Price::GroupedWithMeteredMinimum,
|
1382
|
+
Orb::Models::Price::MatrixWithDisplayName,
|
1383
|
+
Orb::Models::Price::BulkWithProration,
|
1384
|
+
Orb::Models::Price::GroupedTieredPackage,
|
1385
|
+
Orb::Models::Price::MaxGroupTieredPackage,
|
1386
|
+
Orb::Models::Price::ScalableMatrixWithUnitPricing,
|
1387
|
+
Orb::Models::Price::ScalableMatrixWithTieredPricing,
|
1388
|
+
Orb::Models::Price::CumulativeGroupedBulk
|
1249
1389
|
)
|
1250
1390
|
)
|
1251
1391
|
end
|
@@ -1281,35 +1421,35 @@ module Orb
|
|
1281
1421
|
]
|
1282
1422
|
),
|
1283
1423
|
price: T.any(
|
1284
|
-
Orb::Models::Price::
|
1424
|
+
Orb::Models::Price::Unit,
|
1285
1425
|
Orb::Internal::AnyHash,
|
1286
|
-
Orb::Models::Price::
|
1287
|
-
Orb::Models::Price::
|
1288
|
-
Orb::Models::Price::
|
1289
|
-
Orb::Models::Price::
|
1290
|
-
Orb::Models::Price::
|
1291
|
-
Orb::Models::Price::
|
1292
|
-
Orb::Models::Price::
|
1293
|
-
Orb::Models::Price::
|
1294
|
-
Orb::Models::Price::
|
1295
|
-
Orb::Models::Price::
|
1296
|
-
Orb::Models::Price::
|
1297
|
-
Orb::Models::Price::
|
1298
|
-
Orb::Models::Price::
|
1299
|
-
Orb::Models::Price::
|
1300
|
-
Orb::Models::Price::
|
1301
|
-
Orb::Models::Price::
|
1302
|
-
Orb::Models::Price::
|
1303
|
-
Orb::Models::Price::
|
1304
|
-
Orb::Models::Price::
|
1305
|
-
Orb::Models::Price::
|
1306
|
-
Orb::Models::Price::
|
1307
|
-
Orb::Models::Price::
|
1308
|
-
Orb::Models::Price::
|
1309
|
-
Orb::Models::Price::
|
1310
|
-
Orb::Models::Price::
|
1311
|
-
Orb::Models::Price::
|
1312
|
-
Orb::Models::Price::
|
1426
|
+
Orb::Models::Price::Package,
|
1427
|
+
Orb::Models::Price::Matrix,
|
1428
|
+
Orb::Models::Price::Tiered,
|
1429
|
+
Orb::Models::Price::TieredBps,
|
1430
|
+
Orb::Models::Price::Bps,
|
1431
|
+
Orb::Models::Price::BulkBps,
|
1432
|
+
Orb::Models::Price::Bulk,
|
1433
|
+
Orb::Models::Price::ThresholdTotalAmount,
|
1434
|
+
Orb::Models::Price::TieredPackage,
|
1435
|
+
Orb::Models::Price::GroupedTiered,
|
1436
|
+
Orb::Models::Price::TieredWithMinimum,
|
1437
|
+
Orb::Models::Price::TieredPackageWithMinimum,
|
1438
|
+
Orb::Models::Price::PackageWithAllocation,
|
1439
|
+
Orb::Models::Price::UnitWithPercent,
|
1440
|
+
Orb::Models::Price::MatrixWithAllocation,
|
1441
|
+
Orb::Models::Price::TieredWithProration,
|
1442
|
+
Orb::Models::Price::UnitWithProration,
|
1443
|
+
Orb::Models::Price::GroupedAllocation,
|
1444
|
+
Orb::Models::Price::GroupedWithProratedMinimum,
|
1445
|
+
Orb::Models::Price::GroupedWithMeteredMinimum,
|
1446
|
+
Orb::Models::Price::MatrixWithDisplayName,
|
1447
|
+
Orb::Models::Price::BulkWithProration,
|
1448
|
+
Orb::Models::Price::GroupedTieredPackage,
|
1449
|
+
Orb::Models::Price::MaxGroupTieredPackage,
|
1450
|
+
Orb::Models::Price::ScalableMatrixWithUnitPricing,
|
1451
|
+
Orb::Models::Price::ScalableMatrixWithTieredPricing,
|
1452
|
+
Orb::Models::Price::CumulativeGroupedBulk
|
1313
1453
|
),
|
1314
1454
|
start_date: Time,
|
1315
1455
|
usage_customer_ids: T.nilable(T::Array[String])
|
@@ -1318,14 +1458,40 @@ module Orb
|
|
1318
1458
|
end
|
1319
1459
|
def self.new(
|
1320
1460
|
id:,
|
1461
|
+
# The day of the month that Orb bills for this price
|
1321
1462
|
billing_cycle_day:,
|
1463
|
+
# The end of the current billing period. This is an exclusive timestamp, such that
|
1464
|
+
# the instant returned is exactly the end of the billing period. Set to null if
|
1465
|
+
# this price interval is not currently active.
|
1322
1466
|
current_billing_period_end_date:,
|
1467
|
+
# The start date of the current billing period. This is an inclusive timestamp;
|
1468
|
+
# the instant returned is exactly the beginning of the billing period. Set to null
|
1469
|
+
# if this price interval is not currently active.
|
1323
1470
|
current_billing_period_start_date:,
|
1471
|
+
# The end date of the price interval. This is the date that Orb stops billing for
|
1472
|
+
# this price.
|
1324
1473
|
end_date:,
|
1474
|
+
# An additional filter to apply to usage queries.
|
1325
1475
|
filter:,
|
1476
|
+
# The fixed fee quantity transitions for this price interval. This is only
|
1477
|
+
# relevant for fixed fees.
|
1326
1478
|
fixed_fee_quantity_transitions:,
|
1479
|
+
# The Price resource represents a price that can be billed on a subscription,
|
1480
|
+
# resulting in a charge on an invoice in the form of an invoice line item. Prices
|
1481
|
+
# take a quantity and determine an amount to bill.
|
1482
|
+
#
|
1483
|
+
# Orb supports a few different pricing models out of the box. Each of these models
|
1484
|
+
# is serialized differently in a given Price object. The model_type field
|
1485
|
+
# determines the key for the configuration object that is present.
|
1486
|
+
#
|
1487
|
+
# For more on the types of prices, see
|
1488
|
+
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1327
1489
|
price:,
|
1490
|
+
# The start date of the price interval. This is the date that Orb starts billing
|
1491
|
+
# for this price.
|
1328
1492
|
start_date:,
|
1493
|
+
# A list of customer IDs whose usage events will be aggregated and billed under
|
1494
|
+
# this price interval.
|
1329
1495
|
usage_customer_ids:
|
1330
1496
|
); end
|
1331
1497
|
sig do
|
@@ -1342,34 +1508,34 @@ module Orb
|
|
1342
1508
|
T::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval::FixedFeeQuantityTransition]
|
1343
1509
|
),
|
1344
1510
|
price: T.any(
|
1345
|
-
Orb::Models::Price::
|
1346
|
-
Orb::Models::Price::
|
1347
|
-
Orb::Models::Price::
|
1348
|
-
Orb::Models::Price::
|
1349
|
-
Orb::Models::Price::
|
1350
|
-
Orb::Models::Price::
|
1351
|
-
Orb::Models::Price::
|
1352
|
-
Orb::Models::Price::
|
1353
|
-
Orb::Models::Price::
|
1354
|
-
Orb::Models::Price::
|
1355
|
-
Orb::Models::Price::
|
1356
|
-
Orb::Models::Price::
|
1357
|
-
Orb::Models::Price::
|
1358
|
-
Orb::Models::Price::
|
1359
|
-
Orb::Models::Price::
|
1360
|
-
Orb::Models::Price::
|
1361
|
-
Orb::Models::Price::
|
1362
|
-
Orb::Models::Price::
|
1363
|
-
Orb::Models::Price::
|
1364
|
-
Orb::Models::Price::
|
1365
|
-
Orb::Models::Price::
|
1366
|
-
Orb::Models::Price::
|
1367
|
-
Orb::Models::Price::
|
1368
|
-
Orb::Models::Price::
|
1369
|
-
Orb::Models::Price::
|
1370
|
-
Orb::Models::Price::
|
1371
|
-
Orb::Models::Price::
|
1372
|
-
Orb::Models::Price::
|
1511
|
+
Orb::Models::Price::Unit,
|
1512
|
+
Orb::Models::Price::Package,
|
1513
|
+
Orb::Models::Price::Matrix,
|
1514
|
+
Orb::Models::Price::Tiered,
|
1515
|
+
Orb::Models::Price::TieredBps,
|
1516
|
+
Orb::Models::Price::Bps,
|
1517
|
+
Orb::Models::Price::BulkBps,
|
1518
|
+
Orb::Models::Price::Bulk,
|
1519
|
+
Orb::Models::Price::ThresholdTotalAmount,
|
1520
|
+
Orb::Models::Price::TieredPackage,
|
1521
|
+
Orb::Models::Price::GroupedTiered,
|
1522
|
+
Orb::Models::Price::TieredWithMinimum,
|
1523
|
+
Orb::Models::Price::TieredPackageWithMinimum,
|
1524
|
+
Orb::Models::Price::PackageWithAllocation,
|
1525
|
+
Orb::Models::Price::UnitWithPercent,
|
1526
|
+
Orb::Models::Price::MatrixWithAllocation,
|
1527
|
+
Orb::Models::Price::TieredWithProration,
|
1528
|
+
Orb::Models::Price::UnitWithProration,
|
1529
|
+
Orb::Models::Price::GroupedAllocation,
|
1530
|
+
Orb::Models::Price::GroupedWithProratedMinimum,
|
1531
|
+
Orb::Models::Price::GroupedWithMeteredMinimum,
|
1532
|
+
Orb::Models::Price::MatrixWithDisplayName,
|
1533
|
+
Orb::Models::Price::BulkWithProration,
|
1534
|
+
Orb::Models::Price::GroupedTieredPackage,
|
1535
|
+
Orb::Models::Price::MaxGroupTieredPackage,
|
1536
|
+
Orb::Models::Price::ScalableMatrixWithUnitPricing,
|
1537
|
+
Orb::Models::Price::ScalableMatrixWithTieredPricing,
|
1538
|
+
Orb::Models::Price::CumulativeGroupedBulk
|
1373
1539
|
),
|
1374
1540
|
start_date: Time,
|
1375
1541
|
usage_customer_ids: T.nilable(T::Array[String])
|
@@ -1420,8 +1586,7 @@ module Orb
|
|
1420
1586
|
|
1421
1587
|
TaggedSymbol =
|
1422
1588
|
T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status) }
|
1423
|
-
OrSymbol =
|
1424
|
-
T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status::TaggedSymbol) }
|
1589
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1425
1590
|
|
1426
1591
|
ACTIVE =
|
1427
1592
|
T.let(:active, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status::TaggedSymbol)
|
@@ -1477,8 +1642,16 @@ module Orb
|
|
1477
1642
|
)
|
1478
1643
|
.returns(T.attached_class)
|
1479
1644
|
end
|
1480
|
-
def self.new(
|
1481
|
-
|
1645
|
+
def self.new(
|
1646
|
+
# The credit notes that were created as part of this operation.
|
1647
|
+
created_credit_notes:,
|
1648
|
+
# The invoices that were created as part of this operation.
|
1649
|
+
created_invoices:,
|
1650
|
+
# The credit notes that were voided as part of this operation.
|
1651
|
+
voided_credit_notes:,
|
1652
|
+
# The invoices that were voided as part of this operation.
|
1653
|
+
voided_invoices:
|
1654
|
+
); end
|
1482
1655
|
sig do
|
1483
1656
|
override
|
1484
1657
|
.returns(
|