/
PA
paid
/
API Reference
Search skmtc…
⌘K
Changes
Docs
Sign in
Docs
History
Schema
Filter operations
agents
8
contacts
6
customers
15
orders
9
get
/orders
List orders
post
/orders
Create order
get
/orders/{orderId}
Get order by ID
delete
/orders/{orderId}
Delete order
post
/orders/{orderId}/activate
Activate order
post
/orders/{orderId}/activate-and-pay
Activate order and process payment
post
/orders/{orderId}/cancel
Cancel order renewal
post
/orders/{orderId}/schedule-plan-change
Schedule a plan change with proration
get
/orders/{orderId}/invoices
Get invoices for an order
orders > lines
1
plans
8
products
8
traces
1
usage
3
orders
Copy Markdown
Copied
Copy failed
List orders
get
/orders
Request
Base URL:
https://api.agentpaid.io/api/v1
URL:
https://api.agentpaid.io/api/v1/orders
Auth:
HTTP bearer
Response
Success response
Order[]
required
id
string
name
string
description
string
customerId
string
organizationId
string
startDate
string
endDate
string
totalAmount
number
double
estimatedTax
number
double
billedAmountNoTax
number
double
billedTax
number
double
totalBilledAmount
number
double
pendingBillingAmount
number
double
creationState
'active'
|
'draft'
orderLines
Order
Line[]
customer
Customer
Changes
No recorded changes to this operation across all 1 revision of this API.