Skip to content

Rapidata billing manager

RapidataBillingManager #

RapidataBillingManager(openapi_service: OpenAPIService)

Read what the current billing period has cost and what credit is left.

Billing is settled per organization, so the figures cover everything the organization spent, not only the jobs this client created.

Access this manager via 🇵🇾attr:RapidataClient.billing.

Source code in src/rapidata/rapidata_client/billing/rapidata_billing_manager.py 
21
22
23
def __init__(self, openapi_service: OpenAPIService):
    self._openapi_service = openapi_service
    logger.debug("RapidataBillingManager initialized")

get_current_billing_period #

get_current_billing_period() -> BillingPeriod

Get the billing period that is currently accruing cost.

Returns:

Name Type Description
BillingPeriod BillingPeriod

The current period, its outstanding cost and the remaining prepaid credits.

Raises:

Type Description
RapidataError

With status 404 if the organization has no active billing period — a period only opens once there is something to bill.
Source code in src/rapidata/rapidata_client/billing/rapidata_billing_manager.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
def get_current_billing_period(self) -> BillingPeriod:
    """Get the billing period that is currently accruing cost.

    Returns:
        BillingPeriod: The current period, its outstanding cost and the
            remaining prepaid credits.

    Raises:
        RapidataError: With status 404 if the organization has no active
            billing period — a period only opens once there is something
            to bill.
    """
    with tracer.start_as_current_span(
        "RapidataBillingManager.get_current_billing_period"
    ):
        billing_api = self._openapi_service.payment.billing_api
        # Credits live on the organization's billing account, not on the
        # period, so they come from the summary rather than the overview.
        summary = billing_api.billing_summary_get()
        overview = billing_api.billing_period_active_get()
        return BillingPeriod._from_models(overview, summary)

get_outstanding_balance #

get_outstanding_balance() -> float

Get the total the organization currently owes, in US dollars.

Covers finalized-but-unpaid invoices plus the settled cost of ended periods not yet invoiced. The current, still-accruing period is not part of this — nothing is due until a period ends and settles. The figure is already net of any voucher coverage and discounts.

Returns:

Name Type Description
float float

The total owed, in US dollars rounded to the cent. 0.0 when the organization owes nothing.
Source code in src/rapidata/rapidata_client/billing/rapidata_billing_manager.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def get_outstanding_balance(self) -> float:
    """Get the total the organization currently owes, in US dollars.

    Covers finalized-but-unpaid invoices plus the settled cost of ended
    periods not yet invoiced. The current, still-accruing period is not
    part of this — nothing is due until a period ends and settles. The
    figure is already net of any voucher coverage and discounts.

    Returns:
        float: The total owed, in US dollars rounded to the cent. ``0.0``
            when the organization owes nothing.
    """
    with tracer.start_as_current_span(
        "RapidataBillingManager.get_outstanding_balance"
    ):
        billing_api = self._openapi_service.payment.billing_api
        outstanding = billing_api.billing_outstanding_get()
        return round(outstanding.total_outstanding, 2)