API documentation
Alert
Credit
- GETFetch credit block
- DELDelete credit block
- GETList invoices for credit block
- 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
Customer
- GETList customers
- POSTCreate customer
- GETFetch customer by external ID
- PUTUpdate customer by external ID
- GETFetch customer costs by external ID
- POSTCreate portal session 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
- POSTCreate portal session
- POSTUpdate payment methods from payment provider
Dimensional Price Group
Event
Invoice
- POSTCreate invoice line item
- GETList invoices
- POSTCreate a one-off invoice
- GETList invoices summary
- POSTIssue invoice summary
- GETFetch upcoming invoice
- GETFetch invoice
- PUTUpdate invoice
- DELDelete invoice line item
- POSTIssue invoice
- POSTMark invoice as paid
- POSTPay invoice
- POSTRegenerate invoice PDF
- POSTRegenerate receipt PDF
- POSTVoid invoice
License
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
- GETList migrations
- GETFetch migration
- POSTCancel migration
- 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
- POSTRedeem Coupon
- 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
curl --request POST \
--url https://api.withorb.com/v1/alerts/subscription_id/{subscription_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"thresholds": [
{
"value": 123
}
],
"type": "usage_exceeded",
"metric_id": "<string>",
"grouping_keys": [
"<string>"
],
"pricing_unit_id": "<string>",
"price_filters": [
{
"field": "price_id",
"operator": "includes",
"values": [
"<string>"
]
}
],
"threshold_overrides": [
{
"group_values": [
"<string>"
],
"thresholds": [
{
"value": 123
}
]
}
]
}
'{
"id": "<string>",
"type": "\"usage_exceeded\", \"cost_exceeded\", \"credit_balance_depleted\", \"credit_balance_recovered\", or \"credit_balance_dropped\"",
"created_at": "2023-11-07T05:31:56Z",
"enabled": true,
"thresholds": [
{
"value": 123
}
],
"customer": {
"id": "<string>",
"external_customer_id": "<string>"
},
"plan": {
"id": "m2t5akQeh2obwxeU",
"external_plan_id": "m2t5akQeh2obwxeU",
"name": "Example plan",
"plan_version": "<string>"
},
"subscription": {
"id": "<string>"
},
"metric": {
"id": "<string>"
},
"currency": "<string>",
"license_type": {
"id": "<string>"
},
"grouping_keys": [
"<string>"
],
"price_filters": [
{
"field": "price_id",
"operator": "includes",
"values": [
"<string>"
]
}
],
"threshold_overrides": [
{
"group_values": [
"<string>"
],
"thresholds": [
{
"value": 123
}
]
}
],
"balance_alert_status": [
{
"threshold_value": 123,
"in_alert": true
}
]
}Create subscription alert
This endpoint is used to create alerts at the subscription level.
Subscription level alerts can be one of two types: usage_exceeded or cost_exceeded. A usage_exceeded alert is
scoped to a particular metric and is triggered when the usage of that metric exceeds predefined thresholds during the
current billing cycle. A cost_exceeded alert is triggered when the total amount due during the current billing cycle surpasses
predefined thresholds. cost_exceeded alerts do not include burndown of pre-purchase credits. Each subscription can have one
cost_exceeded alert and one usage_exceeded alert per metric that is a part of the subscription. Alerts are triggered based
on usage or cost conditions met during the current billing cycle.
curl --request POST \
--url https://api.withorb.com/v1/alerts/subscription_id/{subscription_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"thresholds": [
{
"value": 123
}
],
"type": "usage_exceeded",
"metric_id": "<string>",
"grouping_keys": [
"<string>"
],
"pricing_unit_id": "<string>",
"price_filters": [
{
"field": "price_id",
"operator": "includes",
"values": [
"<string>"
]
}
],
"threshold_overrides": [
{
"group_values": [
"<string>"
],
"thresholds": [
{
"value": 123
}
]
}
]
}
'{
"id": "<string>",
"type": "\"usage_exceeded\", \"cost_exceeded\", \"credit_balance_depleted\", \"credit_balance_recovered\", or \"credit_balance_dropped\"",
"created_at": "2023-11-07T05:31:56Z",
"enabled": true,
"thresholds": [
{
"value": 123
}
],
"customer": {
"id": "<string>",
"external_customer_id": "<string>"
},
"plan": {
"id": "m2t5akQeh2obwxeU",
"external_plan_id": "m2t5akQeh2obwxeU",
"name": "Example plan",
"plan_version": "<string>"
},
"subscription": {
"id": "<string>"
},
"metric": {
"id": "<string>"
},
"currency": "<string>",
"license_type": {
"id": "<string>"
},
"grouping_keys": [
"<string>"
],
"price_filters": [
{
"field": "price_id",
"operator": "includes",
"values": [
"<string>"
]
}
],
"threshold_overrides": [
{
"group_values": [
"<string>"
],
"thresholds": [
{
"value": 123
}
]
}
],
"balance_alert_status": [
{
"threshold_value": 123,
"in_alert": true
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.withorb.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Body
The thresholds that define the values at which the alert will be triggered.
Show child attributes
Show child attributes
The type of alert to create. This must be a valid alert type.
usage_exceeded, cost_exceeded The metric to track usage for.
The property keys to group cost alerts by. Only applicable for cost_exceeded alerts.
The pricing unit to use for grouped cost alerts. Required when grouping_keys is set.
Filters to scope which prices are included in grouped cost alert evaluation. Supports filtering by price_id, item_id, or price_type with includes/excludes operators. Only applicable when grouping_keys is set.
Show child attributes
Show child attributes
Per-group threshold overrides. Each override maps a specific combination of grouping_keys values to a list of thresholds that fully replaces the default thresholds for that group. An empty thresholds list silences the group. Groups without an override use the default thresholds. Only applicable when grouping_keys is set.
Show child attributes
Show child attributes
Response
Created
Alerts within Orb monitor spending, usage, or credit balance and trigger webhooks when a threshold is exceeded.
Alerts created through the API can be scoped to either customers or subscriptions.
Also referred to as alert_id in this documentation.
"XuxCbt7x9L82yyeF"
The type of alert. This must be a valid alert type.
credit_balance_depleted, credit_balance_dropped, credit_balance_recovered "\"usage_exceeded\", \"cost_exceeded\", \"credit_balance_depleted\", \"credit_balance_recovered\", or \"credit_balance_dropped\""
The creation time of the resource in Orb.
Whether the alert is enabled or disabled.
The thresholds that define the conditions under which the alert will be triggered.
Show child attributes
Show child attributes
The customer the alert applies to.
Show child attributes
Show child attributes
The plan the alert applies to.
Show child attributes
Show child attributes
The subscription the alert applies to.
Show child attributes
Show child attributes
The metric the alert applies to.
Show child attributes
Show child attributes
The name of the currency the credit balance or invoice cost is denominated in.
The license type the alert applies to. Only present for license alerts.
Show child attributes
Show child attributes
The property keys to group cost alerts by. Only present for cost alerts with grouping enabled.
Filters scoping which prices are included in grouped cost alert evaluation.
Show child attributes
Show child attributes
Per-group threshold overrides. Each override maps a specific combination of grouping_keys values to a replacement threshold list. Only present for grouped cost alerts that have at least one override.
Show child attributes
Show child attributes
The current status of the alert. This field is only present for credit balance alerts.
Show child attributes
Show child attributes
Was this page helpful?