Skip to main content
GET
/
packages
/
{package_id}
/
purchases
List package purchases
curl --request GET \
  --url https://{your-workspace}.neetocal.com/api/external/v1/packages/{package_id}/purchases \
  --header 'X-Api-Key: <x-api-key>'
{
  "purchases": [
    {
      "id": "1b217cc5-69b5-4fb1-a13c-c22f9c14e7f9",
      "name": "John Doe",
      "email": "[email protected]",
      "purchase_code": "PUR-123456",
      "duration_remaining": 3600,
      "status": "confirmed",
      "notes": "Customer requested priority support",
      "package_id": "aff17ff8-1bf8-4e77-a3c5-2f86104f9a20",
      "duration": 7200,
      "created_at": "2023-12-01T10:00:00Z",
      "updated_at": "2023-12-01T10:30:00Z"
    }
  ],
  "pagination": {
    "total_records": 123,
    "total_pages": 123,
    "current_page_number": 123,
    "page_size": 123
  }
}
Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

​
X-Api-Key
string
required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Path Parameters

​
package_id
string
required

Id of the package to retrieve purchases for. You can get package_id by listing all packages using our List all packages API. Here you will see id for each package.

Query Parameters

​
page_number
integer

Retrieve paginated results by specifying the desired page number. If this parameter is absent, all results will be returned.

​
page_size
integer

Set the number of results returned in the response. Defaulting to 30 when omitted.

Response

200 - application/json

OK - Request succeeded

​
purchases
object[]

Array of purchases for the specified package.

​
pagination
object

Pagination information including total records, pages, and current page details.