Get package purchase - NeetoCal API

{ "purchase": { "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", "payment": { "amount": "120.0", "currency": "inr", "status": "successful", "payment_provider": "stripe", "payment_at": "2023-12-01T10:30:00Z" } } }

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. You can get package_id by listing all packages using our List packages API. Here you will see id for each package.

purchase_id

string

required

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

Response

200 - application/json

OK - Request succeeded

purchase

object

Detailed purchase information including payment details.

Hide child attributes

purchase.id

string

Unique identifier for the purchase.

Example:

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

purchase.name

string

Name of the person who made the purchase.

Example:

"John Doe"

purchase.email

string<email>

Email address of the person who made the purchase.

Example:

"john@example.com"

purchase.purchase_code

string

Unique code associated with the purchase.

Example:

"PUR-123456"

purchase.duration_remaining

integer

Remaining duration in seconds for the purchased package.

Example:

3600

purchase.status

string

Current status of the purchase.

Example:

"confirmed"

purchase.notes

string | null

Additional notes or comments about the purchase.

Example:

"Customer requested priority support"

purchase.package_id

string

ID of the package that was purchased.

Example:

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

purchase.duration

integer

Total duration in seconds of the purchased package.

Example:

7200

purchase.created_at

string<date-time>

Timestamp when the purchase was created.

Example:

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

purchase.updated_at

string<date-time>

Timestamp when the purchase was last updated.

Example:

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

purchase.payment

object

Payment information associated with the purchase.

Hide child attributes

purchase.payment.amount

string

The payment amount as a string to preserve decimal precision.

Example:

"120.0"

purchase.payment.currency

string

The currency code for the payment amount. Follows the ISO 4217 standard (e.g., "inr", "usd").

Example:

"inr"

purchase.payment.status

enum<string>

Current status of the payment.

Available options:

successful,

authorized,

declined,

pending,

requires_action,

requires_confirmation,

requires_payment_method,

confirmation_pending,

initiated,

rejected

Example:

"successful"

purchase.payment.payment_provider

enum<string>

Payment service provider used for processing the payment.

Available options:

stripe,

razorpay,

cash,

paypal,

dodopayments

Example:

"stripe"

purchase.payment.payment_at

string<date-time>

Timestamp when the payment was processed.

Example:

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