How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Paid

Paid orders API

The orders API from Paid — 14 operation(s) for orders.

Documentation Provider Profile APIs.io OpenAPI GitHub

Paid orders API is one of 22 APIs that Paid publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 19 operations across 14 paths, and defines 78 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.agentpaid.io/api/v1.

19 operations 14 paths 78 schemas 2 DELETE7 GET8 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.agentpaid.io/api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Paid orders API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

Paths & Operations 19

Across 14 paths, the API surfaces 19 operations — 2 DELETE, 7 GET, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

orders 19
GET
/orders
List orders
list 1 param → 200
POST
/orders
Create order
create 1 param body → 201
GET
/orders/{orderId}
Get order by ID
get 2 params → 200
DELETE
/orders/{orderId}
Delete order
delete 2 params → 204
POST
/orders/{orderId}/activate
Activate order
activate 2 params → 200
POST
/orders/{orderId}/activate-and-pay
Activate order and process payment
activate-and-pay 2 params body → 200400403404
POST
/orders/{orderId}/cancel
Cancel order renewal
cancel-renewal 2 params body → 200400403404
POST
/orders/{orderId}/schedule-plan-change
Schedule a plan change with proration
schedule-plan-change 2 params body → 200400403404
GET
/orders/{orderId}/invoices
Get invoices for an order
get-invoices 2 params → 200403404
GET
/orders/
List orders
list-orders 12 params → 200400403500
POST
/orders/
Create a new order
create-order 1 param body → 201400403500
GET
/orders/{id}
Get order
get-order-by-id 2 params → 200403404500
PUT
/orders/{id}
Update order
update-order-by-id 2 params body → 200400403404500
DELETE
/orders/{id}
Delete order
delete-order-by-id 2 params → 200403404500
POST
/orders/{id}/activate
Activate order
activate-order-by-id 2 params → 200400403404500
GET
/orders/{id}/lines
Get order lines
get-order-lines 4 params → 200403404500
GET
/orders/{id}/seats
List seats
list-order-seats 6 params → 200400403404500
PUT
/orders/{id}/seats/{seatId}
Assign or unassign seat
update-order-seat-assignment 3 params body → 200400403404409500
POST
/orders/{id}/seat-assignments
Batch assign seats
batch-order-seat-assignments 2 params body → 200400403404409500

Schemas 78

The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are Order_2 (30 properties), CreateOrderRequest (19 properties), Invoice (18 properties), Order (16 properties). Each schema is shown below with its type and property counts.

Agent
object
8 properties 4 required
PricingModelType
string
Customer
object
13 properties 3 required
CreateOrderLineAttributeRequestPricingBillingFrequency
string
OrderCreationState
string
Invoice
object
An invoice for an order
18 properties
CreateOrderLineAttributeRequestPricingCreditBenefitsItemsRecipient
string
EmptyResponse
object
OrderLineAttributePricing
object
5 properties
SeatAssignmentStatus
string
Pagination
object
4 properties 4 required
CreateOrderLineAttributeRequestPricingPricingInput
object
1 property 1 required
OrderCreate
object
10 properties 3 required
OrdersGetParametersCreationState
string
OrderLineType
string
CancelRenewalResponse
object
Response after successfully cancelling an order's renewal
5 properties 5 required
UpdateSeatAssignmentRequest
object
1 property 1 required
ErrorResponse
object
3 properties 1 required
Tier
object
3 properties
ProrationDetail
object
Details about the proration calculation for an attribute
8 properties
SeatAssignee
object
3 properties 3 required
Order
object
16 properties
AgentPricePoint
object
4 properties
OrderLinesResponse
object
2 properties 2 required
CreateOrderLineAttributeRequestPricingPricePointsTiersItems
object
7 properties
ChargeType
string
OrderBillingFrequencyOverrideFrequency
string
CreateOrderLineAttributeRequestPricingBillingType
string
orders_delete_Response_204
object
Empty response body
ProrationUpgradeRequest
object
Request to schedule a plan change with proration
3 properties 3 required
OrderListResponse
object
2 properties 2 required
CreateOrderLineAttributeRequestPricingChargeType
string
OrderLine_2
object
7 properties 7 required
CreateOrderRequest
object
19 properties 1 required
BatchSeatAssignmentsRequestAssignmentsItems
object
2 properties 2 required
Error
object
An error response from the Paid API
1 property 1 required
OrderBillingFrequencyOverride
object
2 properties 1 required
OrdersGetParametersStatus
string
CreateOrderLineRequest
object
When override attributes are omitted, the order will match the base product (or default plan if plans are configured).
7 properties 1 required
CreateOrderLineAttributeRequestPricing
object
15 properties 3 required
CreateOrderLineAttributeRequest
object
3 properties 2 required
BatchSeatAssignmentsRequest
object
1 property 1 required
BatchSeatAssignmentsResponse
object
1 property 1 required
CreateOrderLineAttributeRequestPricingCreditBenefitsItemsCreditGrantTiming
string
CreationState
string
AgentAttribute
object
3 properties 3 required
CreateOrderLineAttributeRequestPricingSignalType
string
ApiError
object
An API error response from the Paid API
3 properties
OrderSeatListResponse
object
2 properties 2 required
CreateOrderLineAttributeRequestPricingPricePoints
object
Single flat price point for this order attribute override. Do not send a currency-keyed map here.
5 properties 1 required
CreateOrderLineAttributeRequestPricingCreditBenefitsItemsAllocationCadence
string
CreateOrderLineAttributeRequestPricingPricingInputKind
string
ProrationUpgradeResponse
object
Response after successfully scheduling a plan change
8 properties 8 required
PricePoint
object
4 properties
OrdersIdSeatsGetParametersStatus
string
CreateOrderLineAttributeRequestPricingPricePointsTiersItemsTierBillingType
string
CreateOrderLineAttributeRequestPricingPricingModel
string
OrderLineAttribute
object
4 properties
CustomerMetadata
object
Flexible JSON field for storing custom metadata about the customer
CreateOrderLineAttributeRequestPricingCreditUnitBracketsItems
object
2 properties 2 required
Address
object
6 properties 5 required
UpdateOrderRequest
object
15 properties
Pricing
object
7 properties 5 required
BillingFrequency
string
InvoiceStatus
string
OrderLineAttributeCreate
Order_2
object
30 properties 29 required
OrderLineCreate
object
8 properties
OrderLine
object
14 properties
CancelRenewalRequest
object
Request to cancel an order's renewal
2 properties 2 required
TaxExemptStatus
string
CreationSource
string
CreateOrderLineAttributeRequestPricingCreditBenefitsItems
object
9 properties 2 required
ProrationAttributeUpdate
object
An attribute update for a proration upgrade
3 properties 2 required
CreateOrderLineAttributeRequestPricingCreditBenefitsItemsRolloverDurationUnit
string
OrderSeat
object
7 properties 7 required
WritableOrderLineType
string
Defaults to STANDARD. Set to CREDIT for customer-authored, term-bound discount lines whose amounts contribute negatively to invoice aggregates.
AgentPricePointTiers
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paid-orders-api-openapi.yml Raw ↑

Other APIs Paid publishes across the network.

Paid agents API
AE Profile APIs.io
Paid analyticsExperimental API
AE Profile APIs.io
Paid checkouts API
AE Profile APIs.io
Paid contacts API
AE Profile APIs.io
Paid costs API
AE Profile APIs.io
Paid credits API
AE Profile APIs.io
Paid customer-groups API
AE Profile APIs.io
Paid customer-portals API
AE Profile APIs.io
Paid customers API
AE Profile APIs.io
Paid customViewsExperimental API
AE Profile APIs.io
Paid invoices API
AE Profile APIs.io
Paid orders > lines API
AE Profile APIs.io
#Order
← Back to P APIs
API Details
ID
paid:paid-orders-api
Base URL
https://api.agentpaid.io/api/v2
Docs
https://docs.paid.ai/api-reference/api-reference
Provider
Paid
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=paid-orders-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/paid-orders-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Paid orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.