orb-billing 1.18.3

Python client SDK for Orb's API

orb

SDK Installation

pip install orb-billing

SDK Example Usage

import orb
from orb.models import shared

s = orb.Orb(
    security=shared.Security(
        api_key_auth="",
    ),
)

req = shared.NewCustomer(
    auto_collection=False,
    billing_address=shared.NewCustomerBillingAddress(
        city='Laruecester',
        country='US',
        line1='quibusdam',
        line2='unde',
        postal_code='58466-3428',
        state='ipsa',
    ),
    currency='delectus',
    email='[e-mail]',
    external_customer_id='iusto',
    metadata=shared.NewCustomerMetadata(),
    name='Charlie Walsh II',
    payment_provider=shared.NewCustomerPaymentProvider.QUICKBOOKS,
    payment_provider_id='deserunt',
    shipping_address=shared.NewCustomerShippingAddress(
        city='West Ritaworth',
        country='US',
        line1='quo',
        line2='odit',
        postal_code='89478-4576',
        state='dicta',
    ),
    tax_id=shared.NewCustomerCustomerTaxID(
        country='Puerto Rico',
        type='officia',
        value='occaecati',
    ),
    timezone='Etc/UTC',
)

res = s.customer.create(req)

if res.customer is not None:
    # handle response

Available Resources and Operations

availability

• ping - Check availability

coupon

• archive - Archive coupon
• create - Create coupon
• fetch - Fetch coupon
• list - List coupons
• list_subscriptions - List coupon subscriptions

credit

• add_by_external_id - Create ledger entry by external ID
• create - Create ledger entry
• fetch - Fetch customer credit balance
• fetch_by_external_id - Fetch customer credit balance by external customer id
• fetch_ledger - Fetch customer credits ledger
• fetch_ledger_external_id - Fetch credits ledger by external ID

credit_note

• fetch - Fetch credit note
• list - List credit notes

customer

• amend - Amend usage
• amend_by_external_id - Amend usage by external ID
• create - Create customer
• create_balance_transaction - Create customer balance transaction
• delete - Delete customer
• fetch - Fetch customer
• fetch_by_external_id - Fetch customer by external ID
• fetch_costs - Fetch customer costs
• fetch_costs_by_external_id - Fetch customer costs by external ID
• fetch_transactions - List balance transactions
• list - List customers
• update_by_external_id - Update customer by external ID
• update_customer - Update customer

event

• amend - Amend event
• close_backfill - Close backfill
• create - Create backfill
• deprecate_event - Deprecate event
• ingest - Ingest events
• list_backfills - List backfills
• revert_backfill - Revert backfill
• search - Search events

invoice

• create - Create invoice line item
• fetch - Fetch invoice
• fetch_upcoming - Fetch upcoming invoice
• issue - Issue an invoice
• list - List invoices
• void - Void invoice

plan

• fetch - Fetch plan
• get_by_external_id - Fetch plan by external ID
• list - List plans

subscription

• cancel - Cancel subscription
• create - Create subscription
• fetch - Fetch subscription
• fetch_costs - Fetch subscription costs
• fetch_schedule - Fetch subscription schedule
• fetch_usage - Fetch subscription usage
• list - List subscriptions
• schedule_plan_change - Schedule plan change
• unschedule_cancellation - Unschedule subscription cancellation
• unschedule_plan_change - Unschedule plan change
• update_fixed_fee_quantity - Update price quantity

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !

SDK Created by Speakeasy