Support
Orb dashboard
Orb dashboard

Implementation guides

Revenue reporting

API documentation

Request idempotency
Pagination
Error responses
Rate limits
Reliability and scaling
Cached usage responses

Alert

GET
List alerts
POST
Create customer alert
POST
Create customer alert by external ID
POST
Create subscription alert
PUT
Update alert
POST
Disable alert by ID
POST
Enable alert by ID
GET
Fetch alert

Coupon

GET
List coupons
POST
Create coupon
GET
Fetch coupon
POST
Archive coupon
GET
List coupon subscriptions

Credit note

GET
List credit notes
POST
Create credit note
GET
Fetch credit note

Customer

GET
List customers
POST
Create customer
GET
Fetch customer by external ID
PUT
Update customer by external ID
GET
Fetch customer costs by external ID
POST
Update payment methods from payment provider
GET
Fetch customer
PUT
Update customer
DEL
Delete customer
GET
List balance transactions
POST
Create customer balance transaction
GET
Fetch customer costs
POST
Update payment methods from payment provider

Credit

GET
Fetch customer credit balance by external customer id
GET
Fetch customer credits ledger by external ID
POST
Create ledger entry by external ID
GET
List top-ups by external ID
POST
Create top-up by external ID
DEL
Deactivate top-up by external ID
GET
Fetch customer credit balance
GET
Fetch customer credits ledger
POST
Create ledger entry
GET
List top-ups
POST
Create top-up
DEL
Deactivate top-up

Dimensional Price Group

GET
List dimensional price groups
POST
Create dimensional price group
GET
Fetch dimensional price group by external ID
PUT
Update dimensional price group by external ID
GET
Fetch dimensional price group
PUT
Update dimensional price group

Event

GET
List backfills
POST
Create backfill
GET
Fetch backfill
POST
Close backfill
POST
Revert backfill
POST
Search events
GET
Get event volume
PUT
Amend event
PUT
Deprecate event
POST
Ingest events

Invoice

POST
Create invoice line item
GET
List invoices
POST
Create a one-off invoice
GET
Fetch upcoming invoice
GET
Fetch invoice
PUT
Update invoice
POST
Issue invoice
POST
Mark invoice as paid
POST
Pay invoice
POST
Void invoice

Item

GET
List items
POST
Create item
GET
Fetch item
PUT
Update item
POST
Archive item

Metric

GET
List metrics
POST
Create metric
GET
Get metric
PUT
Update metric

Availability

GET
Check availability

Plan

GET
List plans
POST
Create plan
GET
Fetch plan by external ID
PUT
Update plan by external ID
POST
Set plan version as default by external ID
POST
Create plan version by external ID
GET
Fetch plan version by external ID
GET
Fetch plan
PUT
Update plan by id
POST
Set plan version as default
POST
Create plan version
GET
Fetch plan version

Price

GET
List prices
POST
Create price
POST
Evaluate multiple prices
POST
Evaluate preview events
GET
Fetch price by external price id
PUT
Update price by external price id
GET
Fetch price
PUT
Update price
POST
Evaluate price

Subscription Change

GET
List subscription changes
GET
Fetch subscription change
POST
Apply subscription change
POST
Cancel subscription change

Subscription

GET
List subscriptions
POST
Create subscription
GET
Fetch subscription
PUT
Update subscription
POST
Cancel subscription
GET
Fetch subscription costs
POST
Redeem Coupon
GET
Fetch subscription schedule
POST
Schedule plan change
POST
Trigger phase
POST
Unschedule subscription cancellation
POST
Unschedule fixed fee quantity updates
POST
Unschedule plan change
POST
Update price quantity
POST
Update trial for subscription
GET
Fetch subscription usage

Price interval

POST
Add or edit price intervals

404

Page Not Found

We couldn't find the page you were looking for. Maybe you were looking for?

Fetch subscription schedule Schedule plan change Fetch subscription change

Assistant

Responses are generated using AI and may contain mistakes.