Billing Module API

API reference for billing schedule and installment preview helpers.

BriteCore v2 Billing API endpoint wrappers.

britecore_sdk.api.api_calls.v2.billing.get_installments_preview(billing_schedule_ids=None, effective_date=None, premium=None, payment_method=None, **kwargs)[source]

Return upcoming installments for the supplied billing schedules..

POST /api/v2/billing/get_installments_preview

Parameters:

  • billing_schedule_ids (list[str] | None)

  • effective_date (str | None)

  • premium (float | int | None)

  • payment_method (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.billing.get_installments_preview_mid_term(billing_schedule_ids=None, payment_method=None, revision_effective_date=None, prorated_premium=None, policy_id=None, **kwargs)[source]

Return upcoming installments for a mid-term billing change..

POST /api/v2/billing/get_installments_preview_mid_term

Parameters:

  • billing_schedule_ids (list[str] | None)

  • payment_method (str | None)

  • revision_effective_date (str | None)

  • prorated_premium (float | int | None)

  • policy_id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.billing.get_renewal_installments_preview(billing_schedule_ids=None, effective_date=None, premium=None, payment_method=None, **kwargs)[source]

Return upcoming installments for a renewal billing schedule..

POST /api/v2/billing/get_renewal_installments_preview

Parameters:

  • billing_schedule_ids (list[str] | None)

  • effective_date (str | None)

  • premium (float | int | None)

  • payment_method (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.billing.rating_factors(policy_id=None, **kwargs)[source]

Return the billing rating factors related to a policy..

POST /api/v2/billing/rating_factors

Parameters:
Return type:

Any