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
@@ -37,22 +37,27 @@ module Orb
|
|
37
37
|
# @return [Time, nil]
|
38
38
|
optional :cancelled_at, Time, nil?: true
|
39
39
|
|
40
|
-
# @!
|
41
|
-
#
|
42
|
-
#
|
43
|
-
#
|
44
|
-
#
|
45
|
-
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
|
55
|
-
#
|
40
|
+
# @!method initialize(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil)
|
41
|
+
# Some parameter documentations has been truncated, see
|
42
|
+
# {Orb::Models::SubscriptionChangeApplyResponse} for more details.
|
43
|
+
#
|
44
|
+
# A subscription change represents a desired new subscription / pending change to
|
45
|
+
# an existing subscription. It is a way to first preview the effects on the
|
46
|
+
# subscription as well as any changes/creation of invoices (see
|
47
|
+
# `subscription.changed_resources`).
|
48
|
+
#
|
49
|
+
# @param id [String]
|
50
|
+
#
|
51
|
+
# @param expiration_time [Time] Subscription change will be cancelled at this time and can no longer be applied.
|
52
|
+
# ...
|
53
|
+
#
|
54
|
+
# @param status [Symbol, Orb::Models::SubscriptionChangeApplyResponse::Status]
|
55
|
+
#
|
56
|
+
# @param subscription [Orb::Models::SubscriptionChangeApplyResponse::Subscription, nil]
|
57
|
+
#
|
58
|
+
# @param applied_at [Time, nil] When this change was applied.
|
59
|
+
#
|
60
|
+
# @param cancelled_at [Time, nil] When this change was cancelled.
|
56
61
|
|
57
62
|
# @see Orb::Models::SubscriptionChangeApplyResponse#status
|
58
63
|
module Status
|
@@ -62,11 +67,8 @@ module Orb
|
|
62
67
|
APPLIED = :applied
|
63
68
|
CANCELLED = :cancelled
|
64
69
|
|
65
|
-
|
66
|
-
|
67
|
-
# @!parse
|
68
|
-
# # @return [Array<Symbol>]
|
69
|
-
# def self.values; end
|
70
|
+
# @!method self.values
|
71
|
+
# @return [Array<Symbol>]
|
70
72
|
end
|
71
73
|
|
72
74
|
# @see Orb::Models::SubscriptionChangeApplyResponse#subscription
|
@@ -168,7 +170,7 @@ module Orb
|
|
168
170
|
# @!attribute discount_intervals
|
169
171
|
# The discount intervals for this subscription sorted by the start_date.
|
170
172
|
#
|
171
|
-
# @return [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::
|
173
|
+
# @return [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Amount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Percentage, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Usage>]
|
172
174
|
required :discount_intervals,
|
173
175
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval] }
|
174
176
|
|
@@ -278,69 +280,75 @@ module Orb
|
|
278
280
|
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources },
|
279
281
|
nil?: true
|
280
282
|
|
281
|
-
# @!
|
282
|
-
#
|
283
|
-
#
|
284
|
-
#
|
285
|
-
#
|
286
|
-
#
|
287
|
-
#
|
288
|
-
#
|
289
|
-
#
|
290
|
-
#
|
291
|
-
#
|
292
|
-
#
|
293
|
-
#
|
294
|
-
#
|
295
|
-
#
|
296
|
-
#
|
297
|
-
#
|
298
|
-
#
|
299
|
-
#
|
300
|
-
#
|
301
|
-
#
|
302
|
-
#
|
303
|
-
#
|
304
|
-
#
|
305
|
-
#
|
306
|
-
#
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
310
|
-
#
|
311
|
-
#
|
312
|
-
#
|
313
|
-
#
|
314
|
-
#
|
315
|
-
#
|
316
|
-
#
|
317
|
-
#
|
318
|
-
#
|
319
|
-
#
|
320
|
-
#
|
321
|
-
#
|
322
|
-
#
|
323
|
-
#
|
324
|
-
#
|
325
|
-
#
|
326
|
-
#
|
327
|
-
#
|
328
|
-
#
|
329
|
-
#
|
330
|
-
#
|
331
|
-
#
|
332
|
-
#
|
333
|
-
#
|
334
|
-
#
|
335
|
-
#
|
336
|
-
#
|
337
|
-
#
|
338
|
-
#
|
339
|
-
#
|
340
|
-
#
|
341
|
-
#
|
342
|
-
|
343
|
-
#
|
283
|
+
# @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil)
|
284
|
+
# Some parameter documentations has been truncated, see
|
285
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription} for more details.
|
286
|
+
#
|
287
|
+
# @param id [String]
|
288
|
+
#
|
289
|
+
# @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
|
290
|
+
# ...
|
291
|
+
#
|
292
|
+
# @param adjustment_intervals [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
|
293
|
+
# ...
|
294
|
+
#
|
295
|
+
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
296
|
+
# ...
|
297
|
+
#
|
298
|
+
# @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration]
|
299
|
+
#
|
300
|
+
# @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
301
|
+
# ...
|
302
|
+
#
|
303
|
+
# @param created_at [Time]
|
304
|
+
#
|
305
|
+
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
306
|
+
# ...
|
307
|
+
#
|
308
|
+
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
309
|
+
# ...
|
310
|
+
#
|
311
|
+
# @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
312
|
+
# ...
|
313
|
+
#
|
314
|
+
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
315
|
+
# ...
|
316
|
+
#
|
317
|
+
# @param discount_intervals [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Amount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Percentage, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
318
|
+
#
|
319
|
+
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
320
|
+
#
|
321
|
+
# @param fixed_fee_quantity_schedule [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::FixedFeeQuantitySchedule>]
|
322
|
+
#
|
323
|
+
# @param invoicing_threshold [String, nil]
|
324
|
+
#
|
325
|
+
# @param maximum_intervals [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
|
326
|
+
#
|
327
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
328
|
+
# ...
|
329
|
+
#
|
330
|
+
# @param minimum_intervals [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
331
|
+
#
|
332
|
+
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
333
|
+
# ...
|
334
|
+
#
|
335
|
+
# @param pending_subscription_change [Orb::Models::SubscriptionChangeApplyResponse::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
336
|
+
#
|
337
|
+
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
338
|
+
# ...
|
339
|
+
#
|
340
|
+
# @param price_intervals [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval>] The price intervals for this subscription.
|
341
|
+
#
|
342
|
+
# @param redeemed_coupon [Orb::Models::SubscriptionChangeApplyResponse::Subscription::RedeemedCoupon, nil]
|
343
|
+
#
|
344
|
+
# @param start_date [Time] The date Orb starts billing for this subscription.
|
345
|
+
#
|
346
|
+
# @param status [Symbol, Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status]
|
347
|
+
#
|
348
|
+
# @param trial_info [Orb::Models::SubscriptionChangeApplyResponse::Subscription::TrialInfo]
|
349
|
+
#
|
350
|
+
# @param changed_resources [Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
|
351
|
+
# ...
|
344
352
|
|
345
353
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
346
354
|
# @!attribute id
|
@@ -350,7 +358,7 @@ module Orb
|
|
350
358
|
|
351
359
|
# @!attribute adjustment
|
352
360
|
#
|
353
|
-
# @return [Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
361
|
+
# @return [Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Maximum]
|
354
362
|
required :adjustment,
|
355
363
|
union: -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment }
|
356
364
|
|
@@ -372,16 +380,16 @@ module Orb
|
|
372
380
|
# @return [Time]
|
373
381
|
required :start_date, Time
|
374
382
|
|
375
|
-
# @!
|
376
|
-
#
|
377
|
-
#
|
378
|
-
#
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
383
|
-
|
384
|
-
#
|
383
|
+
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
384
|
+
# @param id [String]
|
385
|
+
#
|
386
|
+
# @param adjustment [Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Maximum]
|
387
|
+
#
|
388
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
389
|
+
#
|
390
|
+
# @param end_date [Time, nil] The end date of the adjustment interval.
|
391
|
+
#
|
392
|
+
# @param start_date [Time] The start date of the adjustment interval.
|
385
393
|
|
386
394
|
# @see Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval#adjustment
|
387
395
|
module Adjustment
|
@@ -390,21 +398,21 @@ module Orb
|
|
390
398
|
discriminator :adjustment_type
|
391
399
|
|
392
400
|
variant :usage_discount,
|
393
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
401
|
+
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount }
|
394
402
|
|
395
403
|
variant :amount_discount,
|
396
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
404
|
+
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount }
|
397
405
|
|
398
406
|
variant :percentage_discount,
|
399
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
407
|
+
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount }
|
400
408
|
|
401
409
|
variant :minimum,
|
402
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
410
|
+
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Minimum }
|
403
411
|
|
404
412
|
variant :maximum,
|
405
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
413
|
+
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Maximum }
|
406
414
|
|
407
|
-
class
|
415
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
408
416
|
# @!attribute id
|
409
417
|
#
|
410
418
|
# @return [String]
|
@@ -447,32 +455,29 @@ module Orb
|
|
447
455
|
# @return [Float]
|
448
456
|
required :usage_discount, Float
|
449
457
|
|
450
|
-
# @!
|
451
|
-
#
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
#
|
457
|
-
#
|
458
|
-
#
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
462
|
-
#
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
466
|
-
#
|
467
|
-
#
|
468
|
-
#
|
469
|
-
#
|
470
|
-
# end
|
471
|
-
|
472
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
458
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
459
|
+
# Some parameter documentations has been truncated, see
|
460
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount}
|
461
|
+
# for more details.
|
462
|
+
#
|
463
|
+
# @param id [String]
|
464
|
+
#
|
465
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
466
|
+
#
|
467
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
468
|
+
# ...
|
469
|
+
#
|
470
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
471
|
+
#
|
472
|
+
# @param reason [String, nil] The reason for the adjustment.
|
473
|
+
#
|
474
|
+
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
475
|
+
# ...
|
476
|
+
#
|
477
|
+
# @param adjustment_type [Symbol, :usage_discount]
|
473
478
|
end
|
474
479
|
|
475
|
-
class
|
480
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
476
481
|
# @!attribute id
|
477
482
|
#
|
478
483
|
# @return [String]
|
@@ -515,32 +520,29 @@ module Orb
|
|
515
520
|
# @return [String, nil]
|
516
521
|
required :reason, String, nil?: true
|
517
522
|
|
518
|
-
# @!
|
519
|
-
#
|
520
|
-
#
|
521
|
-
#
|
522
|
-
#
|
523
|
-
#
|
524
|
-
#
|
525
|
-
#
|
526
|
-
#
|
527
|
-
#
|
528
|
-
#
|
529
|
-
#
|
530
|
-
#
|
531
|
-
#
|
532
|
-
#
|
533
|
-
#
|
534
|
-
#
|
535
|
-
#
|
536
|
-
#
|
537
|
-
#
|
538
|
-
# end
|
539
|
-
|
540
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
523
|
+
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
524
|
+
# Some parameter documentations has been truncated, see
|
525
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount}
|
526
|
+
# for more details.
|
527
|
+
#
|
528
|
+
# @param id [String]
|
529
|
+
#
|
530
|
+
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
531
|
+
# ...
|
532
|
+
#
|
533
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
534
|
+
#
|
535
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
536
|
+
# ...
|
537
|
+
#
|
538
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
539
|
+
#
|
540
|
+
# @param reason [String, nil] The reason for the adjustment.
|
541
|
+
#
|
542
|
+
# @param adjustment_type [Symbol, :amount_discount]
|
541
543
|
end
|
542
544
|
|
543
|
-
class
|
545
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
544
546
|
# @!attribute id
|
545
547
|
#
|
546
548
|
# @return [String]
|
@@ -583,32 +585,29 @@ module Orb
|
|
583
585
|
# @return [String, nil]
|
584
586
|
required :reason, String, nil?: true
|
585
587
|
|
586
|
-
# @!
|
587
|
-
#
|
588
|
-
#
|
589
|
-
#
|
590
|
-
#
|
591
|
-
#
|
592
|
-
#
|
593
|
-
#
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
#
|
598
|
-
#
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
602
|
-
#
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
# end
|
607
|
-
|
608
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
588
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
589
|
+
# Some parameter documentations has been truncated, see
|
590
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount}
|
591
|
+
# for more details.
|
592
|
+
#
|
593
|
+
# @param id [String]
|
594
|
+
#
|
595
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
596
|
+
#
|
597
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
598
|
+
# ...
|
599
|
+
#
|
600
|
+
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
601
|
+
# ...
|
602
|
+
#
|
603
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
604
|
+
#
|
605
|
+
# @param reason [String, nil] The reason for the adjustment.
|
606
|
+
#
|
607
|
+
# @param adjustment_type [Symbol, :percentage_discount]
|
609
608
|
end
|
610
609
|
|
611
|
-
class
|
610
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
612
611
|
# @!attribute id
|
613
612
|
#
|
614
613
|
# @return [String]
|
@@ -657,34 +656,31 @@ module Orb
|
|
657
656
|
# @return [String, nil]
|
658
657
|
required :reason, String, nil?: true
|
659
658
|
|
660
|
-
# @!
|
661
|
-
#
|
662
|
-
#
|
663
|
-
#
|
664
|
-
#
|
665
|
-
#
|
666
|
-
#
|
667
|
-
#
|
668
|
-
#
|
669
|
-
#
|
670
|
-
#
|
671
|
-
#
|
672
|
-
#
|
673
|
-
#
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
#
|
682
|
-
# end
|
683
|
-
|
684
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
659
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
660
|
+
# Some parameter documentations has been truncated, see
|
661
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Minimum}
|
662
|
+
# for more details.
|
663
|
+
#
|
664
|
+
# @param id [String]
|
665
|
+
#
|
666
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
667
|
+
#
|
668
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
669
|
+
# ...
|
670
|
+
#
|
671
|
+
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
672
|
+
#
|
673
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
674
|
+
# ...
|
675
|
+
#
|
676
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
677
|
+
#
|
678
|
+
# @param reason [String, nil] The reason for the adjustment.
|
679
|
+
#
|
680
|
+
# @param adjustment_type [Symbol, :minimum]
|
685
681
|
end
|
686
682
|
|
687
|
-
class
|
683
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
688
684
|
# @!attribute id
|
689
685
|
#
|
690
686
|
# @return [String]
|
@@ -727,34 +723,30 @@ module Orb
|
|
727
723
|
# @return [String, nil]
|
728
724
|
required :reason, String, nil?: true
|
729
725
|
|
730
|
-
# @!
|
731
|
-
#
|
732
|
-
#
|
733
|
-
#
|
734
|
-
#
|
735
|
-
#
|
736
|
-
#
|
737
|
-
#
|
738
|
-
#
|
739
|
-
#
|
740
|
-
#
|
741
|
-
#
|
742
|
-
#
|
743
|
-
#
|
744
|
-
#
|
745
|
-
#
|
746
|
-
#
|
747
|
-
#
|
748
|
-
#
|
749
|
-
#
|
750
|
-
# end
|
751
|
-
|
752
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
726
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
727
|
+
# Some parameter documentations has been truncated, see
|
728
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Maximum}
|
729
|
+
# for more details.
|
730
|
+
#
|
731
|
+
# @param id [String]
|
732
|
+
#
|
733
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
734
|
+
#
|
735
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
736
|
+
# ...
|
737
|
+
#
|
738
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
739
|
+
# ...
|
740
|
+
#
|
741
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
742
|
+
#
|
743
|
+
# @param reason [String, nil] The reason for the adjustment.
|
744
|
+
#
|
745
|
+
# @param adjustment_type [Symbol, :maximum]
|
753
746
|
end
|
754
747
|
|
755
|
-
# @!
|
756
|
-
#
|
757
|
-
# def self.variants; end
|
748
|
+
# @!method self.variants
|
749
|
+
# @return [Array(Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Maximum)]
|
758
750
|
end
|
759
751
|
end
|
760
752
|
|
@@ -784,14 +776,19 @@ module Orb
|
|
784
776
|
# @return [Integer, nil]
|
785
777
|
optional :year, Integer, nil?: true
|
786
778
|
|
787
|
-
# @!
|
788
|
-
#
|
789
|
-
#
|
790
|
-
#
|
791
|
-
#
|
792
|
-
#
|
793
|
-
|
794
|
-
#
|
779
|
+
# @!method initialize(day:, month: nil, year: nil)
|
780
|
+
# Some parameter documentations has been truncated, see
|
781
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration}
|
782
|
+
# for more details.
|
783
|
+
#
|
784
|
+
# @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
785
|
+
# ...
|
786
|
+
#
|
787
|
+
# @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
|
788
|
+
# ...
|
789
|
+
#
|
790
|
+
# @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
|
791
|
+
# ...
|
795
792
|
end
|
796
793
|
|
797
794
|
module DiscountInterval
|
@@ -800,15 +797,14 @@ module Orb
|
|
800
797
|
discriminator :discount_type
|
801
798
|
|
802
799
|
variant :amount,
|
803
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::
|
800
|
+
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Amount }
|
804
801
|
|
805
802
|
variant :percentage,
|
806
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::
|
803
|
+
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Percentage }
|
807
804
|
|
808
|
-
variant :usage,
|
809
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::UsageDiscountInterval }
|
805
|
+
variant :usage, -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Usage }
|
810
806
|
|
811
|
-
class
|
807
|
+
class Amount < Orb::Internal::Type::BaseModel
|
812
808
|
# @!attribute amount_discount
|
813
809
|
# Only available if discount_type is `amount`.
|
814
810
|
#
|
@@ -844,30 +840,21 @@ module Orb
|
|
844
840
|
# @return [Time]
|
845
841
|
required :start_date, Time
|
846
842
|
|
847
|
-
# @!
|
848
|
-
#
|
849
|
-
#
|
850
|
-
#
|
851
|
-
#
|
852
|
-
#
|
853
|
-
#
|
854
|
-
#
|
855
|
-
#
|
856
|
-
#
|
857
|
-
#
|
858
|
-
#
|
859
|
-
# end_date:,
|
860
|
-
# start_date:,
|
861
|
-
# discount_type: :amount,
|
862
|
-
# **
|
863
|
-
# )
|
864
|
-
# super
|
865
|
-
# end
|
866
|
-
|
867
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
843
|
+
# @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount)
|
844
|
+
# @param amount_discount [String] Only available if discount_type is `amount`.
|
845
|
+
#
|
846
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
847
|
+
#
|
848
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
849
|
+
#
|
850
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
851
|
+
#
|
852
|
+
# @param start_date [Time] The start date of the discount interval.
|
853
|
+
#
|
854
|
+
# @param discount_type [Symbol, :amount]
|
868
855
|
end
|
869
856
|
|
870
|
-
class
|
857
|
+
class Percentage < Orb::Internal::Type::BaseModel
|
871
858
|
# @!attribute applies_to_price_ids
|
872
859
|
# The price ids that this discount interval applies to.
|
873
860
|
#
|
@@ -904,30 +891,26 @@ module Orb
|
|
904
891
|
# @return [Time]
|
905
892
|
required :start_date, Time
|
906
893
|
|
907
|
-
# @!
|
908
|
-
#
|
909
|
-
#
|
910
|
-
#
|
911
|
-
#
|
912
|
-
#
|
913
|
-
#
|
914
|
-
#
|
915
|
-
#
|
916
|
-
#
|
917
|
-
#
|
918
|
-
#
|
919
|
-
#
|
920
|
-
#
|
921
|
-
#
|
922
|
-
#
|
923
|
-
#
|
924
|
-
# super
|
925
|
-
# end
|
926
|
-
|
927
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
894
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
895
|
+
# Some parameter documentations has been truncated, see
|
896
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Percentage}
|
897
|
+
# for more details.
|
898
|
+
#
|
899
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
900
|
+
#
|
901
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
902
|
+
#
|
903
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
904
|
+
#
|
905
|
+
# @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
|
906
|
+
# ...
|
907
|
+
#
|
908
|
+
# @param start_date [Time] The start date of the discount interval.
|
909
|
+
#
|
910
|
+
# @param discount_type [Symbol, :percentage]
|
928
911
|
end
|
929
912
|
|
930
|
-
class
|
913
|
+
class Usage < Orb::Internal::Type::BaseModel
|
931
914
|
# @!attribute applies_to_price_ids
|
932
915
|
# The price ids that this discount interval applies to.
|
933
916
|
#
|
@@ -964,32 +947,27 @@ module Orb
|
|
964
947
|
# @return [Float]
|
965
948
|
required :usage_discount, Float
|
966
949
|
|
967
|
-
# @!
|
968
|
-
#
|
969
|
-
#
|
970
|
-
#
|
971
|
-
#
|
972
|
-
#
|
973
|
-
#
|
974
|
-
#
|
975
|
-
#
|
976
|
-
#
|
977
|
-
#
|
978
|
-
#
|
979
|
-
#
|
980
|
-
#
|
981
|
-
#
|
982
|
-
#
|
983
|
-
#
|
984
|
-
# super
|
985
|
-
# end
|
986
|
-
|
987
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
950
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
951
|
+
# Some parameter documentations has been truncated, see
|
952
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Usage}
|
953
|
+
# for more details.
|
954
|
+
#
|
955
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
956
|
+
#
|
957
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
958
|
+
#
|
959
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
960
|
+
#
|
961
|
+
# @param start_date [Time] The start date of the discount interval.
|
962
|
+
#
|
963
|
+
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
964
|
+
# ...
|
965
|
+
#
|
966
|
+
# @param discount_type [Symbol, :usage]
|
988
967
|
end
|
989
968
|
|
990
|
-
# @!
|
991
|
-
#
|
992
|
-
# def self.variants; end
|
969
|
+
# @!method self.variants
|
970
|
+
# @return [Array(Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Amount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Percentage, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Usage)]
|
993
971
|
end
|
994
972
|
|
995
973
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -1013,15 +991,11 @@ module Orb
|
|
1013
991
|
# @return [Time]
|
1014
992
|
required :start_date, Time
|
1015
993
|
|
1016
|
-
# @!
|
1017
|
-
#
|
1018
|
-
#
|
1019
|
-
#
|
1020
|
-
#
|
1021
|
-
# #
|
1022
|
-
# def initialize(end_date:, price_id:, quantity:, start_date:, **) = super
|
1023
|
-
|
1024
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
994
|
+
# @!method initialize(end_date:, price_id:, quantity:, start_date:)
|
995
|
+
# @param end_date [Time, nil]
|
996
|
+
# @param price_id [String]
|
997
|
+
# @param quantity [Float]
|
998
|
+
# @param start_date [Time]
|
1025
999
|
end
|
1026
1000
|
|
1027
1001
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
@@ -1056,16 +1030,21 @@ module Orb
|
|
1056
1030
|
# @return [Time]
|
1057
1031
|
required :start_date, Time
|
1058
1032
|
|
1059
|
-
# @!
|
1060
|
-
#
|
1061
|
-
#
|
1062
|
-
#
|
1063
|
-
#
|
1064
|
-
#
|
1065
|
-
#
|
1066
|
-
#
|
1067
|
-
|
1068
|
-
#
|
1033
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
|
1034
|
+
# Some parameter documentations has been truncated, see
|
1035
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::MaximumInterval}
|
1036
|
+
# for more details.
|
1037
|
+
#
|
1038
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
|
1039
|
+
#
|
1040
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
|
1041
|
+
#
|
1042
|
+
# @param end_date [Time, nil] The end date of the maximum interval.
|
1043
|
+
#
|
1044
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
|
1045
|
+
# ...
|
1046
|
+
#
|
1047
|
+
# @param start_date [Time] The start date of the maximum interval.
|
1069
1048
|
end
|
1070
1049
|
|
1071
1050
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
@@ -1100,16 +1079,21 @@ module Orb
|
|
1100
1079
|
# @return [Time]
|
1101
1080
|
required :start_date, Time
|
1102
1081
|
|
1103
|
-
# @!
|
1104
|
-
#
|
1105
|
-
#
|
1106
|
-
#
|
1107
|
-
#
|
1108
|
-
#
|
1109
|
-
#
|
1110
|
-
#
|
1111
|
-
|
1112
|
-
#
|
1082
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
|
1083
|
+
# Some parameter documentations has been truncated, see
|
1084
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::MinimumInterval}
|
1085
|
+
# for more details.
|
1086
|
+
#
|
1087
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
|
1088
|
+
#
|
1089
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
|
1090
|
+
#
|
1091
|
+
# @param end_date [Time, nil] The end date of the minimum interval.
|
1092
|
+
#
|
1093
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
|
1094
|
+
# ...
|
1095
|
+
#
|
1096
|
+
# @param start_date [Time] The start date of the minimum interval.
|
1113
1097
|
end
|
1114
1098
|
|
1115
1099
|
# @see Orb::Models::SubscriptionChangeApplyResponse::Subscription#pending_subscription_change
|
@@ -1119,14 +1103,10 @@ module Orb
|
|
1119
1103
|
# @return [String]
|
1120
1104
|
required :id, String
|
1121
1105
|
|
1122
|
-
# @!
|
1123
|
-
#
|
1124
|
-
#
|
1125
|
-
#
|
1126
|
-
# #
|
1127
|
-
# def initialize(id:, **) = super
|
1128
|
-
|
1129
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1106
|
+
# @!method initialize(id:)
|
1107
|
+
# A pending subscription change if one exists on this subscription.
|
1108
|
+
#
|
1109
|
+
# @param id [String]
|
1130
1110
|
end
|
1131
1111
|
|
1132
1112
|
class PriceInterval < Orb::Internal::Type::BaseModel
|
@@ -1191,7 +1171,7 @@ module Orb
|
|
1191
1171
|
# For more on the types of prices, see
|
1192
1172
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1193
1173
|
#
|
1194
|
-
# @return [Orb::Models::Price::
|
1174
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
|
1195
1175
|
required :price, union: -> { Orb::Models::Price }
|
1196
1176
|
|
1197
1177
|
# @!attribute start_date
|
@@ -1208,39 +1188,41 @@ module Orb
|
|
1208
1188
|
# @return [Array<String>, nil]
|
1209
1189
|
required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
1210
1190
|
|
1211
|
-
# @!
|
1212
|
-
#
|
1213
|
-
#
|
1214
|
-
#
|
1215
|
-
#
|
1216
|
-
#
|
1217
|
-
#
|
1218
|
-
#
|
1219
|
-
#
|
1220
|
-
#
|
1221
|
-
#
|
1222
|
-
#
|
1223
|
-
#
|
1224
|
-
#
|
1225
|
-
#
|
1226
|
-
#
|
1227
|
-
#
|
1228
|
-
#
|
1229
|
-
#
|
1230
|
-
#
|
1231
|
-
#
|
1232
|
-
#
|
1233
|
-
#
|
1234
|
-
#
|
1235
|
-
#
|
1236
|
-
#
|
1237
|
-
#
|
1238
|
-
#
|
1239
|
-
#
|
1240
|
-
#
|
1241
|
-
#
|
1242
|
-
|
1243
|
-
#
|
1191
|
+
# @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:)
|
1192
|
+
# Some parameter documentations has been truncated, see
|
1193
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval} for
|
1194
|
+
# more details.
|
1195
|
+
#
|
1196
|
+
# The Price Interval resource represents a period of time for which a price will
|
1197
|
+
# bill on a subscription. A subscription’s price intervals define its billing
|
1198
|
+
# behavior.
|
1199
|
+
#
|
1200
|
+
# @param id [String]
|
1201
|
+
#
|
1202
|
+
# @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
|
1203
|
+
#
|
1204
|
+
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
1205
|
+
# ...
|
1206
|
+
#
|
1207
|
+
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
1208
|
+
# ...
|
1209
|
+
#
|
1210
|
+
# @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
|
1211
|
+
# ...
|
1212
|
+
#
|
1213
|
+
# @param filter [String, nil] An additional filter to apply to usage queries.
|
1214
|
+
#
|
1215
|
+
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1216
|
+
# ...
|
1217
|
+
#
|
1218
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1219
|
+
# ...
|
1220
|
+
#
|
1221
|
+
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1222
|
+
# ...
|
1223
|
+
#
|
1224
|
+
# @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
|
1225
|
+
# ...
|
1244
1226
|
|
1245
1227
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1246
1228
|
# @!attribute effective_date
|
@@ -1258,14 +1240,10 @@ module Orb
|
|
1258
1240
|
# @return [Integer]
|
1259
1241
|
required :quantity, Integer
|
1260
1242
|
|
1261
|
-
# @!
|
1262
|
-
#
|
1263
|
-
#
|
1264
|
-
#
|
1265
|
-
# #
|
1266
|
-
# def initialize(effective_date:, price_id:, quantity:, **) = super
|
1267
|
-
|
1268
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1243
|
+
# @!method initialize(effective_date:, price_id:, quantity:)
|
1244
|
+
# @param effective_date [Time]
|
1245
|
+
# @param price_id [String]
|
1246
|
+
# @param quantity [Integer]
|
1269
1247
|
end
|
1270
1248
|
end
|
1271
1249
|
|
@@ -1286,14 +1264,10 @@ module Orb
|
|
1286
1264
|
# @return [Time]
|
1287
1265
|
required :start_date, Time
|
1288
1266
|
|
1289
|
-
# @!
|
1290
|
-
#
|
1291
|
-
#
|
1292
|
-
#
|
1293
|
-
# #
|
1294
|
-
# def initialize(coupon_id:, end_date:, start_date:, **) = super
|
1295
|
-
|
1296
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1267
|
+
# @!method initialize(coupon_id:, end_date:, start_date:)
|
1268
|
+
# @param coupon_id [String]
|
1269
|
+
# @param end_date [Time, nil]
|
1270
|
+
# @param start_date [Time]
|
1297
1271
|
end
|
1298
1272
|
|
1299
1273
|
# @see Orb::Models::SubscriptionChangeApplyResponse::Subscription#status
|
@@ -1304,11 +1278,8 @@ module Orb
|
|
1304
1278
|
ENDED = :ended
|
1305
1279
|
UPCOMING = :upcoming
|
1306
1280
|
|
1307
|
-
|
1308
|
-
|
1309
|
-
# @!parse
|
1310
|
-
# # @return [Array<Symbol>]
|
1311
|
-
# def self.values; end
|
1281
|
+
# @!method self.values
|
1282
|
+
# @return [Array<Symbol>]
|
1312
1283
|
end
|
1313
1284
|
|
1314
1285
|
# @see Orb::Models::SubscriptionChangeApplyResponse::Subscription#trial_info
|
@@ -1318,12 +1289,8 @@ module Orb
|
|
1318
1289
|
# @return [Time, nil]
|
1319
1290
|
required :end_date, Time, nil?: true
|
1320
1291
|
|
1321
|
-
# @!
|
1322
|
-
#
|
1323
|
-
# #
|
1324
|
-
# def initialize(end_date:, **) = super
|
1325
|
-
|
1326
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1292
|
+
# @!method initialize(end_date:)
|
1293
|
+
# @param end_date [Time, nil]
|
1327
1294
|
end
|
1328
1295
|
|
1329
1296
|
# @see Orb::Models::SubscriptionChangeApplyResponse::Subscription#changed_resources
|
@@ -1352,19 +1319,18 @@ module Orb
|
|
1352
1319
|
# @return [Array<Orb::Models::Invoice>]
|
1353
1320
|
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
|
1354
1321
|
|
1355
|
-
# @!
|
1356
|
-
#
|
1357
|
-
#
|
1358
|
-
#
|
1359
|
-
#
|
1360
|
-
#
|
1361
|
-
#
|
1362
|
-
#
|
1363
|
-
#
|
1364
|
-
#
|
1365
|
-
#
|
1366
|
-
|
1367
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1322
|
+
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
1323
|
+
# The resources that were changed as part of this operation. Only present when
|
1324
|
+
# fetched through the subscription changes API or if the
|
1325
|
+
# `include_changed_resources` parameter was passed in the request.
|
1326
|
+
#
|
1327
|
+
# @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
|
1328
|
+
#
|
1329
|
+
# @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
|
1330
|
+
#
|
1331
|
+
# @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
|
1332
|
+
#
|
1333
|
+
# @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
|
1368
1334
|
end
|
1369
1335
|
end
|
1370
1336
|
end
|