SOsolvapay
Purchases

List purchases for provider

Changed on

Retrieves all purchases for the authenticated provider with optional filtering by status, product, or customer.

get/v1/sdk/purchases

Request

Query parameters

status'pending' | 'active' | 'trialing' | 'past_due' | 'cancelled' | 'expired' | 'suspended' | 'refunded'

Filter by purchase status

productRefstring

Filter by product reference

customerRefstring

Filter by customer reference

includeFreeboolean

Include free recurring purchases and free auto-enrollments (default true)

Response

Purchases retrieved successfully

Example response

{
  "purchases": [
    {
      "amount": 9900,
      "cancellationReason": "Customer request",
      "cancelledAt": "2025-10-28T10:00:00Z",
      "currency": "GBP",
      "customerEmail": "customer@example.com",
      "customerRef": "cus_3C4D5E6F",
      "endDate": "2025-11-27T10:00:00Z",
      "exchangeRate": 1.32,
      "isRecurring": true,
      "origin": "paid",
      "originalAmount": 7500,
      "planRef": "pln_abc123",
      "planSnapshot": {
        "currency": "USD",
        "isMetered": true,
        "name": "Pro Monthly",
        "price": 2999,
        "reference": "pln_1A2B3C4D"
      },
      "productName": "API Gateway Manager",
      "productRef": "prd_abc123",
      "reference": "pur_1A2B3C4D",
      "startDate": "2025-10-27T10:00:00Z",
      "status": "active",
      "usage": {
        "periodEnd": "2025-11-01T00:00:00Z",
        "periodStart": "2025-10-01T00:00:00Z"
      }
    }
  ]
}

Changes

  • e13ee57d07a6Revision changes
    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

  • aacdf8ae7816Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property /////// to the response with the status