List package purchases - NeetoCal API

{ "purchases": [ { "id": "1b217cc5-69b5-4fb1-a13c-c22f9c14e7f9", "name": "John Doe", "email": "john@example.com", "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 } }

Headers

X-Api-Key

string

required

Use the X-Api-Key header to provide your workspace API key. 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 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.

Hide child attributes

purchases.id

string

Unique identifier for the purchase.

Example:

"1b217cc5-69b5-4fb1-a13c-c22f9c14e7f9"

purchases.name

string

Name of the person who made the purchase.

Example:

"John Doe"

purchases.email

string<email>

Email address of the person who made the purchase.

Example:

"john@example.com"

purchases.purchase_code

string

Unique code associated with the purchase.

Example:

"PUR-123456"

purchases.duration_remaining

integer

Remaining duration in seconds for the purchased package.

Example:

3600

purchases.status

string

Current status of the purchase.

Example:

"confirmed"

purchases.notes

string | null

Additional notes or comments about the purchase.

Example:

"Customer requested priority support"

purchases.package_id

string

ID of the package that was purchased.

Example:

"aff17ff8-1bf8-4e77-a3c5-2f86104f9a20"

purchases.duration

integer

Total duration in seconds of the purchased package.

Example:

7200

purchases.created_at

string<date-time>

Timestamp when the purchase was created.

Example:

"2023-12-01T10:00:00Z"

purchases.updated_at

string<date-time>

Timestamp when the purchase was last updated.

Example:

"2023-12-01T10:30:00Z"

pagination

object

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

Hide child attributes

pagination.total_records

integer

Total number of records.

pagination.total_pages

integer

Total number of pages available.

pagination.current_page_number

integer

Current page number.

pagination.page_size

integer

Number of records per page.