API documentation
Alert
Customer
- GETList customers
- POSTCreate customer
- GETFetch customer by external ID
- PUTUpdate customer by external ID
- GETFetch customer costs by external ID
- POSTUpdate payment methods from payment provider
- GETFetch customer
- PUTUpdate customer
- DELDelete customer
- GETList balance transactions
- POSTCreate customer balance transaction
- GETFetch customer costs
- POSTUpdate payment methods from payment provider
Credit
- GETFetch customer credit balance by external customer id
- GETFetch customer credits ledger by external ID
- POSTCreate ledger entry by external ID
- GETList top-ups by external ID
- POSTCreate top-up by external ID
- DELDeactivate top-up by external ID
- GETFetch customer credit balance
- GETFetch customer credits ledger
- POSTCreate ledger entry
- GETList top-ups
- POSTCreate top-up
- DELDeactivate top-up
Dimensional Price Group
Event
Invoice
Availability
Plan
- GETList plans
- POSTCreate plan
- GETFetch plan by external ID
- PUTUpdate plan by external ID
- POSTSet plan version as default by external ID
- POSTCreate plan version by external ID
- GETFetch plan version by external ID
- GETFetch plan
- PUTUpdate plan by id
- POSTSet plan version as default
- POSTCreate plan version
- GETFetch plan version
Price
Subscription Change
Subscription
- GETList subscriptions
- POSTCreate subscription
- GETFetch subscription
- PUTUpdate subscription
- POSTCancel subscription
- GETFetch subscription costs
- GETFetch subscription schedule
- POSTSchedule plan change
- POSTTrigger phase
- POSTUnschedule subscription cancellation
- POSTUnschedule fixed fee quantity updates
- POSTUnschedule plan change
- POSTUpdate price quantity
- POSTUpdate trial for subscription
- GETFetch subscription usage
Price interval
Event
Revert backfill
Reverting a backfill undoes all the effects of closing the backfill. If the backfill is reflected, the status will
transition to pending_revert
while the effects of the backfill are undone. Once all effects are undone, the
backfill will transition to reverted
.
If a backfill is reverted before its closed, no usage will be updated as a result of the backfill and it will
immediately transition to reverted
.
POST
/
events
/
backfills
/
{backfill_id}
/
revert
curl --request POST \
--url https://api.withorb.com/v1/events/backfills/{backfill_id}/revert \
--header 'Authorization: Bearer <token>'
{
"id": "<string>",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"events_ingested": 123,
"close_time": "2023-11-07T05:31:56Z",
"reverted_at": "2023-11-07T05:31:56Z",
"customer_id": "<string>",
"deprecation_filter": "my_numeric_property > 100 AND my_other_property = 'bar'",
"replace_existing_events": true
}
Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Response
200
application/json
OK
A backfill represents an update to historical usage data, adding or replacing events in a timeframe.
Was this page helpful?
curl --request POST \
--url https://api.withorb.com/v1/events/backfills/{backfill_id}/revert \
--header 'Authorization: Bearer <token>'
{
"id": "<string>",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"events_ingested": 123,
"close_time": "2023-11-07T05:31:56Z",
"reverted_at": "2023-11-07T05:31:56Z",
"customer_id": "<string>",
"deprecation_filter": "my_numeric_property > 100 AND my_other_property = 'bar'",
"replace_existing_events": true
}
Assistant
Responses are generated using AI and may contain mistakes.