api.md

Shared Types

from orb.types import (
    AmountDiscount,
    BillingCycleRelativeDate,
    Discount,
    InvoiceLevelDiscount,
    PaginationMetadata,
    PercentageDiscount,
    TrialDiscount,
)

TopLevel

Types:

from orb.types import TopLevelPingResponse

Methods:

• client.top_level.ping() -> TopLevelPingResponse

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

Types:

from orb.types import CreditNote

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 Customer

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.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 (
    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 (
    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 Invoice, InvoiceFetchUpcomingResponse

Methods:

• client.invoices.create(**params) -> Invoice
• client.invoices.update(invoice_id, **params) -> Invoice
• client.invoices.list(**params) -> SyncPage[Invoice]
• client.invoices.fetch(invoice_id) -> Invoice
• client.invoices.fetch_upcoming(**params) -> InvoiceFetchUpcomingResponse
• client.invoices.issue(invoice_id, **params) -> Invoice
• 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.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

Prices

Types:

from orb.types import EvaluatePriceGroup, Price, PriceEvaluateResponse

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.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 (
    Subscription,
    SubscriptionUsage,
    Subscriptions,
    SubscriptionCreateResponse,
    SubscriptionCancelResponse,
    SubscriptionFetchCostsResponse,
    SubscriptionFetchScheduleResponse,
    SubscriptionPriceIntervalsResponse,
    SubscriptionSchedulePlanChangeResponse,
    SubscriptionTriggerPhaseResponse,
    SubscriptionUnscheduleCancellationResponse,
    SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse,
    SubscriptionUnschedulePendingPlanChangesResponse,
    SubscriptionUpdateFixedFeeQuantityResponse,
    SubscriptionUpdateTrialResponse,
)

Methods:

• client.subscriptions.create(**params) -> SubscriptionCreateResponse
• client.subscriptions.update(subscription_id, **params) -> Subscription
• client.subscriptions.list(**params) -> SyncPage[Subscription]
• client.subscriptions.cancel(subscription_id, **params) -> SubscriptionCancelResponse
• 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) -> SubscriptionPriceIntervalsResponse
• client.subscriptions.schedule_plan_change(subscription_id, **params) -> SubscriptionSchedulePlanChangeResponse
• client.subscriptions.trigger_phase(subscription_id, **params) -> SubscriptionTriggerPhaseResponse
• client.subscriptions.unschedule_cancellation(subscription_id) -> SubscriptionUnscheduleCancellationResponse
• client.subscriptions.unschedule_fixed_fee_quantity_updates(subscription_id, **params) -> SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse
• client.subscriptions.unschedule_pending_plan_changes(subscription_id) -> SubscriptionUnschedulePendingPlanChangesResponse
• client.subscriptions.update_fixed_fee_quantity(subscription_id, **params) -> SubscriptionUpdateFixedFeeQuantityResponse
• client.subscriptions.update_trial(subscription_id, **params) -> SubscriptionUpdateTrialResponse

Webhooks

Methods:

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

Alerts

Types:

from orb.types import Alert

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.list(**params) -> SyncPage[DimensionalPriceGroup]

ExternalDimensionalPriceGroupID

Methods:

• client.dimensional_price_groups.external_dimensional_price_group_id.retrieve(external_dimensional_price_group_id) -> DimensionalPriceGroup