Event Ingestion
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.
For more information, see Design Your Catalog.
Note: this endpoint differs from the standard URL for this API in that events and your site subdomain are included in the path. For example:
https://events.chargify.com/my-site-subdomain/events/my-stream-api-handleAuthorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
Identifies the Stream for which the event should be published.
Query Parameters
If you've attached your own Keen project as an Advanced Billing event data-store, use this parameter to indicate the data-store. This applies to Legacy Metering sites only — it has no effect on Maxio Metering sites.
Request Body
application/json
Response Body
curl -X POST "https://example.com/events/string.json" \ -H "Content-Type: application/json" \ -d '{ "chargify": { "subscription_id": 1, "timestamp": "2020-02-27T17:45:50-05:00" }, "messages": 150, "country": "US", "customer": { "name": "John", "lastName": "Doe", "address": { "street": "Maple Street", "zip": 4888, "state": "MA" } } }'Deactivate Event-Based Component POST
Deactivates an event-based component for a single subscription. Deactivating the event-based component causes Advanced Billing to ignore related events at subscription renewal.
Bulk Event Ingestion POST
Records a collection of events. Note: this endpoint differs from the standard URL for this API in that `events` and your site subdomain are included in the path. A maximum of 1000 events can be published in a single request. A 422 will be returned if this limit is exceeded.