Records a single event for Events-Based Billing.
Events-Based Billing is an evolved form of metered billing that is based on data-rich events streamed in real-time from your system to Advanced Billing.
These events can then be transformed, enriched, or analyzed to form the computed totals of usage charges billed to your customers.
This API allows you to stream events into the Advanced Billing data ingestion engine.
Learn more about the feature in general in the Events-Based Billing help docs.
Use this endpoint to record a single event.
Note: this endpoint differs from the standard Chargify API endpoints in that the URL subdomain will be events and your site subdomain will be included in the URL path. For example:
https://events.chargify.com/my-site-subdomain/events/my-stream-api-handleThe username is a Maxio Chargify API key and the password is x. Basic authentication works only with the US and EU environments, which connect to chargify.com directly. The Maxio API Gateway environment does not accept Basic authentication.
In: header
Identifies the Stream for which the event should be published.
If you've attached your own Keen project as an Advanced Billing event data-store, use this parameter to indicate the data-store.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X POST \ --url 'https://events.chargify.com/subdomain/events/api_handle.json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ --data-raw '{ "chargify": { "timestamp": "2020-02-27T17:45:50-05:00", "subscription_id": 1 }}'