api.md

Shared Types

from orb.types import (
    Address,
    AdjustmentInterval,
    AggregatedCost,
    Allocation,
    AmountDiscount,
    AmountDiscountInterval,
    BillableMetricTiny,
    BillingCycleAnchorConfiguration,
    BillingCycleConfiguration,
    BillingCycleRelativeDate,
    BulkConfig,
    BulkTier,
    ChangedSubscriptionResources,
    ConversionRateTier,
    ConversionRateTieredConfig,
    ConversionRateUnitConfig,
    CouponRedemption,
    CreditNote,
    CreditNoteTiny,
    CustomExpiration,
    CustomerMinified,
    CustomerTaxID,
    DimensionalPriceConfiguration,
    Discount,
    FixedFeeQuantityScheduleEntry,
    FixedFeeQuantityTransition,
    Invoice,
    InvoiceLevelDiscount,
    InvoiceTiny,
    ItemSlim,
    MatrixConfig,
    MatrixSubLineItem,
    MatrixValue,
    MatrixWithAllocationConfig,
    Maximum,
    MaximumInterval,
    Minimum,
    MinimumInterval,
    MonetaryAmountDiscountAdjustment,
    MonetaryMaximumAdjustment,
    MonetaryMinimumAdjustment,
    MonetaryPercentageDiscountAdjustment,
    MonetaryUsageDiscountAdjustment,
    NewAllocationPrice,
    NewAmountDiscount,
    NewBillingCycleConfiguration,
    NewDimensionalPriceConfiguration,
    NewFloatingBulkPrice,
    NewFloatingBulkWithProrationPrice,
    NewFloatingCumulativeGroupedBulkPrice,
    NewFloatingGroupedAllocationPrice,
    NewFloatingGroupedTieredPackagePrice,
    NewFloatingGroupedTieredPrice,
    NewFloatingGroupedWithMeteredMinimumPrice,
    NewFloatingGroupedWithProratedMinimumPrice,
    NewFloatingMatrixPrice,
    NewFloatingMatrixWithAllocationPrice,
    NewFloatingMatrixWithDisplayNamePrice,
    NewFloatingMaxGroupTieredPackagePrice,
    NewFloatingMinimumCompositePrice,
    NewFloatingPackagePrice,
    NewFloatingPackageWithAllocationPrice,
    NewFloatingScalableMatrixWithTieredPricingPrice,
    NewFloatingScalableMatrixWithUnitPricingPrice,
    NewFloatingThresholdTotalAmountPrice,
    NewFloatingTieredPackagePrice,
    NewFloatingTieredPackageWithMinimumPrice,
    NewFloatingTieredPrice,
    NewFloatingTieredWithMinimumPrice,
    NewFloatingTieredWithProrationPrice,
    NewFloatingUnitPrice,
    NewFloatingUnitWithPercentPrice,
    NewFloatingUnitWithProrationPrice,
    NewMaximum,
    NewMinimum,
    NewPercentageDiscount,
    NewPlanBulkPrice,
    NewPlanBulkWithProrationPrice,
    NewPlanCumulativeGroupedBulkPrice,
    NewPlanGroupedAllocationPrice,
    NewPlanGroupedTieredPackagePrice,
    NewPlanGroupedTieredPrice,
    NewPlanGroupedWithMeteredMinimumPrice,
    NewPlanGroupedWithProratedMinimumPrice,
    NewPlanMatrixPrice,
    NewPlanMatrixWithAllocationPrice,
    NewPlanMatrixWithDisplayNamePrice,
    NewPlanMaxGroupTieredPackagePrice,
    NewPlanMinimumCompositePrice,
    NewPlanPackagePrice,
    NewPlanPackageWithAllocationPrice,
    NewPlanScalableMatrixWithTieredPricingPrice,
    NewPlanScalableMatrixWithUnitPricingPrice,
    NewPlanThresholdTotalAmountPrice,
    NewPlanTieredPackagePrice,
    NewPlanTieredPackageWithMinimumPrice,
    NewPlanTieredPrice,
    NewPlanTieredWithMinimumPrice,
    NewPlanUnitPrice,
    NewPlanUnitWithPercentPrice,
    NewPlanUnitWithProrationPrice,
    NewUsageDiscount,
    OtherSubLineItem,
    PackageConfig,
    PaginationMetadata,
    PerPriceCost,
    PercentageDiscount,
    PercentageDiscountInterval,
    PlanPhaseAmountDiscountAdjustment,
    PlanPhaseMaximumAdjustment,
    PlanPhaseMinimumAdjustment,
    PlanPhasePercentageDiscountAdjustment,
    PlanPhaseUsageDiscountAdjustment,
    Price,
    PriceInterval,
    SubLineItemGrouping,
    SubLineItemMatrixConfig,
    SubscriptionChangeMinified,
    SubscriptionMinified,
    SubscriptionTrialInfo,
    TaxAmount,
    Tier,
    TierSubLineItem,
    TieredConfig,
    TieredConversionRateConfig,
    TrialDiscount,
    UnitConfig,
    UnitConversionRateConfig,
    UsageDiscount,
    UsageDiscountInterval,
)

TopLevel

Types:

from orb.types import TopLevelPingResponse

Methods:

• client.top_level.ping() -> TopLevelPingResponse

Beta

Types:

from orb.types import PlanVersion, PlanVersionPhase

Methods:

• client.beta.create_plan_version(plan_id, **params) -> PlanVersion
• client.beta.fetch_plan_version(version, *, plan_id) -> PlanVersion
• client.beta.set_default_plan_version(plan_id, **params) -> Plan

ExternalPlanID

Methods:

• client.beta.external_plan_id.create_plan_version(external_plan_id, **params) -> PlanVersion
• client.beta.external_plan_id.fetch_plan_version(version, *, external_plan_id) -> PlanVersion
• client.beta.external_plan_id.set_default_plan_version(external_plan_id, **params) -> Plan

Coupons

Types:

from orb.types import Coupon

Methods:

• client.coupons.create(**params) -> Coupon
• client.coupons.list(**params) -> SyncPage[Coupon]
• client.coupons.archive(coupon_id) -> Coupon
• client.coupons.fetch(coupon_id) -> Coupon

Subscriptions

Methods:

• client.coupons.subscriptions.list(coupon_id, **params) -> SyncPage[Subscription]

CreditNotes

Methods:

• client.credit_notes.create(**params) -> CreditNote
• client.credit_notes.list(**params) -> SyncPage[CreditNote]
• client.credit_notes.fetch(credit_note_id) -> CreditNote

Customers

Types:

from orb.types import (
    AccountingProviderConfig,
    AddressInput,
    Customer,
    CustomerHierarchyConfig,
    NewAccountingSyncConfiguration,
    NewAvalaraTaxConfiguration,
    NewReportingConfiguration,
    NewSphereConfiguration,
    NewTaxJarConfiguration,
)

Methods:

• client.customers.create(**params) -> Customer
• client.customers.update(customer_id, **params) -> Customer
• client.customers.list(**params) -> SyncPage[Customer]
• client.customers.delete(customer_id) -> None
• client.customers.fetch(customer_id) -> Customer
• client.customers.fetch_by_external_id(external_customer_id) -> Customer
• client.customers.sync_payment_methods_from_gateway(customer_id) -> None
• client.customers.sync_payment_methods_from_gateway_by_external_customer_id(external_customer_id) -> None
• client.customers.update_by_external_id(id, **params) -> Customer

Costs

Types:

from orb.types.customers import CostListResponse, CostListByExternalIDResponse

Methods:

• client.customers.costs.list(customer_id, **params) -> CostListResponse
• client.customers.costs.list_by_external_id(external_customer_id, **params) -> CostListByExternalIDResponse

Credits

Types:

from orb.types.customers import CreditListResponse, CreditListByExternalIDResponse

Methods:

• client.customers.credits.list(customer_id, **params) -> SyncPage[CreditListResponse]
• client.customers.credits.list_by_external_id(external_customer_id, **params) -> SyncPage[CreditListByExternalIDResponse]

Ledger

Types:

from orb.types.customers.credits import (
    AffectedBlock,
    AmendmentLedgerEntry,
    CreditBlockExpiryLedgerEntry,
    DecrementLedgerEntry,
    ExpirationChangeLedgerEntry,
    IncrementLedgerEntry,
    VoidInitiatedLedgerEntry,
    VoidLedgerEntry,
    LedgerListResponse,
    LedgerCreateEntryResponse,
    LedgerCreateEntryByExternalIDResponse,
    LedgerListByExternalIDResponse,
)

Methods:

• client.customers.credits.ledger.list(customer_id, **params) -> SyncPage[LedgerListResponse]
• client.customers.credits.ledger.create_entry(customer_id, **params) -> LedgerCreateEntryResponse
• client.customers.credits.ledger.create_entry_by_external_id(external_customer_id, **params) -> LedgerCreateEntryByExternalIDResponse
• client.customers.credits.ledger.list_by_external_id(external_customer_id, **params) -> SyncPage[LedgerListByExternalIDResponse]

TopUps

Types:

from orb.types.customers.credits import (
    TopUpInvoiceSettings,
    TopUpCreateResponse,
    TopUpListResponse,
    TopUpCreateByExternalIDResponse,
    TopUpListByExternalIDResponse,
)

Methods:

• client.customers.credits.top_ups.create(customer_id, **params) -> TopUpCreateResponse
• client.customers.credits.top_ups.list(customer_id, **params) -> SyncPage[TopUpListResponse]
• client.customers.credits.top_ups.delete(top_up_id, *, customer_id) -> None
• client.customers.credits.top_ups.create_by_external_id(external_customer_id, **params) -> TopUpCreateByExternalIDResponse
• client.customers.credits.top_ups.delete_by_external_id(top_up_id, *, external_customer_id) -> None
• client.customers.credits.top_ups.list_by_external_id(external_customer_id, **params) -> SyncPage[TopUpListByExternalIDResponse]

BalanceTransactions

Types:

from orb.types.customers import BalanceTransactionCreateResponse, BalanceTransactionListResponse

Methods:

• client.customers.balance_transactions.create(customer_id, **params) -> BalanceTransactionCreateResponse
• client.customers.balance_transactions.list(customer_id, **params) -> SyncPage[BalanceTransactionListResponse]

Events

Types:

from orb.types import (
    EventUpdateResponse,
    EventDeprecateResponse,
    EventIngestResponse,
    EventSearchResponse,
)

Methods:

• client.events.update(event_id, **params) -> EventUpdateResponse
• client.events.deprecate(event_id) -> EventDeprecateResponse
• client.events.ingest(**params) -> EventIngestResponse
• client.events.search(**params) -> EventSearchResponse

Backfills

Types:

from orb.types.events import (
    BackfillCreateResponse,
    BackfillListResponse,
    BackfillCloseResponse,
    BackfillFetchResponse,
    BackfillRevertResponse,
)

Methods:

• client.events.backfills.create(**params) -> BackfillCreateResponse
• client.events.backfills.list(**params) -> SyncPage[BackfillListResponse]
• client.events.backfills.close(backfill_id) -> BackfillCloseResponse
• client.events.backfills.fetch(backfill_id) -> BackfillFetchResponse
• client.events.backfills.revert(backfill_id) -> BackfillRevertResponse

Volume

Types:

from orb.types.events import EventVolumes

Methods:

• client.events.volume.list(**params) -> EventVolumes

InvoiceLineItems

Types:

from orb.types import InvoiceLineItemCreateResponse

Methods:

• client.invoice_line_items.create(**params) -> InvoiceLineItemCreateResponse

Invoices

Types:

from orb.types import (
    InvoiceFetchUpcomingResponse,
    InvoiceIssueSummaryResponse,
    InvoiceListSummaryResponse,
)

Methods:

• client.invoices.create(**params) -> Invoice
• client.invoices.update(invoice_id, **params) -> Invoice
• client.invoices.list(**params) -> SyncPage[Invoice]
• client.invoices.delete_line_item(line_item_id, *, invoice_id) -> None
• client.invoices.fetch(invoice_id) -> Invoice
• client.invoices.fetch_upcoming(**params) -> InvoiceFetchUpcomingResponse
• client.invoices.issue(invoice_id, **params) -> Invoice
• client.invoices.issue_summary(invoice_id, **params) -> InvoiceIssueSummaryResponse
• client.invoices.list_summary(**params) -> SyncPage[InvoiceListSummaryResponse]
• client.invoices.mark_paid(invoice_id, **params) -> Invoice
• client.invoices.pay(invoice_id) -> Invoice
• client.invoices.void(invoice_id) -> Invoice

Items

Types:

from orb.types import Item

Methods:

• client.items.create(**params) -> Item
• client.items.update(item_id, **params) -> Item
• client.items.list(**params) -> SyncPage[Item]
• client.items.archive(item_id) -> Item
• client.items.fetch(item_id) -> Item

Metrics

Types:

from orb.types import BillableMetric

Methods:

• client.metrics.create(**params) -> BillableMetric
• client.metrics.update(metric_id, **params) -> BillableMetric
• client.metrics.list(**params) -> SyncPage[BillableMetric]
• client.metrics.fetch(metric_id) -> BillableMetric

Plans

Types:

from orb.types import Plan

Methods:

• client.plans.create(**params) -> Plan
• client.plans.update(plan_id, **params) -> Plan
• client.plans.list(**params) -> SyncPage[Plan]
• client.plans.fetch(plan_id) -> Plan

ExternalPlanID

Methods:

• client.plans.external_plan_id.update(other_external_plan_id, **params) -> Plan
• client.plans.external_plan_id.fetch(external_plan_id) -> Plan

Migrations

Types:

from orb.types.plans import (
    MigrationRetrieveResponse,
    MigrationListResponse,
    MigrationCancelResponse,
)

Methods:

• client.plans.migrations.retrieve(migration_id, *, plan_id) -> MigrationRetrieveResponse
• client.plans.migrations.list(plan_id, **params) -> SyncPage[MigrationListResponse]
• client.plans.migrations.cancel(migration_id, *, plan_id) -> MigrationCancelResponse

Prices

Types:

from orb.types import (
    EvaluatePriceGroup,
    PriceEvaluateResponse,
    PriceEvaluateMultipleResponse,
    PriceEvaluatePreviewEventsResponse,
)

Methods:

• client.prices.create(**params) -> Price
• client.prices.update(price_id, **params) -> Price
• client.prices.list(**params) -> SyncPage[Price]
• client.prices.evaluate(price_id, **params) -> PriceEvaluateResponse
• client.prices.evaluate_multiple(**params) -> PriceEvaluateMultipleResponse
• client.prices.evaluate_preview_events(**params) -> PriceEvaluatePreviewEventsResponse
• client.prices.fetch(price_id) -> Price

ExternalPriceID

Methods:

• client.prices.external_price_id.update(external_price_id, **params) -> Price
• client.prices.external_price_id.fetch(external_price_id) -> Price

Subscriptions

Types:

from orb.types import (
    DiscountOverride,
    NewSubscriptionBulkPrice,
    NewSubscriptionBulkWithProrationPrice,
    NewSubscriptionCumulativeGroupedBulkPrice,
    NewSubscriptionGroupedAllocationPrice,
    NewSubscriptionGroupedTieredPackagePrice,
    NewSubscriptionGroupedTieredPrice,
    NewSubscriptionGroupedWithMeteredMinimumPrice,
    NewSubscriptionGroupedWithProratedMinimumPrice,
    NewSubscriptionMatrixPrice,
    NewSubscriptionMatrixWithAllocationPrice,
    NewSubscriptionMatrixWithDisplayNamePrice,
    NewSubscriptionMaxGroupTieredPackagePrice,
    NewSubscriptionMinimumCompositePrice,
    NewSubscriptionPackagePrice,
    NewSubscriptionPackageWithAllocationPrice,
    NewSubscriptionScalableMatrixWithTieredPricingPrice,
    NewSubscriptionScalableMatrixWithUnitPricingPrice,
    NewSubscriptionThresholdTotalAmountPrice,
    NewSubscriptionTieredPackagePrice,
    NewSubscriptionTieredPackageWithMinimumPrice,
    NewSubscriptionTieredPrice,
    NewSubscriptionTieredWithMinimumPrice,
    NewSubscriptionUnitPrice,
    NewSubscriptionUnitWithPercentPrice,
    NewSubscriptionUnitWithProrationPrice,
    Subscription,
    SubscriptionUsage,
    Subscriptions,
    SubscriptionFetchCostsResponse,
    SubscriptionFetchScheduleResponse,
)

Methods:

• client.subscriptions.create(**params) -> MutatedSubscription
• client.subscriptions.update(subscription_id, **params) -> Subscription
• client.subscriptions.list(**params) -> SyncPage[Subscription]
• client.subscriptions.cancel(subscription_id, **params) -> MutatedSubscription
• client.subscriptions.fetch(subscription_id) -> Subscription
• client.subscriptions.fetch_costs(subscription_id, **params) -> SubscriptionFetchCostsResponse
• client.subscriptions.fetch_schedule(subscription_id, **params) -> SyncPage[SubscriptionFetchScheduleResponse]
• client.subscriptions.fetch_usage(subscription_id, **params) -> SubscriptionUsage
• client.subscriptions.price_intervals(subscription_id, **params) -> MutatedSubscription
• client.subscriptions.redeem_coupon(subscription_id, **params) -> MutatedSubscription
• client.subscriptions.schedule_plan_change(subscription_id, **params) -> MutatedSubscription
• client.subscriptions.trigger_phase(subscription_id, **params) -> MutatedSubscription
• client.subscriptions.unschedule_cancellation(subscription_id) -> MutatedSubscription
• client.subscriptions.unschedule_fixed_fee_quantity_updates(subscription_id, **params) -> MutatedSubscription
• client.subscriptions.unschedule_pending_plan_changes(subscription_id) -> MutatedSubscription
• client.subscriptions.update_fixed_fee_quantity(subscription_id, **params) -> MutatedSubscription
• client.subscriptions.update_trial(subscription_id, **params) -> MutatedSubscription

Webhooks

Methods:

• client.webhooks.unwrap(*args) -> object
• client.webhooks.verify_signature(*args) -> None

Alerts

Types:

from orb.types import Alert, Threshold

Methods:

• client.alerts.retrieve(alert_id) -> Alert
• client.alerts.update(alert_configuration_id, **params) -> Alert
• client.alerts.list(**params) -> SyncPage[Alert]
• client.alerts.create_for_customer(customer_id, **params) -> Alert
• client.alerts.create_for_external_customer(external_customer_id, **params) -> Alert
• client.alerts.create_for_subscription(subscription_id, **params) -> Alert
• client.alerts.disable(alert_configuration_id, **params) -> Alert
• client.alerts.enable(alert_configuration_id, **params) -> Alert

DimensionalPriceGroups

Types:

from orb.types import DimensionalPriceGroup, DimensionalPriceGroups

Methods:

• client.dimensional_price_groups.create(**params) -> DimensionalPriceGroup
• client.dimensional_price_groups.retrieve(dimensional_price_group_id) -> DimensionalPriceGroup
• client.dimensional_price_groups.update(dimensional_price_group_id, **params) -> DimensionalPriceGroup
• client.dimensional_price_groups.list(**params) -> SyncPage[DimensionalPriceGroup]

ExternalDimensionalPriceGroupID

Methods:

• client.dimensional_price_groups.external_dimensional_price_group_id.retrieve(external_dimensional_price_group_id) -> DimensionalPriceGroup
• client.dimensional_price_groups.external_dimensional_price_group_id.update(path_external_dimensional_price_group_id, **params) -> DimensionalPriceGroup

SubscriptionChanges

Types:

from orb.types import (
    MutatedSubscription,
    SubscriptionChangeRetrieveResponse,
    SubscriptionChangeListResponse,
    SubscriptionChangeApplyResponse,
    SubscriptionChangeCancelResponse,
)

Methods:

• client.subscription_changes.retrieve(subscription_change_id) -> SubscriptionChangeRetrieveResponse
• client.subscription_changes.list(**params) -> SyncPage[SubscriptionChangeListResponse]
• client.subscription_changes.apply(subscription_change_id, **params) -> SubscriptionChangeApplyResponse
• client.subscription_changes.cancel(subscription_change_id) -> SubscriptionChangeCancelResponse

CreditBlocks

Types:

from orb.types import CreditBlockRetrieveResponse, CreditBlockListInvoicesResponse

Methods:

• client.credit_blocks.retrieve(block_id) -> CreditBlockRetrieveResponse
• client.credit_blocks.delete(block_id) -> None
• client.credit_blocks.list_invoices(block_id) -> CreditBlockListInvoicesResponse

LicenseTypes

Types:

from orb.types import (
    LicenseTypeCreateResponse,
    LicenseTypeRetrieveResponse,
    LicenseTypeListResponse,
)

Methods:

• client.license_types.create(**params) -> LicenseTypeCreateResponse
• client.license_types.retrieve(license_type_id) -> LicenseTypeRetrieveResponse
• client.license_types.list(**params) -> SyncPage[LicenseTypeListResponse]

Licenses

Types:

from orb.types import (
    LicenseCreateResponse,
    LicenseRetrieveResponse,
    LicenseListResponse,
    LicenseDeactivateResponse,
    LicenseRetrieveByExternalIDResponse,
)

Methods:

• client.licenses.create(**params) -> LicenseCreateResponse
• client.licenses.retrieve(license_id) -> LicenseRetrieveResponse
• client.licenses.list(**params) -> SyncPage[LicenseListResponse]
• client.licenses.deactivate(license_id, **params) -> LicenseDeactivateResponse
• client.licenses.retrieve_by_external_id(external_license_id, **params) -> LicenseRetrieveByExternalIDResponse

ExternalLicenses

Types:

from orb.types.licenses import ExternalLicenseGetUsageResponse

Methods:

• client.licenses.external_licenses.get_usage(external_license_id, **params) -> ExternalLicenseGetUsageResponse

Usage

Types:

from orb.types.licenses import UsageGetAllUsageResponse, UsageGetUsageResponse

Methods:

• client.licenses.usage.get_all_usage(**params) -> UsageGetAllUsageResponse
• client.licenses.usage.get_usage(license_id, **params) -> UsageGetUsageResponse