orb-billing 0.1.0.pre.alpha.38 → 0.1.0.pre.alpha.39
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/README.md +1 -1
- data/lib/orb/client.rb +4 -0
- data/lib/orb/internal/transport/base_client.rb +1 -1
- data/lib/orb/internal/transport/pooled_net_requester.rb +1 -1
- data/lib/orb/internal/type/base_model.rb +14 -17
- data/lib/orb/internal/type/converter.rb +20 -22
- data/lib/orb/internal/type/enum.rb +8 -8
- data/lib/orb/internal/util.rb +1 -5
- data/lib/orb/models/alert.rb +9 -9
- data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
- data/lib/orb/models/alert_list_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +1 -1
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +7 -7
- data/lib/orb/models/coupon_create_params.rb +2 -2
- data/lib/orb/models/coupon_list_params.rb +2 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
- data/lib/orb/models/credit_note.rb +1 -1
- data/lib/orb/models/credit_note_list_params.rb +5 -5
- data/lib/orb/models/customer.rb +232 -232
- data/lib/orb/models/customer_create_params.rb +223 -223
- data/lib/orb/models/customer_list_params.rb +5 -5
- data/lib/orb/models/customer_update_by_external_id_params.rb +224 -224
- data/lib/orb/models/customer_update_params.rb +224 -224
- data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
- data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/cost_list_params.rb +6 -6
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/credit_list_params.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +20 -20
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +20 -20
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +7 -7
- data/lib/orb/models/dimensional_price_group.rb +7 -7
- data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
- data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +7 -7
- data/lib/orb/models/event_ingest_response.rb +4 -4
- data/lib/orb/models/event_search_params.rb +5 -5
- data/lib/orb/models/event_search_response.rb +8 -8
- data/lib/orb/models/event_update_params.rb +4 -4
- data/lib/orb/models/events/backfill_close_response.rb +7 -7
- data/lib/orb/models/events/backfill_create_params.rb +11 -11
- data/lib/orb/models/events/backfill_create_response.rb +7 -7
- data/lib/orb/models/events/backfill_fetch_response.rb +7 -7
- data/lib/orb/models/events/backfill_list_params.rb +1 -1
- data/lib/orb/models/events/backfill_list_response.rb +7 -7
- data/lib/orb/models/events/backfill_revert_response.rb +7 -7
- data/lib/orb/models/events/event_volumes.rb +1 -1
- data/lib/orb/models/events/volume_list_params.rb +7 -7
- data/lib/orb/models/invoice.rb +270 -270
- data/lib/orb/models/invoice_create_params.rb +12 -11
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +266 -266
- data/lib/orb/models/invoice_issue_params.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +27 -27
- data/lib/orb/models/invoice_list_params.rb +12 -12
- data/lib/orb/models/invoice_update_params.rb +2 -2
- data/lib/orb/models/item.rb +2 -2
- data/lib/orb/models/item_list_params.rb +1 -1
- data/lib/orb/models/metric_create_params.rb +2 -2
- data/lib/orb/models/metric_list_params.rb +5 -5
- data/lib/orb/models/metric_update_params.rb +2 -2
- data/lib/orb/models/percentage_discount.rb +2 -2
- data/lib/orb/models/plan.rb +35 -35
- data/lib/orb/models/plan_create_params.rb +267 -267
- data/lib/orb/models/plan_list_params.rb +5 -5
- data/lib/orb/models/plan_update_params.rb +4 -4
- data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
- data/lib/orb/models/price.rb +158 -158
- data/lib/orb/models/price_create_params.rb +20 -20
- data/lib/orb/models/price_evaluate_params.rb +4 -4
- data/lib/orb/models/price_list_params.rb +1 -1
- data/lib/orb/models/price_update_params.rb +2 -2
- data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
- data/lib/orb/models/subscription.rb +114 -87
- data/lib/orb/models/subscription_cancel_params.rb +3 -3
- data/lib/orb/models/subscription_cancel_response.rb +150 -72
- data/lib/orb/models/subscription_change_apply_params.rb +33 -0
- data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
- data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
- data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
- data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
- data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
- data/lib/orb/models/subscription_create_params.rb +641 -641
- data/lib/orb/models/subscription_create_response.rb +150 -72
- data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
- data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
- data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
- data/lib/orb/models/subscription_list_params.rb +5 -5
- data/lib/orb/models/subscription_price_intervals_params.rb +323 -323
- data/lib/orb/models/subscription_price_intervals_response.rb +152 -72
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +651 -651
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +152 -72
- data/lib/orb/models/subscription_trigger_phase_params.rb +3 -3
- data/lib/orb/models/subscription_trigger_phase_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +153 -73
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +152 -72
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -8
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +152 -72
- data/lib/orb/models/subscription_update_params.rb +10 -10
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +152 -72
- data/lib/orb/models/trial_discount.rb +1 -1
- data/lib/orb/models/usage_discount.rb +2 -2
- data/lib/orb/request_options.rb +7 -7
- data/lib/orb/resources/alerts.rb +38 -38
- data/lib/orb/resources/coupons/subscriptions.rb +3 -3
- data/lib/orb/resources/coupons.rb +9 -9
- data/lib/orb/resources/credit_notes.rb +8 -8
- data/lib/orb/resources/customers/balance_transactions.rb +26 -26
- data/lib/orb/resources/customers/costs.rb +232 -232
- data/lib/orb/resources/customers/credits/ledger.rb +344 -344
- data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
- data/lib/orb/resources/customers/credits.rb +8 -8
- data/lib/orb/resources/customers.rb +59 -59
- data/lib/orb/resources/dimensional_price_groups.rb +6 -6
- data/lib/orb/resources/events/backfills.rb +49 -49
- data/lib/orb/resources/events/volume.rb +10 -10
- data/lib/orb/resources/events.rb +295 -295
- data/lib/orb/resources/invoice_line_items.rb +1 -1
- data/lib/orb/resources/invoices.rb +38 -38
- data/lib/orb/resources/items.rb +1 -1
- data/lib/orb/resources/metrics.rb +11 -11
- data/lib/orb/resources/plans/external_plan_id.rb +14 -14
- data/lib/orb/resources/plans.rb +22 -22
- data/lib/orb/resources/prices/external_price_id.rb +4 -4
- data/lib/orb/resources/prices.rb +30 -30
- data/lib/orb/resources/subscription_changes.rb +87 -0
- data/lib/orb/resources/subscriptions.rb +813 -813
- data/lib/orb/resources/top_level.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +7 -0
- data/rbi/lib/orb/client.rbi +5 -4
- data/rbi/lib/orb/errors.rbi +3 -6
- data/rbi/lib/orb/internal/page.rbi +3 -6
- data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
- data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +7 -13
- data/rbi/lib/orb/internal/type/array_of.rbi +8 -16
- data/rbi/lib/orb/internal/type/base_model.rbi +45 -64
- data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
- data/rbi/lib/orb/internal/type/boolean.rbi +4 -8
- data/rbi/lib/orb/internal/type/converter.rbi +25 -31
- data/rbi/lib/orb/internal/type/enum.rbi +14 -20
- data/rbi/lib/orb/internal/type/hash_of.rbi +8 -16
- data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
- data/rbi/lib/orb/internal/type/union.rbi +10 -20
- data/rbi/lib/orb/internal/type/unknown.rbi +4 -8
- data/rbi/lib/orb/internal/util.rbi +34 -68
- data/rbi/lib/orb/internal.rbi +1 -1
- data/rbi/lib/orb/models/alert.rbi +21 -33
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
- data/rbi/lib/orb/models/amount_discount.rbi +4 -7
- data/rbi/lib/orb/models/billable_metric.rbi +10 -13
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
- data/rbi/lib/orb/models/coupon.rbi +9 -11
- data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
- data/rbi/lib/orb/models/credit_note.rbi +22 -45
- data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer.rbi +256 -281
- data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
- data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
- data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
- data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
- data/rbi/lib/orb/models/discount.rbi +1 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
- data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
- data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
- data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
- data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
- data/rbi/lib/orb/models/event_search_params.rbi +7 -9
- data/rbi/lib/orb/models/event_search_response.rbi +11 -14
- data/rbi/lib/orb/models/event_update_params.rbi +5 -6
- data/rbi/lib/orb/models/event_update_response.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
- data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
- data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
- data/rbi/lib/orb/models/invoice.rbi +388 -465
- data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
- data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
- data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
- data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
- data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
- data/rbi/lib/orb/models/item.rbi +7 -12
- data/rbi/lib/orb/models/item_create_params.rbi +2 -4
- data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/item_list_params.rbi +3 -5
- data/rbi/lib/orb/models/item_update_params.rbi +5 -10
- data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
- data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
- data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
- data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
- data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
- data/rbi/lib/orb/models/plan.rbi +180 -219
- data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
- data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
- data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
- data/rbi/lib/orb/models/price.rbi +827 -1494
- data/rbi/lib/orb/models/price_create_params.rbi +60 -101
- data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
- data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
- data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/price_list_params.rbi +3 -5
- data/rbi/lib/orb/models/price_update_params.rbi +4 -6
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
- data/rbi/lib/orb/models/subscription.rbi +167 -187
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
- data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
- data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
- data/rbi/lib/orb/models/subscriptions.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
- data/rbi/lib/orb/models/trial_discount.rbi +4 -8
- data/rbi/lib/orb/models/usage_discount.rbi +5 -8
- data/rbi/lib/orb/request_options.rbi +9 -11
- data/rbi/lib/orb/resources/alerts.rbi +44 -60
- data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
- data/rbi/lib/orb/resources/coupons.rbi +18 -25
- data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
- data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
- data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
- data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
- data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
- data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
- data/rbi/lib/orb/resources/customers.rbi +407 -417
- data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
- data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
- data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
- data/rbi/lib/orb/resources/events/volume.rbi +19 -22
- data/rbi/lib/orb/resources/events.rbi +311 -319
- data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
- data/rbi/lib/orb/resources/invoices.rbi +62 -76
- data/rbi/lib/orb/resources/items.rbi +7 -14
- data/rbi/lib/orb/resources/metrics.rbi +17 -25
- data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
- data/rbi/lib/orb/resources/plans.rbi +63 -71
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
- data/rbi/lib/orb/resources/prices.rbi +77 -87
- data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
- data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
- data/rbi/lib/orb/resources/top_level.rbi +6 -8
- data/sig/orb/client.rbs +2 -0
- data/sig/orb/models/subscription.rbs +14 -0
- data/sig/orb/models/subscription_cancel_response.rbs +47 -2
- data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
- data/sig/orb/models/subscription_create_response.rbs +47 -2
- data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
- data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
- data/sig/orb/resources/customers.rbs +2 -2
- data/sig/orb/resources/subscription_changes.rbs +24 -0
- metadata +23 -2
|
@@ -13,17 +13,17 @@ module Orb
|
|
|
13
13
|
attr_reader :balance_transactions
|
|
14
14
|
|
|
15
15
|
# This operation is used to create an Orb customer, who is party to the core
|
|
16
|
-
#
|
|
17
|
-
#
|
|
16
|
+
# billing relationship. See [Customer](/core-concepts##customer) for an overview
|
|
17
|
+
# of the customer resource.
|
|
18
18
|
#
|
|
19
|
-
#
|
|
19
|
+
# This endpoint is critical in the following Orb functionality:
|
|
20
20
|
#
|
|
21
|
-
#
|
|
22
|
-
#
|
|
23
|
-
#
|
|
24
|
-
#
|
|
25
|
-
#
|
|
26
|
-
#
|
|
21
|
+
# - Automated charges can be configured by setting `payment_provider` and
|
|
22
|
+
# `payment_provider_id` to automatically issue invoices
|
|
23
|
+
# - [Customer ID Aliases](/events-and-metrics/customer-aliases) can be configured
|
|
24
|
+
# by setting `external_customer_id`
|
|
25
|
+
# - [Timezone localization](/essentials/timezones) can be configured on a
|
|
26
|
+
# per-customer basis by setting the `timezone` parameter
|
|
27
27
|
sig do
|
|
28
28
|
params(
|
|
29
29
|
email: String,
|
|
@@ -56,163 +56,161 @@ module Orb
|
|
|
56
56
|
end
|
|
57
57
|
def create(
|
|
58
58
|
# A valid customer email, to be used for notifications. When Orb triggers payment
|
|
59
|
-
#
|
|
60
|
-
#
|
|
59
|
+
# through a payment gateway, this email will be used for any automatically issued
|
|
60
|
+
# receipts.
|
|
61
61
|
email:,
|
|
62
62
|
# The full name of the customer
|
|
63
63
|
name:,
|
|
64
64
|
accounting_sync_configuration: nil,
|
|
65
65
|
# Additional email addresses for this customer. If populated, these email
|
|
66
|
-
#
|
|
66
|
+
# addresses will be CC'd for customer communications.
|
|
67
67
|
additional_emails: nil,
|
|
68
68
|
# Used to determine if invoices for this customer will automatically attempt to
|
|
69
|
-
#
|
|
70
|
-
#
|
|
69
|
+
# charge a saved payment method, if available. This parameter defaults to `True`
|
|
70
|
+
# when a payment provider is provided on customer creation.
|
|
71
71
|
auto_collection: nil,
|
|
72
72
|
billing_address: nil,
|
|
73
73
|
# An ISO 4217 currency string used for the customer's invoices and balance. If not
|
|
74
|
-
#
|
|
74
|
+
# set at creation time, will be set at subscription creation time.
|
|
75
75
|
currency: nil,
|
|
76
76
|
email_delivery: nil,
|
|
77
77
|
# An optional user-defined ID for this customer resource, used throughout the
|
|
78
|
-
#
|
|
79
|
-
#
|
|
78
|
+
# system as an alias for this Customer. Use this field to identify a customer by
|
|
79
|
+
# an existing identifier in your system.
|
|
80
80
|
external_customer_id: nil,
|
|
81
81
|
# The hierarchical relationships for this customer.
|
|
82
82
|
hierarchy: nil,
|
|
83
83
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
|
84
|
-
#
|
|
85
|
-
#
|
|
84
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
85
|
+
# by setting `metadata` to `null`.
|
|
86
86
|
metadata: nil,
|
|
87
87
|
# This is used for creating charges or invoices in an external system via Orb.
|
|
88
|
-
#
|
|
89
|
-
#
|
|
88
|
+
# When not in test mode, the connection must first be configured in the Orb
|
|
89
|
+
# webapp.
|
|
90
90
|
payment_provider: nil,
|
|
91
91
|
# The ID of this customer in an external payments solution, such as Stripe. This
|
|
92
|
-
#
|
|
92
|
+
# is used for creating charges or invoices in the external system via Orb.
|
|
93
93
|
payment_provider_id: nil,
|
|
94
94
|
reporting_configuration: nil,
|
|
95
95
|
shipping_address: nil,
|
|
96
96
|
tax_configuration: nil,
|
|
97
97
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
98
|
-
#
|
|
98
|
+
# added to the headers of invoices.
|
|
99
99
|
#
|
|
100
|
-
#
|
|
100
|
+
# ### Supported Tax ID Countries and Types
|
|
101
101
|
#
|
|
102
|
-
#
|
|
103
|
-
#
|
|
104
|
-
#
|
|
105
|
-
#
|
|
106
|
-
#
|
|
107
|
-
#
|
|
108
|
-
#
|
|
109
|
-
#
|
|
110
|
-
#
|
|
111
|
-
#
|
|
112
|
-
#
|
|
113
|
-
#
|
|
114
|
-
#
|
|
115
|
-
#
|
|
116
|
-
#
|
|
117
|
-
#
|
|
118
|
-
#
|
|
119
|
-
#
|
|
120
|
-
#
|
|
121
|
-
#
|
|
122
|
-
#
|
|
123
|
-
#
|
|
124
|
-
#
|
|
125
|
-
#
|
|
126
|
-
#
|
|
127
|
-
#
|
|
128
|
-
#
|
|
129
|
-
#
|
|
130
|
-
#
|
|
131
|
-
#
|
|
132
|
-
#
|
|
133
|
-
#
|
|
134
|
-
#
|
|
135
|
-
#
|
|
136
|
-
#
|
|
137
|
-
#
|
|
138
|
-
#
|
|
139
|
-
#
|
|
140
|
-
#
|
|
141
|
-
#
|
|
142
|
-
#
|
|
143
|
-
#
|
|
144
|
-
#
|
|
145
|
-
#
|
|
146
|
-
#
|
|
147
|
-
#
|
|
148
|
-
#
|
|
149
|
-
#
|
|
150
|
-
#
|
|
151
|
-
#
|
|
152
|
-
#
|
|
153
|
-
#
|
|
154
|
-
#
|
|
155
|
-
#
|
|
156
|
-
#
|
|
157
|
-
#
|
|
158
|
-
#
|
|
159
|
-
#
|
|
160
|
-
#
|
|
161
|
-
#
|
|
162
|
-
#
|
|
163
|
-
#
|
|
164
|
-
#
|
|
165
|
-
#
|
|
166
|
-
#
|
|
167
|
-
#
|
|
168
|
-
#
|
|
169
|
-
#
|
|
170
|
-
#
|
|
171
|
-
#
|
|
172
|
-
#
|
|
173
|
-
#
|
|
174
|
-
#
|
|
175
|
-
#
|
|
176
|
-
#
|
|
177
|
-
#
|
|
178
|
-
#
|
|
179
|
-
#
|
|
180
|
-
#
|
|
181
|
-
#
|
|
182
|
-
#
|
|
183
|
-
#
|
|
184
|
-
#
|
|
185
|
-
#
|
|
186
|
-
#
|
|
187
|
-
#
|
|
188
|
-
#
|
|
189
|
-
#
|
|
190
|
-
#
|
|
191
|
-
#
|
|
192
|
-
#
|
|
193
|
-
#
|
|
194
|
-
#
|
|
195
|
-
#
|
|
196
|
-
#
|
|
197
|
-
#
|
|
198
|
-
#
|
|
199
|
-
#
|
|
200
|
-
#
|
|
201
|
-
#
|
|
102
|
+
# | Country | Type | Description |
|
|
103
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
|
104
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
|
105
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
|
106
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
|
107
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
|
108
|
+
# | Austria | `eu_vat` | European VAT Number |
|
|
109
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
|
110
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
|
111
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
|
112
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
|
113
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
|
114
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
|
115
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
|
116
|
+
# | Canada | `ca_bn` | Canadian BN |
|
|
117
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
|
118
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
|
119
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
|
120
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
|
121
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
|
122
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
|
123
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
|
124
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
|
125
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
|
126
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
|
127
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
|
128
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
|
129
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
|
130
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
|
131
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
|
132
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
|
133
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
|
134
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
|
135
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
136
|
+
# | Finland | `eu_vat` | European VAT Number |
|
|
137
|
+
# | France | `eu_vat` | European VAT Number |
|
|
138
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
|
139
|
+
# | Germany | `eu_vat` | European VAT Number |
|
|
140
|
+
# | Greece | `eu_vat` | European VAT Number |
|
|
141
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
142
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
|
143
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
|
144
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
|
145
|
+
# | India | `in_gst` | Indian GST Number |
|
|
146
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
|
147
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
|
148
|
+
# | Israel | `il_vat` | Israel VAT |
|
|
149
|
+
# | Italy | `eu_vat` | European VAT Number |
|
|
150
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
151
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
152
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
153
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
|
154
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
|
155
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
|
156
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
|
157
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
|
158
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
|
159
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
|
160
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
|
161
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
|
162
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
|
163
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
|
164
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
|
165
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
|
166
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
|
167
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
168
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
169
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
|
170
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
171
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
|
172
|
+
# | Poland | `eu_vat` | European VAT Number |
|
|
173
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
|
174
|
+
# | Romania | `eu_vat` | European VAT Number |
|
|
175
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
|
176
|
+
# | Russia | `ru_inn` | Russian INN |
|
|
177
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
|
178
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
|
179
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
|
180
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
|
181
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
|
182
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
|
183
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
|
184
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
|
185
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
|
186
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
|
187
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
188
|
+
# | Spain | `eu_vat` | European VAT Number |
|
|
189
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
|
190
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
|
191
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
|
192
|
+
# | Thailand | `th_vat` | Thai VAT |
|
|
193
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
|
194
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
|
195
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
|
196
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
|
197
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
|
198
|
+
# | United States | `us_ein` | United States EIN |
|
|
199
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
|
200
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
201
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
202
202
|
tax_id: nil,
|
|
203
203
|
# A timezone identifier from the IANA timezone database, such as
|
|
204
|
-
#
|
|
205
|
-
#
|
|
204
|
+
# `"America/Los_Angeles"`. This defaults to your account's timezone if not set.
|
|
205
|
+
# This cannot be changed after customer creation.
|
|
206
206
|
timezone: nil,
|
|
207
207
|
request_options: {}
|
|
208
|
-
)
|
|
209
|
-
end
|
|
210
|
-
|
|
208
|
+
); end
|
|
211
209
|
# This endpoint can be used to update the `payment_provider`,
|
|
212
|
-
#
|
|
213
|
-
#
|
|
214
|
-
#
|
|
215
|
-
#
|
|
210
|
+
# `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`,
|
|
211
|
+
# `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and
|
|
212
|
+
# `additional_emails` of an existing customer. Other fields on a customer are
|
|
213
|
+
# currently immutable.
|
|
216
214
|
sig do
|
|
217
215
|
params(
|
|
218
216
|
customer_id: String,
|
|
@@ -247,160 +245,158 @@ module Orb
|
|
|
247
245
|
customer_id,
|
|
248
246
|
accounting_sync_configuration: nil,
|
|
249
247
|
# Additional email addresses for this customer. If populated, these email
|
|
250
|
-
#
|
|
248
|
+
# addresses will be CC'd for customer communications.
|
|
251
249
|
additional_emails: nil,
|
|
252
250
|
# Used to determine if invoices for this customer will automatically attempt to
|
|
253
|
-
#
|
|
254
|
-
#
|
|
251
|
+
# charge a saved payment method, if available. This parameter defaults to `True`
|
|
252
|
+
# when a payment provider is provided on customer creation.
|
|
255
253
|
auto_collection: nil,
|
|
256
254
|
billing_address: nil,
|
|
257
255
|
# An ISO 4217 currency string used for the customer's invoices and balance. If not
|
|
258
|
-
#
|
|
256
|
+
# set at creation time, will be set at subscription creation time.
|
|
259
257
|
currency: nil,
|
|
260
258
|
# A valid customer email, to be used for invoicing and notifications.
|
|
261
259
|
email: nil,
|
|
262
260
|
email_delivery: nil,
|
|
263
261
|
# The external customer ID. This can only be set if empty and the customer has no
|
|
264
|
-
#
|
|
262
|
+
# past or current subscriptions.
|
|
265
263
|
external_customer_id: nil,
|
|
266
264
|
# The hierarchical relationships for this customer.
|
|
267
265
|
hierarchy: nil,
|
|
268
266
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
|
269
|
-
#
|
|
270
|
-
#
|
|
267
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
268
|
+
# by setting `metadata` to `null`.
|
|
271
269
|
metadata: nil,
|
|
272
270
|
# The full name of the customer
|
|
273
271
|
name: nil,
|
|
274
272
|
# This is used for creating charges or invoices in an external system via Orb.
|
|
275
|
-
#
|
|
273
|
+
# When not in test mode:
|
|
276
274
|
#
|
|
277
|
-
#
|
|
278
|
-
#
|
|
279
|
-
#
|
|
280
|
-
#
|
|
275
|
+
# - the connection must first be configured in the Orb webapp.
|
|
276
|
+
# - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
|
|
277
|
+
# `bill.com`, `netsuite`), any product mappings must first be configured with
|
|
278
|
+
# the Orb team.
|
|
281
279
|
payment_provider: nil,
|
|
282
280
|
# The ID of this customer in an external payments solution, such as Stripe. This
|
|
283
|
-
#
|
|
281
|
+
# is used for creating charges or invoices in the external system via Orb.
|
|
284
282
|
payment_provider_id: nil,
|
|
285
283
|
reporting_configuration: nil,
|
|
286
284
|
shipping_address: nil,
|
|
287
285
|
tax_configuration: nil,
|
|
288
286
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
289
|
-
#
|
|
287
|
+
# added to the headers of invoices.
|
|
290
288
|
#
|
|
291
|
-
#
|
|
289
|
+
# ### Supported Tax ID Countries and Types
|
|
292
290
|
#
|
|
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
|
-
#
|
|
344
|
-
#
|
|
345
|
-
#
|
|
346
|
-
#
|
|
347
|
-
#
|
|
348
|
-
#
|
|
349
|
-
#
|
|
350
|
-
#
|
|
351
|
-
#
|
|
352
|
-
#
|
|
353
|
-
#
|
|
354
|
-
#
|
|
355
|
-
#
|
|
356
|
-
#
|
|
357
|
-
#
|
|
358
|
-
#
|
|
359
|
-
#
|
|
360
|
-
#
|
|
361
|
-
#
|
|
362
|
-
#
|
|
363
|
-
#
|
|
364
|
-
#
|
|
365
|
-
#
|
|
366
|
-
#
|
|
367
|
-
#
|
|
368
|
-
#
|
|
369
|
-
#
|
|
370
|
-
#
|
|
371
|
-
#
|
|
372
|
-
#
|
|
373
|
-
#
|
|
374
|
-
#
|
|
375
|
-
#
|
|
376
|
-
#
|
|
377
|
-
#
|
|
378
|
-
#
|
|
379
|
-
#
|
|
380
|
-
#
|
|
381
|
-
#
|
|
382
|
-
#
|
|
383
|
-
#
|
|
384
|
-
#
|
|
385
|
-
#
|
|
386
|
-
#
|
|
387
|
-
#
|
|
388
|
-
#
|
|
389
|
-
#
|
|
390
|
-
#
|
|
391
|
-
#
|
|
392
|
-
#
|
|
291
|
+
# | Country | Type | Description |
|
|
292
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
|
293
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
|
294
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
|
295
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
|
296
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
|
297
|
+
# | Austria | `eu_vat` | European VAT Number |
|
|
298
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
|
299
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
|
300
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
|
301
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
|
302
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
|
303
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
|
304
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
|
305
|
+
# | Canada | `ca_bn` | Canadian BN |
|
|
306
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
|
307
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
|
308
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
|
309
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
|
310
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
|
311
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
|
312
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
|
313
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
|
314
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
|
315
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
|
316
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
|
317
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
|
318
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
|
319
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
|
320
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
|
321
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
|
322
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
|
323
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
|
324
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
325
|
+
# | Finland | `eu_vat` | European VAT Number |
|
|
326
|
+
# | France | `eu_vat` | European VAT Number |
|
|
327
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
|
328
|
+
# | Germany | `eu_vat` | European VAT Number |
|
|
329
|
+
# | Greece | `eu_vat` | European VAT Number |
|
|
330
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
331
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
|
332
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
|
333
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
|
334
|
+
# | India | `in_gst` | Indian GST Number |
|
|
335
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
|
336
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
|
337
|
+
# | Israel | `il_vat` | Israel VAT |
|
|
338
|
+
# | Italy | `eu_vat` | European VAT Number |
|
|
339
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
340
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
341
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
342
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
|
343
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
|
344
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
|
345
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
|
346
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
|
347
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
|
348
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
|
349
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
|
350
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
|
351
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
|
352
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
|
353
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
|
354
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
|
355
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
|
356
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
357
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
358
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
|
359
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
360
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
|
361
|
+
# | Poland | `eu_vat` | European VAT Number |
|
|
362
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
|
363
|
+
# | Romania | `eu_vat` | European VAT Number |
|
|
364
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
|
365
|
+
# | Russia | `ru_inn` | Russian INN |
|
|
366
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
|
367
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
|
368
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
|
369
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
|
370
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
|
371
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
|
372
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
|
373
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
|
374
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
|
375
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
|
376
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
377
|
+
# | Spain | `eu_vat` | European VAT Number |
|
|
378
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
|
379
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
|
380
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
|
381
|
+
# | Thailand | `th_vat` | Thai VAT |
|
|
382
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
|
383
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
|
384
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
|
385
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
|
386
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
|
387
|
+
# | United States | `us_ein` | United States EIN |
|
|
388
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
|
389
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
390
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
393
391
|
tax_id: nil,
|
|
394
392
|
request_options: {}
|
|
395
|
-
)
|
|
396
|
-
end
|
|
397
|
-
|
|
393
|
+
); end
|
|
398
394
|
# This endpoint returns a list of all customers for an account. The list of
|
|
399
|
-
#
|
|
400
|
-
#
|
|
401
|
-
#
|
|
395
|
+
# customers is ordered starting from the most recently created customer. This
|
|
396
|
+
# endpoint follows Orb's
|
|
397
|
+
# [standardized pagination format](/api-reference/pagination).
|
|
402
398
|
#
|
|
403
|
-
#
|
|
399
|
+
# See [Customer](/core-concepts##customer) for an overview of the customer model.
|
|
404
400
|
sig do
|
|
405
401
|
params(
|
|
406
402
|
created_at_gt: T.nilable(Time),
|
|
@@ -419,29 +415,27 @@ module Orb
|
|
|
419
415
|
created_at_lt: nil,
|
|
420
416
|
created_at_lte: nil,
|
|
421
417
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
|
422
|
-
#
|
|
418
|
+
# from the initial request.
|
|
423
419
|
cursor: nil,
|
|
424
420
|
# The number of items to fetch. Defaults to 20.
|
|
425
421
|
limit: nil,
|
|
426
422
|
request_options: {}
|
|
427
|
-
)
|
|
428
|
-
end
|
|
429
|
-
|
|
423
|
+
); end
|
|
430
424
|
# This performs a deletion of this customer, its subscriptions, and its invoices,
|
|
431
|
-
#
|
|
432
|
-
#
|
|
433
|
-
#
|
|
434
|
-
#
|
|
425
|
+
# provided the customer does not have any issued invoices. Customers with issued
|
|
426
|
+
# invoices cannot be deleted. This operation is irreversible. Note that this is a
|
|
427
|
+
# _soft_ deletion, but the data will be inaccessible through the API and Orb
|
|
428
|
+
# dashboard.
|
|
435
429
|
#
|
|
436
|
-
#
|
|
430
|
+
# For a hard-deletion, please reach out to the Orb team directly.
|
|
437
431
|
#
|
|
438
|
-
#
|
|
439
|
-
#
|
|
440
|
-
#
|
|
441
|
-
#
|
|
442
|
-
#
|
|
432
|
+
# **Note**: This operation happens asynchronously and can be expected to take a
|
|
433
|
+
# few minutes to propagate to related resources. However, querying for the
|
|
434
|
+
# customer on subsequent GET requests while deletion is in process will reflect
|
|
435
|
+
# its deletion with a `deleted: true` property. Once the customer deletion has
|
|
436
|
+
# been fully processed, the customer will not be returned in the API.
|
|
443
437
|
#
|
|
444
|
-
#
|
|
438
|
+
# On successful processing, this returns an empty dictionary (`{}`) in the API.
|
|
445
439
|
sig do
|
|
446
440
|
params(
|
|
447
441
|
customer_id: String,
|
|
@@ -449,15 +443,14 @@ module Orb
|
|
|
449
443
|
)
|
|
450
444
|
.void
|
|
451
445
|
end
|
|
452
|
-
def delete(customer_id, request_options: {})
|
|
453
|
-
end
|
|
446
|
+
def delete(customer_id, request_options: {}); end
|
|
454
447
|
|
|
455
448
|
# This endpoint is used to fetch customer details given an identifier. If the
|
|
456
|
-
#
|
|
457
|
-
#
|
|
449
|
+
# `Customer` is in the process of being deleted, only the properties `id` and
|
|
450
|
+
# `deleted: true` will be returned.
|
|
458
451
|
#
|
|
459
|
-
#
|
|
460
|
-
#
|
|
452
|
+
# See the [Customer resource](/core-concepts#customer) for a full discussion of
|
|
453
|
+
# the Customer model.
|
|
461
454
|
sig do
|
|
462
455
|
params(
|
|
463
456
|
customer_id: String,
|
|
@@ -465,14 +458,13 @@ module Orb
|
|
|
465
458
|
)
|
|
466
459
|
.returns(Orb::Models::Customer)
|
|
467
460
|
end
|
|
468
|
-
def fetch(customer_id, request_options: {})
|
|
469
|
-
end
|
|
461
|
+
def fetch(customer_id, request_options: {}); end
|
|
470
462
|
|
|
471
463
|
# This endpoint is used to fetch customer details given an `external_customer_id`
|
|
472
|
-
#
|
|
464
|
+
# (see [Customer ID Aliases](/events-and-metrics/customer-aliases)).
|
|
473
465
|
#
|
|
474
|
-
#
|
|
475
|
-
#
|
|
466
|
+
# Note that the resource and semantics of this endpoint exactly mirror
|
|
467
|
+
# [Get Customer](fetch-customer).
|
|
476
468
|
sig do
|
|
477
469
|
params(
|
|
478
470
|
external_customer_id: String,
|
|
@@ -480,45 +472,46 @@ module Orb
|
|
|
480
472
|
)
|
|
481
473
|
.returns(Orb::Models::Customer)
|
|
482
474
|
end
|
|
483
|
-
def fetch_by_external_id(external_customer_id, request_options: {})
|
|
484
|
-
end
|
|
475
|
+
def fetch_by_external_id(external_customer_id, request_options: {}); end
|
|
485
476
|
|
|
486
477
|
# Sync Orb's payment methods for the customer with their gateway.
|
|
487
478
|
#
|
|
488
|
-
#
|
|
489
|
-
#
|
|
479
|
+
# This method can be called before taking an action that may cause the customer to
|
|
480
|
+
# be charged, ensuring that the most up-to-date payment method is charged.
|
|
490
481
|
#
|
|
491
|
-
#
|
|
482
|
+
# **Note**: This functionality is currently only available for Stripe.
|
|
492
483
|
sig do
|
|
493
484
|
params(
|
|
494
|
-
|
|
485
|
+
customer_id: String,
|
|
495
486
|
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
|
496
487
|
)
|
|
497
488
|
.void
|
|
498
489
|
end
|
|
499
|
-
def sync_payment_methods_from_gateway(
|
|
500
|
-
end
|
|
490
|
+
def sync_payment_methods_from_gateway(customer_id, request_options: {}); end
|
|
501
491
|
|
|
502
492
|
# Sync Orb's payment methods for the customer with their gateway.
|
|
503
493
|
#
|
|
504
|
-
#
|
|
505
|
-
#
|
|
494
|
+
# This method can be called before taking an action that may cause the customer to
|
|
495
|
+
# be charged, ensuring that the most up-to-date payment method is charged.
|
|
506
496
|
#
|
|
507
|
-
#
|
|
497
|
+
# **Note**: This functionality is currently only available for Stripe.
|
|
508
498
|
sig do
|
|
509
499
|
params(
|
|
510
|
-
|
|
500
|
+
external_customer_id: String,
|
|
511
501
|
request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
|
|
512
502
|
)
|
|
513
503
|
.void
|
|
514
504
|
end
|
|
515
|
-
def sync_payment_methods_from_gateway_by_external_customer_id(
|
|
505
|
+
def sync_payment_methods_from_gateway_by_external_customer_id(
|
|
506
|
+
external_customer_id,
|
|
507
|
+
request_options: {}
|
|
508
|
+
)
|
|
516
509
|
end
|
|
517
510
|
|
|
518
511
|
# This endpoint is used to update customer details given an `external_customer_id`
|
|
519
|
-
#
|
|
520
|
-
#
|
|
521
|
-
#
|
|
512
|
+
# (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the
|
|
513
|
+
# resource and semantics of this endpoint exactly mirror
|
|
514
|
+
# [Update Customer](update-customer).
|
|
522
515
|
sig do
|
|
523
516
|
params(
|
|
524
517
|
id: String,
|
|
@@ -557,158 +550,155 @@ module Orb
|
|
|
557
550
|
id,
|
|
558
551
|
accounting_sync_configuration: nil,
|
|
559
552
|
# Additional email addresses for this customer. If populated, these email
|
|
560
|
-
#
|
|
553
|
+
# addresses will be CC'd for customer communications.
|
|
561
554
|
additional_emails: nil,
|
|
562
555
|
# Used to determine if invoices for this customer will automatically attempt to
|
|
563
|
-
#
|
|
564
|
-
#
|
|
556
|
+
# charge a saved payment method, if available. This parameter defaults to `True`
|
|
557
|
+
# when a payment provider is provided on customer creation.
|
|
565
558
|
auto_collection: nil,
|
|
566
559
|
billing_address: nil,
|
|
567
560
|
# An ISO 4217 currency string used for the customer's invoices and balance. If not
|
|
568
|
-
#
|
|
561
|
+
# set at creation time, will be set at subscription creation time.
|
|
569
562
|
currency: nil,
|
|
570
563
|
# A valid customer email, to be used for invoicing and notifications.
|
|
571
564
|
email: nil,
|
|
572
565
|
email_delivery: nil,
|
|
573
566
|
# The external customer ID. This can only be set if empty and the customer has no
|
|
574
|
-
#
|
|
567
|
+
# past or current subscriptions.
|
|
575
568
|
external_customer_id: nil,
|
|
576
569
|
# The hierarchical relationships for this customer.
|
|
577
570
|
hierarchy: nil,
|
|
578
571
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
|
579
|
-
#
|
|
580
|
-
#
|
|
572
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
573
|
+
# by setting `metadata` to `null`.
|
|
581
574
|
metadata: nil,
|
|
582
575
|
# The full name of the customer
|
|
583
576
|
name: nil,
|
|
584
577
|
# This is used for creating charges or invoices in an external system via Orb.
|
|
585
|
-
#
|
|
578
|
+
# When not in test mode:
|
|
586
579
|
#
|
|
587
|
-
#
|
|
588
|
-
#
|
|
589
|
-
#
|
|
590
|
-
#
|
|
580
|
+
# - the connection must first be configured in the Orb webapp.
|
|
581
|
+
# - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
|
|
582
|
+
# `bill.com`, `netsuite`), any product mappings must first be configured with
|
|
583
|
+
# the Orb team.
|
|
591
584
|
payment_provider: nil,
|
|
592
585
|
# The ID of this customer in an external payments solution, such as Stripe. This
|
|
593
|
-
#
|
|
586
|
+
# is used for creating charges or invoices in the external system via Orb.
|
|
594
587
|
payment_provider_id: nil,
|
|
595
588
|
reporting_configuration: nil,
|
|
596
589
|
shipping_address: nil,
|
|
597
590
|
tax_configuration: nil,
|
|
598
591
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
599
|
-
#
|
|
592
|
+
# added to the headers of invoices.
|
|
600
593
|
#
|
|
601
|
-
#
|
|
594
|
+
# ### Supported Tax ID Countries and Types
|
|
602
595
|
#
|
|
603
|
-
#
|
|
604
|
-
#
|
|
605
|
-
#
|
|
606
|
-
#
|
|
607
|
-
#
|
|
608
|
-
#
|
|
609
|
-
#
|
|
610
|
-
#
|
|
611
|
-
#
|
|
612
|
-
#
|
|
613
|
-
#
|
|
614
|
-
#
|
|
615
|
-
#
|
|
616
|
-
#
|
|
617
|
-
#
|
|
618
|
-
#
|
|
619
|
-
#
|
|
620
|
-
#
|
|
621
|
-
#
|
|
622
|
-
#
|
|
623
|
-
#
|
|
624
|
-
#
|
|
625
|
-
#
|
|
626
|
-
#
|
|
627
|
-
#
|
|
628
|
-
#
|
|
629
|
-
#
|
|
630
|
-
#
|
|
631
|
-
#
|
|
632
|
-
#
|
|
633
|
-
#
|
|
634
|
-
#
|
|
635
|
-
#
|
|
636
|
-
#
|
|
637
|
-
#
|
|
638
|
-
#
|
|
639
|
-
#
|
|
640
|
-
#
|
|
641
|
-
#
|
|
642
|
-
#
|
|
643
|
-
#
|
|
644
|
-
#
|
|
645
|
-
#
|
|
646
|
-
#
|
|
647
|
-
#
|
|
648
|
-
#
|
|
649
|
-
#
|
|
650
|
-
#
|
|
651
|
-
#
|
|
652
|
-
#
|
|
653
|
-
#
|
|
654
|
-
#
|
|
655
|
-
#
|
|
656
|
-
#
|
|
657
|
-
#
|
|
658
|
-
#
|
|
659
|
-
#
|
|
660
|
-
#
|
|
661
|
-
#
|
|
662
|
-
#
|
|
663
|
-
#
|
|
664
|
-
#
|
|
665
|
-
#
|
|
666
|
-
#
|
|
667
|
-
#
|
|
668
|
-
#
|
|
669
|
-
#
|
|
670
|
-
#
|
|
671
|
-
#
|
|
672
|
-
#
|
|
673
|
-
#
|
|
674
|
-
#
|
|
675
|
-
#
|
|
676
|
-
#
|
|
677
|
-
#
|
|
678
|
-
#
|
|
679
|
-
#
|
|
680
|
-
#
|
|
681
|
-
#
|
|
682
|
-
#
|
|
683
|
-
#
|
|
684
|
-
#
|
|
685
|
-
#
|
|
686
|
-
#
|
|
687
|
-
#
|
|
688
|
-
#
|
|
689
|
-
#
|
|
690
|
-
#
|
|
691
|
-
#
|
|
692
|
-
#
|
|
693
|
-
#
|
|
694
|
-
#
|
|
695
|
-
#
|
|
696
|
-
#
|
|
697
|
-
#
|
|
698
|
-
#
|
|
699
|
-
#
|
|
700
|
-
#
|
|
701
|
-
#
|
|
702
|
-
#
|
|
596
|
+
# | Country | Type | Description |
|
|
597
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
|
598
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
|
599
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
|
600
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
|
601
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
|
602
|
+
# | Austria | `eu_vat` | European VAT Number |
|
|
603
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
|
604
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
|
605
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
|
606
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
|
607
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
|
608
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
|
609
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
|
610
|
+
# | Canada | `ca_bn` | Canadian BN |
|
|
611
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
|
612
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
|
613
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
|
614
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
|
615
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
|
616
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
|
617
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
|
618
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
|
619
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
|
620
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
|
621
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
|
622
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
|
623
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
|
624
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
|
625
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
|
626
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
|
627
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
|
628
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
|
629
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
630
|
+
# | Finland | `eu_vat` | European VAT Number |
|
|
631
|
+
# | France | `eu_vat` | European VAT Number |
|
|
632
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
|
633
|
+
# | Germany | `eu_vat` | European VAT Number |
|
|
634
|
+
# | Greece | `eu_vat` | European VAT Number |
|
|
635
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
636
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
|
637
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
|
638
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
|
639
|
+
# | India | `in_gst` | Indian GST Number |
|
|
640
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
|
641
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
|
642
|
+
# | Israel | `il_vat` | Israel VAT |
|
|
643
|
+
# | Italy | `eu_vat` | European VAT Number |
|
|
644
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
645
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
646
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
647
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
|
648
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
|
649
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
|
650
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
|
651
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
|
652
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
|
653
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
|
654
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
|
655
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
|
656
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
|
657
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
|
658
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
|
659
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
|
660
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
|
661
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
662
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
663
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
|
664
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
665
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
|
666
|
+
# | Poland | `eu_vat` | European VAT Number |
|
|
667
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
|
668
|
+
# | Romania | `eu_vat` | European VAT Number |
|
|
669
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
|
670
|
+
# | Russia | `ru_inn` | Russian INN |
|
|
671
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
|
672
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
|
673
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
|
674
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
|
675
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
|
676
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
|
677
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
|
678
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
|
679
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
|
680
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
|
681
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
682
|
+
# | Spain | `eu_vat` | European VAT Number |
|
|
683
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
|
684
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
|
685
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
|
686
|
+
# | Thailand | `th_vat` | Thai VAT |
|
|
687
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
|
688
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
|
689
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
|
690
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
|
691
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
|
692
|
+
# | United States | `us_ein` | United States EIN |
|
|
693
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
|
694
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
695
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
703
696
|
tax_id: nil,
|
|
704
697
|
request_options: {}
|
|
705
|
-
)
|
|
706
|
-
end
|
|
707
|
-
|
|
698
|
+
); end
|
|
708
699
|
# @api private
|
|
709
700
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
|
710
|
-
def self.new(client:)
|
|
711
|
-
end
|
|
701
|
+
def self.new(client:); end
|
|
712
702
|
end
|
|
713
703
|
end
|
|
714
704
|
end
|