Skip to main content
GET
/
v0
/
orders
List orders
curl --request GET \
  --url https://api.paygentic.io/v0/orders \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "order",
      "merchantId": "<string>",
      "customerId": "<string>",
      "resellerId": "<string>",
      "taxExempt": true,
      "sellingEntity": "<string>",
      "currency": "<string>",
      "cancelledAt": "2023-11-07T05:31:56Z",
      "termStartDate": "2023-11-07T05:31:56Z",
      "termEndDate": "2023-11-07T05:31:56Z",
      "totalAmount": "<string>",
      "defaultPaymentTermDays": 123,
      "metadata": {},
      "lineItems": [
        {
          "id": "<string>",
          "object": "order_line_item",
          "orderId": "<string>",
          "quantity": "<string>",
          "listUnitPrice": "<string>",
          "discountUnitAmount": "<string>",
          "unitPrice": "<string>",
          "totalPrice": "<string>",
          "termStartDate": "2023-11-07T05:31:56Z",
          "termEndDate": "2023-11-07T05:31:56Z",
          "metadata": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "itemId": "<string>",
          "description": "<string>"
        }
      ],
      "billingSchedules": [
        {
          "id": "<string>",
          "object": "billing_schedule",
          "merchantId": "<string>",
          "startDate": "2023-11-07T05:31:56Z",
          "endDate": "2023-11-07T05:31:56Z",
          "billingAnchor": "2023-11-07T05:31:56Z",
          "metadata": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "orderId": "<string>",
          "subscriptionId": "<string>",
          "paymentTermDays": 123
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "closeDate": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

Authorization
string
header
required

API key authentication

Query Parameters

merchantId
string

Filter by merchant

customerId
string

Filter by customer

status
enum<string>

Filter by status

Available options:
draft,
pending,
approved,
rejected,
cancelled
type
enum<string>

Filter by type

Available options:
new_business,
renewal,
expansion
limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

List of orders

object
enum<string>
required
Available options:
list
data
object[]
required
pagination
object
required

Offset-based pagination response.