Skip to main content
GET
/
v1
/
orders
TypeScript SDK
import { Solifyn } from 'solifyn';

const solifyn = new Solifyn({ apiKey: 'your_private_api_key_here' });

// List and query orders
const orders = await solifyn.orders.list({
  pageNumber: 1,
  pageSize: 10,
  status: 'paid'
});
console.log('Orders:', orders);
{
  "items": [
    {
      "id": "pay_123",
      "invoice_url": "https://solifyn.com/transactions/payments/pay_123/print",
      "customer": {
        "customer_id": "usr_123",
        "email": "customer@example.com",
        "name": "John Doe",
        "username": "johndoe"
      },
      "total_amount": 2900,
      "subtotal": 2900,
      "tax_amount": 0,
      "application_fee": 150,
      "amount_after_fees": 2750,
      "currency": "usd",
      "status": "paid",
      "created_at": "2026-05-22T08:00:00Z",
      "payment_method": "card",
      "product_cart": [
        {
          "id": "prod_123",
          "name": "SaaS Pro Access",
          "quantity": 1,
          "price": 2900,
          "pricingType": "one_time"
        }
      ],
      "refundable": true,
      "businessId": "biz_123",
      "businessName": "Acme SaaS Corp",
      "usdTotal": 30.6,
      "paidAt": "2026-05-22T08:05:00Z",
      "card_last_four": "4242",
      "card_network": "visa",
      "card_type": "visa",
      "billing": {
        "street": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "zipcode": "94105",
        "country": "US"
      },
      "metadata": {},
      "order": {
        "filesSnapshot": [
          "<string>"
        ],
        "licenseKey": "FYN-XXXX-YYYY",
        "status": "completed"
      },
      "refunds": [
        {
          "refund_id": "ref_123",
          "payment_id": "pay_123",
          "amount": 1000,
          "currency": "usd",
          "status": "succeeded",
          "is_partial": true,
          "created_at": "2026-05-22T08:00:00Z",
          "reason": "requested_by_customer"
        }
      ],
      "billing_reason": "subscription_cycle"
    }
  ],
  "total_count": 120
}

Authorizations

Authorization
string
header
required

Authenticate requests using your standard bearer API key (e.g. YOUR_API_KEY).

Query Parameters

createdAtLte
string

Filter by creation date less than or equal to.

createdAtGte
string

Filter by creation date greater than or equal to.

product_id
string

Filter by product identifier.

customer_id
string

Filter by customer identifier.

status
string

Filter by order/payment status.

pageSize
number
default:10

Size of a page, defaults to 10. Maximum is 100.

pageNumber
number
default:1

Page number, defaults to 1.

Response

200 - application/json

List of orders/payments retrieved successfully.

items
object[]
required

List of order items.

total_count
integer
required

Total number of items matching filters.

Example:

120