ChargingManager

Provides fine-grained access to pay-per-event functionality.

The ChargingManager allows you to charge for specific events in your Actor when using the pay-per-event pricing model. This enables precise cost control and transparent billing for different operations within your Actor.

References

• Apify platform documentation: https://docs.apify.com/platform/actors/publishing/monetize

Hierarchy

• ChargingManager
  • ChargingManagerImplementation

Index

Methods

• calculate_max_event_charge_count_within_limit
• calculate_total_charged_amount
• charge
• get_pricing_info

Methods

calculate_max_event_charge_count_within_limit

• calculate_max_event_charge_count_within_limit(event_name): int | None

• Overrides ChargingManager.calculate_max_event_charge_count_within_limit

  Calculate how many instances of an event can be charged before we reach the configured limit.

  ---

  Parameters

  • event_name: str

    Name of the inspected event.

  Returns int | None

calculate_total_charged_amount

• calculate_total_charged_amount(): Decimal

• Overrides ChargingManager.calculate_total_charged_amount

  Calculate the total amount of money charged for pay-per-event events so far.

  ---

  Returns Decimal

charge

• async charge(event_name, count): ChargeResult

• Overrides ChargingManager.charge

  Charge for a specified number of events - sub-operations of the Actor.

  This is relevant only for the pay-per-event pricing model.

  ---

  Parameters

  • event_name: str

    Name of the event to be charged for.

  • optionalcount: int = 1

    Number of events to charge for.

  Returns ChargeResult

get_pricing_info

• get_pricing_info(): ActorPricingInfo

• Overrides ChargingManager.get_pricing_info

  Retrieve detailed information about the effective pricing of the current Actor run.

  This can be used for instance when your code needs to support multiple pricing models in transition periods.

  ---

  Returns ActorPricingInfo