Get package - NeetoCal API

{ "package": { "id": "aff17ff8-1bf8-4e77-a3c5-2f86104f9a20", "name": "Consultation Package", "slug": "consultation-package", "status": "enabled", "duration": 7200, "fee": { "id": "1b217cc5-69b5-4fb1-a13c-c22f9c14e7f9", "amount": "120.0", "currency": "inr", "feeable_id": "aff17ff8-1bf8-4e77-a3c5-2f86104f9a20", "feeable_type": "Package", "payment_provider": "cash", "kind": "fixed", "min_amount": "120.0", "is_default": true, "display_amount": "<string>", "vpas": [ {} ], "amount_in_smallest_currency_unit": 12000 } } }

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

Response

200 - application/json

OK - Request succeeded

package

object

Hide child attributes

package.id

string

Unique identifier for the package.

Example:

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

package.name

string

Human-readable name for the package.

Example:

"Consultation Package"

package.slug

string

URL-friendly identifier for the package, used in public URLs and API calls.

Example:

"consultation-package"

package.status

enum<string>

Current status of the package (e.g., "enabled", "disabled").

Available options:

enabled,

disabled

Example:

"enabled"

package.duration

integer

Duration of the package in seconds.

Example:

7200

package.fee

object

Fee configuration for the package, including amount, currency, and payment settings.

Hide child attributes

package.fee.id

string

Unique identifier for the fee configuration.

Example:

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

package.fee.amount

string

The fee amount as a string to preserve decimal precision.

Example:

"120.0"

package.fee.currency

string

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

Example:

"inr"

package.fee.feeable_id

string

ID of the entity this fee is associated with (package ID in this case).

Example:

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

package.fee.feeable_type

string

Type of entity this fee is associated with.

Example:

"Package"

package.fee.payment_provider

enum<string>

Payment service provider used for processing payments.

Available options:

stripe,

razorpay,

cash,

paypal,

dodopayments

Example:

"cash"

package.fee.kind

string

Type of fee structure (e.g., "fixed", "percentage").

Example:

"fixed"

package.fee.min_amount

string

Minimum amount that can be charged for this fee.

Example:

"120.0"

package.fee.is_default

boolean

Indicates whether this is the default fee configuration for the package.

package.fee.display_amount

string | null

Custom display amount for the fee (if different from the actual amount).

package.fee.vpas

object[]

Virtual Payment Addresses for UPI payments (India-specific).

package.fee.amount_in_smallest_currency_unit

integer

Fee amount in the smallest currency unit (e.g., paise for INR, cents for USD).

Example:

12000