Skip to main content

Charge events in run

POST 
/v2/actor-runs/:runId/charge

Charge for events in the run of your pay per event Actor. The event you are charging for must be one of the configured events in your Actor. If the Actor is not set up as pay per event, or if the event is not configured, the endpoint will return an error. The endpoint must be called from the Actor run itself, with the same API token that the run was started with.

Learn more about pay-per-event pricing

For more details about pay-per-event (PPE) pricing, refer to our PPE documentation.

Request

Path Parameters

    runId string required

    Run ID.


    Example: 3KH8gEpp4d8uQSe8T

Header Parameters

    idempotency-key string

    Always pass a unique idempotency key (any unique string) for each charge to avoid double charging in case of retries or network errors.


    Example: 2024-12-09T01:23:45.000Z-random-uuid

Bodyrequired

Define which event, and how many times, you want to charge for.

  • eventName string required
    Example: ANALYZE_PAGE
  • count integer required
    Example: 1

Status 201

The charge was successful. Note that you still have to make sure in your Actor that the total charge for the run respects the maximum value set by the user, as the API does not check this. Above the limit, the charges reported as successful in API will not be added to your payouts, but you will still bear the associated costs. Use the Apify charge manager or SDK to avoid having to deal with this manually.