Purchases

List purchases for provider

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

get/v1/sdk/purchases

Query parameters

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,
      "currency": "GBP",
      "customerEmail": "customer@example.com",
      "customerRef": "cus_3C4D5E6F",
      "exchangeRate": 1.3082,
      "isRecurring": true,
      "origin": "paid",
      "originalAmount": 10000,
      "planSnapshot": {
        "currency": "USD",
        "name": "Pro Monthly",
        "price": 2999,
        "reference": "pln_1A2B3C4D"
      },
      "productName": "API Gateway Manager",
      "productRef": "prd_1A2B3C4D",
      "reference": "pur_1A2B3C4D",
      "status": "active",
      "usage": {
        "periodEnd": "2025-11-01T00:00:00Z",
        "periodStart": "2025-10-01T00:00:00Z",
        "used": 150
      }
    }
  ]
}

Changes

Changed in 14 of the 27 revisions of this API.202642

Aug 13, 2026e356f6586bf24See the full diff
- ●
  removed the optional property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/billingCycle from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/includedUnits from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/meterRef from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/type from the response with the 200 status
  response-optional-property-removed
Aug 5, 2026032545ac8d13143See the full diff
- ▲
  removed the required property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/planType from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/creditsPerUnit from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/freeUnits from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/limit from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/limits from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/includedUnits to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/options to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/type to the response with the 200 status
  response-optional-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 30, 20268578b7536a9f22See the full diff
- ▲
  the response property purchases/items/customerEmail became optional for the status 200
  response-property-became-optional
- ▲
  the response property purchases/items/productRef became optional for the status 200
  response-property-became-optional
- ○
  added the optional property purchases/items/origin to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property purchases/items/requiresPayment to the response with the 200 status
  response-optional-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 17, 2026bbc2ff2bc8492See the full diff
- ●
  for the query request parameter customerRef, the maxLength was set to 20
  request-parameter-max-length-set
- ●
  for the query request parameter productRef, the maxLength was set to 20
  request-parameter-max-length-set
Jul 4, 202618486adb15ea1See the full diff
- ▲
  for the query request parameter includeFree, the type/format was changed from / to boolean/
  request-parameter-type-changed
Jul 4, 2026a30b6aef464d3See the full diff
- ○
  the endpoint scheme security SecretKey was added to the API
  api-security-added
- ○
  the endpoint scheme security bearer was removed from the API
  api-security-removed
- ○
  added the new optional query request parameter includeFree
  new-optional-request-parameter
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 26, 202660c2cd1caf831See the full diff
- ○
  added the optional property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/name to the response with the 200 status
  response-optional-property-added
This revision also has 192 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 9, 20267b327a22e3cb11See the full diff
- ●
  removed the optional property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/pricePerUnit from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property purchases/items/planSnapshot/allOf[SdkPlanSnapshotDto]/creditsPerUnit to the response with the 200 status
  response-optional-property-added
Apr 8, 2026052cc028fdfa134See the full diff
- ▲
  removed the required property purchases/items/id from the response with the 200 status
  response-required-property-removed
- ●
  deleted the query request parameter customerId
  request-parameter-removed
- ●
  deleted the query request parameter productId
  request-parameter-removed
- ●
  removed the optional property purchases/items/productId from the response with the 200 status
  response-optional-property-removed
- ○
  added the new optional query request parameter customerRef
  new-optional-request-parameter
- ○
  added the new optional query request parameter productRef
  new-optional-request-parameter
- ○
  added SdkPlanSnapshotDto to the purchases/items/planSnapshot response property allOf list for the response status 200
  response-property-all-of-added
- ○
  removed PlanSnapshotDto from the purchases/items/planSnapshot response property allOf list for the response status 200
  response-property-all-of-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 4, 202688abf6f50f11113See the full diff
- ▲
  the response property purchases/items/planSnapshot became optional for the status 200
  response-property-became-optional
- ●
  removed the optional property purchases/items/isFreeTier from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property purchases/items/exchangeRate to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property purchases/items/metadata to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property purchases/items/originalAmount to the response with the 200 status
  response-optional-property-added
This revision also has 44 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (14 revisions)