Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/orb-python
A Python SDK for accessing the Orb API.
https://github.com/speakeasy-sdks/orb-python
api billing invoice invoicing metering orb payments python sdk usage-based-billing
Last synced: 1 day ago
JSON representation
A Python SDK for accessing the Orb API.
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/orb-python
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-04-04T10:44:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:19:43.000Z (7 months ago)
- Last Synced: 2024-04-28T05:14:48.580Z (6 months ago)
- Topics: api, billing, invoice, invoicing, metering, orb, payments, python, sdk, usage-based-billing
- Language: Python
- Homepage: https://docs.withorb.com/docs/orb-docs/overview
- Size: 1.46 MB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Python SDK
The modern pricing platform to bill for seats, consumption, and everything in between.
## SDK Installation
```bash
pip install orb-billing
```
## SDK Example Usage
```python
import orb
from orb.models import shared
s = orb.Orb(
security=shared.Security(
api_key_auth="",
),
)
req = shared.CouponInput(
discount=shared.Discount(
amount_discount='corrupti',
applies_to_price_ids=[
'distinctio',
'quibusdam',
'unde',
],
discount_type=shared.DiscountType.PERCENTAGE,
percentage_discount=0.15,
trial_amount_discount='nulla',
usage_discount=5448.83,
),
duration_in_months=847252,
id='69a674e0-f467-4cc8-b96e-d151a05dfc2d',
max_redemptions=870088,
redemption_code='maiores',
times_redeemed=473608,
)
res = s.coupon.create(req)
if res.status_code == 200:
# handle response
```
## Available Resources and Operations
### [availability](docs/availability/README.md)
* [ping](docs/availability/README.md#ping) - Check availability
### [coupon](docs/coupon/README.md)
* [archive](docs/coupon/README.md#archive) - Archive a coupon
* [create](docs/coupon/README.md#create) - Create a coupon
* [fetch](docs/coupon/README.md#fetch) - Retrieve a coupon
* [list](docs/coupon/README.md#list) - List coupons
* [list_subscriptions](docs/coupon/README.md#list_subscriptions) - List subscriptions for a coupon
### [credit](docs/credit/README.md)
* [add_by_external_id](docs/credit/README.md#add_by_external_id) - Add credit ledger entry by external customer ID
* [create](docs/credit/README.md#create) - Add credit ledger entry
* [fetch](docs/credit/README.md#fetch) - Retrieve credit balance
* [fetch_by_external_id](docs/credit/README.md#fetch_by_external_id) - Retrieve credit balance by external customer ID
* [fetch_ledger](docs/credit/README.md#fetch_ledger) - View credits ledger
* [fetch_ledger_by_external_id](docs/credit/README.md#fetch_ledger_by_external_id) - View credits ledger by external customer ID
### [credit_note](docs/creditnote/README.md)
* [list](docs/creditnote/README.md#list) - List credit notes
### [customer](docs/customer/README.md)
* [amend](docs/customer/README.md#amend) - Amend customer usage
* [amend_by_external_id](docs/customer/README.md#amend_by_external_id) - Amend customer usage by external ID
* [create](docs/customer/README.md#create) - Create customer
* [create_transaction](docs/customer/README.md#create_transaction) - Create a customer balance transaction
* [delete](docs/customer/README.md#delete) - Delete a customer
* [fetch](docs/customer/README.md#fetch) - Retrieve a customer
* [fetch_by_external_id](docs/customer/README.md#fetch_by_external_id) - Retrieve a customer by external ID
* [fetch_costs](docs/customer/README.md#fetch_costs) - View customer costs
* [fetch_costs_by_external_id](docs/customer/README.md#fetch_costs_by_external_id) - View customer costs by external customer ID
* [fetch_transactions](docs/customer/README.md#fetch_transactions) - Get customer balance transactions
* [list](docs/customer/README.md#list) - List customers
* [update_by_external_id](docs/customer/README.md#update_by_external_id) - Update a customer by external ID
* [update_customer](docs/customer/README.md#update_customer) - Update customer
### [event](docs/event/README.md)
* [amend](docs/event/README.md#amend) - Amend single event
* [close_backfill](docs/event/README.md#close_backfill) - Close a backfill
* [create](docs/event/README.md#create) - Create a backfill
* [deprecate_event](docs/event/README.md#deprecate_event) - Deprecate single event
* [ingest](docs/event/README.md#ingest) - Ingest events
* [list_backfills](docs/event/README.md#list_backfills) - List backfills
* [revert_backfill](docs/event/README.md#revert_backfill) - Revert a backfill
* [search](docs/event/README.md#search) - Search events
### [invoice](docs/invoice/README.md)
* [create](docs/invoice/README.md#create) - Create invoice line item
* [fetch](docs/invoice/README.md#fetch) - Retrieve an Invoice
* [fetch_upcoming](docs/invoice/README.md#fetch_upcoming) - Retrieve upcoming invoice
* [list](docs/invoice/README.md#list) - List invoices
* [void](docs/invoice/README.md#void) - Void an invoice
### [plan](docs/plan/README.md)
* [fetch](docs/plan/README.md#fetch) - Retrieve a plan
* [get_by_external_id](docs/plan/README.md#get_by_external_id) - Retrieve a plan by external plan ID
* [list](docs/plan/README.md#list) - List plans
### [subscription](docs/subscription/README.md)
* [cancel](docs/subscription/README.md#cancel) - Cancel subscription
* [create](docs/subscription/README.md#create) - Create subscription
* [fetch](docs/subscription/README.md#fetch) - Retrieve a subscription
* [fetch_costs](docs/subscription/README.md#fetch_costs) - View subscription costs
* [fetch_schedule](docs/subscription/README.md#fetch_schedule) - View subscription schedule
* [fetch_usage](docs/subscription/README.md#fetch_usage) - View subscription usage
* [list](docs/subscription/README.md#list) - List subscriptions
* [schedule_plan_change](docs/subscription/README.md#schedule_plan_change) - Schedule plan change
* [unschedule_cancellation](docs/subscription/README.md#unschedule_cancellation) - Unschedule pending cancellation
* [unschedule_plan_change](docs/subscription/README.md#unschedule_plan_change) - Unschedule pending plan changes
* [update_fixed_fee_quantity](docs/subscription/README.md#update_fixed_fee_quantity) - Update fixed fee 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](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)