{"id":18384375,"url":"https://github.com/speakeasy-sdks/orb-python","last_synced_at":"2026-01-06T12:50:27.592Z","repository":{"id":155716113,"uuid":"623422544","full_name":"speakeasy-sdks/orb-python","owner":"speakeasy-sdks","description":"A Python SDK for accessing the Orb API.","archived":false,"fork":false,"pushed_at":"2024-04-02T21:19:43.000Z","size":1532,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-01T14:44:55.195Z","etag":null,"topics":["api","billing","invoice","invoicing","metering","orb","payments","python","sdk","usage-based-billing"],"latest_commit_sha":null,"homepage":"https://docs.withorb.com/docs/orb-docs/overview","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/speakeasy-sdks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-04T10:44:11.000Z","updated_at":"2023-07-20T00:52:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"02412139-49e6-4aa6-9ebf-6ff74c46cb02","html_url":"https://github.com/speakeasy-sdks/orb-python","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Forb-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Forb-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Forb-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Forb-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/speakeasy-sdks","download_url":"https://codeload.github.com/speakeasy-sdks/orb-python/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245822221,"owners_count":20678162,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","billing","invoice","invoicing","metering","orb","payments","python","sdk","usage-based-billing"],"created_at":"2024-11-06T01:14:21.438Z","updated_at":"2026-01-06T12:50:27.546Z","avatar_url":"https://github.com/speakeasy-sdks.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://user-images.githubusercontent.com/6267663/229776275-b670d564-fc2e-4843-b061-adf230737e3f.svg\"\u003e\n    \u003ch1\u003ePython SDK\u003c/h1\u003e\n   \u003cp\u003eThe modern pricing platform to bill for seats, consumption, and everything in between.\u003c/p\u003e\n   \u003ca href=\"https://docs.withorb.com/docs/orb-docs/overview\"\u003e\u003cimg src=\"https://img.shields.io/static/v1?label=Docs\u0026message=API Ref\u0026color=5444e4\u0026style=for-the-badge\" /\u003e\u003c/a\u003e\n   \u003ca href=\"https://github.com/speakeasy-sdks/orb-python/actions\"\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/speakeasy-sdks/orb-python/speakeasy_sdk_generation.yml?style=for-the-badge\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/speakeasy-sdks/orb-python/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/speakeasy-sdks/orb-python?sort=semver\u0026style=for-the-badge\" /\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n\u003c!-- Start SDK Installation --\u003e\n## SDK Installation\n\n```bash\npip install orb-billing\n```\n\u003c!-- End SDK Installation --\u003e\n\n## SDK Example Usage\n\u003c!-- Start SDK Example Usage --\u003e\n```python\nimport orb\nfrom orb.models import shared\n\ns = orb.Orb(\n    security=shared.Security(\n        api_key_auth=\"\",\n    ),\n)\n\nreq = shared.CouponInput(\n    discount=shared.Discount(\n        amount_discount='corrupti',\n        applies_to_price_ids=[\n            'distinctio',\n            'quibusdam',\n            'unde',\n        ],\n        discount_type=shared.DiscountType.PERCENTAGE,\n        percentage_discount=0.15,\n        trial_amount_discount='nulla',\n        usage_discount=5448.83,\n    ),\n    duration_in_months=847252,\n    id='69a674e0-f467-4cc8-b96e-d151a05dfc2d',\n    max_redemptions=870088,\n    redemption_code='maiores',\n    times_redeemed=473608,\n)\n\nres = s.coupon.create(req)\n\nif res.status_code == 200:\n    # handle response\n```\n\u003c!-- End SDK Example Usage --\u003e\n\n\u003c!-- Start SDK Available Operations --\u003e\n## Available Resources and Operations\n\n\n### [availability](docs/availability/README.md)\n\n* [ping](docs/availability/README.md#ping) - Check availability\n\n### [coupon](docs/coupon/README.md)\n\n* [archive](docs/coupon/README.md#archive) - Archive a coupon\n* [create](docs/coupon/README.md#create) - Create a coupon\n* [fetch](docs/coupon/README.md#fetch) - Retrieve a coupon\n* [list](docs/coupon/README.md#list) - List coupons\n* [list_subscriptions](docs/coupon/README.md#list_subscriptions) - List subscriptions for a coupon\n\n### [credit](docs/credit/README.md)\n\n* [add_by_external_id](docs/credit/README.md#add_by_external_id) - Add credit ledger entry by external customer ID\n* [create](docs/credit/README.md#create) - Add credit ledger entry\n* [fetch](docs/credit/README.md#fetch) - Retrieve credit balance\n* [fetch_by_external_id](docs/credit/README.md#fetch_by_external_id) - Retrieve credit balance by external customer ID\n* [fetch_ledger](docs/credit/README.md#fetch_ledger) - View credits ledger\n* [fetch_ledger_by_external_id](docs/credit/README.md#fetch_ledger_by_external_id) - View credits ledger by external customer ID\n\n### [credit_note](docs/creditnote/README.md)\n\n* [list](docs/creditnote/README.md#list) - List credit notes\n\n### [customer](docs/customer/README.md)\n\n* [amend](docs/customer/README.md#amend) - Amend customer usage\n* [amend_by_external_id](docs/customer/README.md#amend_by_external_id) - Amend customer usage by external ID\n* [create](docs/customer/README.md#create) - Create customer\n* [create_transaction](docs/customer/README.md#create_transaction) - Create a customer balance transaction\n* [delete](docs/customer/README.md#delete) - Delete a customer\n* [fetch](docs/customer/README.md#fetch) - Retrieve a customer\n* [fetch_by_external_id](docs/customer/README.md#fetch_by_external_id) - Retrieve a customer by external ID\n* [fetch_costs](docs/customer/README.md#fetch_costs) - View customer costs\n* [fetch_costs_by_external_id](docs/customer/README.md#fetch_costs_by_external_id) - View customer costs by external customer ID\n* [fetch_transactions](docs/customer/README.md#fetch_transactions) - Get customer balance transactions\n* [list](docs/customer/README.md#list) - List customers\n* [update_by_external_id](docs/customer/README.md#update_by_external_id) - Update a customer by external ID\n* [update_customer](docs/customer/README.md#update_customer) - Update customer\n\n### [event](docs/event/README.md)\n\n* [amend](docs/event/README.md#amend) - Amend single event\n* [close_backfill](docs/event/README.md#close_backfill) - Close a backfill\n* [create](docs/event/README.md#create) - Create a backfill\n* [deprecate_event](docs/event/README.md#deprecate_event) - Deprecate single event\n* [ingest](docs/event/README.md#ingest) - Ingest events\n* [list_backfills](docs/event/README.md#list_backfills) - List backfills\n* [revert_backfill](docs/event/README.md#revert_backfill) - Revert a backfill\n* [search](docs/event/README.md#search) - Search events\n\n### [invoice](docs/invoice/README.md)\n\n* [create](docs/invoice/README.md#create) - Create invoice line item\n* [fetch](docs/invoice/README.md#fetch) - Retrieve an Invoice\n* [fetch_upcoming](docs/invoice/README.md#fetch_upcoming) - Retrieve upcoming invoice\n* [list](docs/invoice/README.md#list) - List invoices\n* [void](docs/invoice/README.md#void) - Void an invoice\n\n### [plan](docs/plan/README.md)\n\n* [fetch](docs/plan/README.md#fetch) - Retrieve a plan\n* [get_by_external_id](docs/plan/README.md#get_by_external_id) - Retrieve a plan by external plan ID\n* [list](docs/plan/README.md#list) - List plans\n\n### [subscription](docs/subscription/README.md)\n\n* [cancel](docs/subscription/README.md#cancel) - Cancel subscription\n* [create](docs/subscription/README.md#create) - Create subscription\n* [fetch](docs/subscription/README.md#fetch) - Retrieve a subscription\n* [fetch_costs](docs/subscription/README.md#fetch_costs) - View subscription costs\n* [fetch_schedule](docs/subscription/README.md#fetch_schedule) - View subscription schedule\n* [fetch_usage](docs/subscription/README.md#fetch_usage) - View subscription usage\n* [list](docs/subscription/README.md#list) - List subscriptions\n* [schedule_plan_change](docs/subscription/README.md#schedule_plan_change) - Schedule plan change\n* [unschedule_cancellation](docs/subscription/README.md#unschedule_cancellation) - Unschedule pending cancellation\n* [unschedule_plan_change](docs/subscription/README.md#unschedule_plan_change) - Unschedule pending plan changes\n* [update_fixed_fee_quantity](docs/subscription/README.md#update_fixed_fee_quantity) - Update fixed fee quantity\n\u003c!-- End SDK Available Operations --\u003e\n\n### Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n### Contributions\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically.\nFeel 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 !\n\n### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-sdks%2Forb-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspeakeasy-sdks%2Forb-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-sdks%2Forb-python/lists"}