Skip to content

Api reference

components.billing_occupational_health.public.commands

components.billing_occupational_health.public.entities

components.billing_occupational_health.public.queries

Public queries for billing occupational health.

get_contract_balance 

get_contract_balance(contract_ref)

Get the live balance for a contract identified by its subscription ref.

Parameters:

Name Type Description Default
contract_ref str

opaque subscription reference (e.g. "occhealth:account:{uuid}:{siren}")

 required

Returns:

Type Description
int

Balance in cents.
Source code in components/billing_occupational_health/public/queries.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def get_contract_balance(contract_ref: str) -> int:
    """
    Get the live balance for a contract identified by its subscription ref.

    Args:
        contract_ref: opaque subscription reference (e.g. "occhealth:account:{uuid}:{siren}")

    Returns:
        Balance in cents.
    """
    contract_identifier: ContractIdentifier = (
        OccHealthContractIdentifier.from_subscription_ref(contract_ref)
    )
    return InvoiceLogicDependencies.get_balance(contract_identifier)