Metadata-Version: 2.4
Name: bxb_portal
Version: 0.3.4
Summary: BXB Customer Portal API
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/boxbilling/bxb
Keywords: OpenAPI,OpenAPI-Generator,BXB Customer Portal API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# bxb-portal

Python SDK for the [bxb](https://github.com/boxbilling/bxb) customer portal API.

This package contains only the portal endpoints, intended for customer-facing applications that need self-service access to billing data.

## Installation

```bash
pip install bxb-portal
```

## Usage

```python
import bxb_portal

config = bxb_portal.Configuration(host="https://your-bxb-instance.com")
client = bxb_portal.ApiClient(config)
```

## Authentication

The portal API uses JWT tokens passed as a query parameter. See the main bxb documentation for details on generating portal tokens.

## Documentation

- [GitHub Repository](https://github.com/boxbilling/bxb)
- [API Reference](https://github.com/boxbilling/bxb/blob/main/backend/openapi.json)

## License

AGPL-3.0
