Package: orb-billing
Orb Python API libraryThe Orb Python library provides convenient access to the Orb REST API from any Python 3.7+
application. The library includes type definitions for all request params and response fields,
and offers both synchronous and asynchronous clients powered byhttpx.DocumentationThe REST API documentation can be foundon docs.withorb.com. The full API of this library can be found inapi.md.Installationpipinstallorb-billingUsageThe full API of this library can be found inapi.md.importosfromorbimportOrbclient=Orb(# This is the default and can be omittedapi_key=os.environ.get("ORB_API_KEY"),)customer=client.customers.create(email="example-customer@withorb.com",name="My Customer",)print(customer.id)While you can provide anapi_keykeyword argument,
we recommend usingpython-dotenvto addORB_API_KEY="My API Key"to your.envfile
so that your API Key is not stored in source control.Async usageSimply importAsyncOrbinstead ofOrband useawaitwith each API call:importosimportasynciofromorbimportAsyncOrbclient=AsyncOrb(# This is the default and can be omittedapi_key=os.environ.get("ORB_API_KEY"),)asyncdefmain()->None:customer=awaitclient.customers.create(email="example-customer@withorb.com",name="My Customer",)print(customer.id)asyncio.run(main())Functionality between the synchronous and asynchronous clients is otherwise identical.Using typesNested request parameters areTypedDicts. Responses arePydantic models, which provide helper methods for things like:Serializing back into JSON,model.model_dump_json(indent=2, exclude_unset=True)Converting to a dictionary,model.model_dump(exclude_unset=True)Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, setpython.analysis.typeCheckingModetobasic.PaginationList methods in the Orb API are paginated.This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:importorbclient=Orb()all_coupons=[]# Automatically fetches more pages as needed.forcouponinclient.coupons.list():# Do something with coupon hereall_coupons.append(coupon)print(all_coupons)Or, asynchronously:importasyncioimportorbclient=AsyncOrb()asyncdefmain()->None:all_coupons=[]# Iterate through items across all pages, issuing requests as needed.asyncforcouponinclient.coupons.list():all_coupons.append(coupon)print(all_coupons)asyncio.run(main())Alternatively, you can use the.has_next_page(),.next_page_info(), or.get_next_page()methods for more granular control working with pages:first_page=awaitclient.coupons.list()iffirst_page.has_next_page():print(f"will fetch next page using these details:{first_page.next_page_info()}")next_page=awaitfirst_page.get_next_page()print(f"number of items we just fetched:{len(next_page.data)}")# Remove `await` for non-async usage.Or just work directly with the returned data:first_page=awaitclient.coupons.list()print(f"next page cursor:{first_page.pagination_metadata.next_cursor}")# => "next page cursor: ..."forcouponinfirst_page.data:print(coupon.id)# Remove `await` for non-async usage.Nested paramsNested parameters are dictionaries, typed usingTypedDict, for example:fromorbimportOrbclient=Orb()customer=client.customers.create(email="example-customer@withorb.com",name="My Customer",billing_address={"city":"New York","country":"USA","line1":"123 Example Street",},)print(customer.id)Handling errorsWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass oforb.APIConnectionErroris raised.When the API returns a non-success status code (that is, 4xx or 5xx
response), a subclass oforb.APIStatusErroris raised, containingstatus_codeandresponseproperties.All errors inherit fromorb.APIError.importorbfromorbimportOrbclient=Orb()try:client.customers.create(email="example-customer@withorb.com",name="My Customer",)exceptorb.APIConnectionErrorase:print("The server could not be reached")print(e.__cause__)# an underlying Exception, likely raised within httpx.exceptorb.RateLimitErrorase:print("A 429 status code was received; we should back off a bit.")exceptorb.APIStatusErrorase:print("Another non-200-range status code was received")print(e.status_code)print(e.response)Error codes are as followed:Status CodeError Type400BadRequestError401AuthenticationError403PermissionDeniedError404NotFoundError422UnprocessableEntityError429RateLimitError>=500InternalServerErrorN/AAPIConnectionErrorRetriesCertain errors are automatically retried 2 times by default, with a short exponential backoff.
Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
429 Rate Limit, and >=500 Internal errors are all retried by default.You can use themax_retriesoption to configure or disable retry settings:fromorbimportOrb# Configure the default for all requests:client=Orb(# default is 2max_retries=0,)# Or, configure per-request:client.with_options(max_retries=5).customers.create(email="example-customer@withorb.com",name="My Customer",)TimeoutsBy default requests time out after 1 minute. You can configure this with atimeoutoption,
which accepts a float or anhttpx.Timeoutobject:fromorbimportOrb# Configure the default for all requests:client=Orb(# 20 seconds (default is 1 minute)timeout=20.0,)# More granular control:client=Orb(timeout=httpx.Timeout(60.0,read=5.0,write=10.0,connect=2.0),)# Override per-request:client.with_options(timeout=5*1000).customers.create(email="example-customer@withorb.com",name="My Customer",)On timeout, anAPITimeoutErroris thrown.Note that requests that time out areretried twice by default.AdvancedLoggingWe use the standard libraryloggingmodule.You can enable logging by setting the environment variableORB_LOGtodebug.$exportORB_LOG=debugHow to tell whetherNonemeansnullor missingIn an API response, a field may be explicitlynull, or missing entirely; in either case, its value isNonein this library. You can differentiate the two cases with.model_fields_set:ifresponse.my_fieldisNone:if'my_field'notinresponse.model_fields_set:print('Got json like{}, without a "my_field" key present at all.')else:print('Got json like {"my_field": null}.')Accessing raw response data (e.g. headers)The "raw" Response object can be accessed by prefixing.with_raw_response.to any HTTP method call, e.g.,fromorbimportOrbclient=Orb()response=client.customers.with_raw_response.create(email="example-customer@withorb.com",name="My Customer",)print(response.headers.get('X-My-Header'))customer=response.parse()# get the object that `customers.create()` would have returnedprint(customer.id)These methods return anLegacyAPIResponseobject. This is a legacy class as we're changing it slightly in the next major version.For the sync client this will mostly be the same with the exception
ofcontent&textwill be methods instead of properties. In the
async client, all methods will be async.A migration script will be provided & the migration in general should
be smooth..with_streaming_responseThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.To stream the response body, use.with_streaming_responseinstead, which requires a context manager and only reads the response body once you call.read(),.text(),.json(),.iter_bytes(),.iter_text(),.iter_lines()or.parse(). In the async client, these are async methods.As such,.with_streaming_responsemethods return a differentAPIResponseobject, and the async client returns anAsyncAPIResponseobject.withclient.customers.with_streaming_response.create(email="example-customer@withorb.com",name="My Customer",)asresponse:print(response.headers.get("X-My-Header"))forlineinresponse.iter_lines():print(line)The context manager is required so that the response will reliably be closed.Configuring the HTTP clientYou can directly override thehttpx clientto customize it for your use case, including:Support for proxiesCustom transportsAdditionaladvancedfunctionalityimporthttpxfromorbimportOrbclient=Orb(# Or use the `ORB_BASE_URL` env varbase_url="http://my.test.server.example.com:8083",http_client=httpx.Client(proxies="http://my.test.proxy.example.com",transport=httpx.HTTPTransport(local_address="0.0.0.0"),),)Managing HTTP resourcesBy default the library closes underlying HTTP connections whenever the client isgarbage collected. You can manually close the client using the.close()method if desired, or with a context manager that closes when exiting.VersioningThis package generally followsSemVerconventions, though certain backwards-incompatible changes may be released as minor versions:Changes that only affect static types, without breaking runtime behavior.Changes to library internals which are technically public but not intended or documented for external use.(Please open a GitHub issue to let us know if you are relying on such internals).Changes that we do not expect to impact the vast majority of users in practice.We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.We are keen for your feedback; please open anissuewith questions, bugs, or suggestions.RequirementsPython 3.7 or higher.