- Introduction
- Quickstart
- Webhooks
- Campaign
- Class
- Client
- Retrieves all client for a Tenant
- Creates a new client
- Gets client by ID
- Gets clients birthday list
- Gets clients at risk
- Gets client mandatory fields
- Adds client to blacklist
- Removes client from blacklist
- Updates client details
- Used for partial updates of client details
- Changes client representative
- Lists prospects
- Lists ex-clients
- Resets client password
- Changes client representative for multiple clients
- Lists prospect effective date history
- Transfers prospect
- Company
- Invoice
- Organisation
- Search
- Tax
- Tenant
- Appointments
- Create new appointment
- List appointments
- Change client membership in appointment
- Get appointment
- Update appointment
- Mark client as checked in
- Mark client as no-show
- Substitute coach for appointment
- Reschedule appointment
- Cancel appointment
- List appointments by client ID
- Create appointment complimentory session
- Create appointment
- Reschedule appointment
- Get appointment
- Appointment Types
- Authentication
- Automation
- Call Transactions
- Charge Categories
- Charge Master
- Recurring Class
- Class Booking
- Class Complimentory
- Class Types
- Company level class types
- Client Communication
- Client Tasks
- Client Sales
- Client Waivers
- Client Sessions
- Client Referrals
- Client Offers
- Client Export
- Client Billing
- Client Check-in
- Client Credit Balance
- Client Documents
- Client Invoices
- Client Membership
- Client Open API
- Client Payments
- Client Subscriptions
- Client Memberships
- Client Subscription Cancellation
- Client Subscription Freeze
- Client Trials
- Client Upgrade
- Balance Write Off
- Email Template
- Email Template - Franchise
- Create email template at franchise level
- Get list of email templates at franchise level
- Update email template at franchise level
- Get email template at franchise level
- Delete email template at franchise level
- Mark email template as inactive at franchise level
- Mark email template as active at franchise level
- Email Template - Tenant
- Franchise Groups
- Payment Methods
- Invoices
- Offer Master
- Online Signup
- Subscription
- Sales
- Staff Availability
- List staff availability
- List staff availability by appointment category
- List next available slots by appointment category
- Check staff availability
- Check staff availability for appointment category
- Check staff availability for recurring schedule
- Check staff availability for recurring schedule
- Get staff scheduled unavailability
- List staff availability for tours
- Opportunities
- Opportunity Stage Master
- Payments
- Refunds
- Reports
- Report Filter Schedules
- Access Requests
- Rooms
- Sales Returns
- Email Communication
- SMS
- Service Categories
- Staff Management
- Staff Appointment Type Link
- Staff Notifications
- Staff Schedule
- Subscription Plans
- Subscription Signup
- Tasks
- Task Categories
- Task Open API
- Trial Master
Get Order Summary
GET
/open/companies/{company_uuid}/tenants/{tenant_uuid}/subscription/signup/{sigup_sts_uuid}/get_order_summary
Subscription Signup
Request
Path Params
company_uuid
stringÂ
required
tenant_uuid
stringÂ
required
sigup_sts_uuid
stringÂ
required
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/open/companies//tenants//subscription/signup//get_order_summary'Responses
🟢200OK
text/plain
Body
link_type
enum<string>Â
optional
SignUp -Product -Charge -Balance -Transfer -CreditBalance -Refund -PaymentMethod -GuestLink -Allowed values:
SignUpProductChargeBalanceTransferCreditBalanceRefundPaymentMethodGuestLink
company_id
integer <int32> | nullÂ
optional
tenant_id
integer <int32> | nullÂ
optional
company_uuid
string  | nullÂ
optional
tenant_uuid
string  | nullÂ
optional
plan_id
integer <int32>
optional
subscription_start_date
string <date-time>
optional
subscription_end_date
string <date-time>
optional
subscription_bill_cycle_day
integer <int32>
optional
subscription_category
enum<string>Â
optional
PayAsYouGo - Pay as you goPaidInFull - Paid In fullDropIn - Drop InContract - ContractAllowed values:
PayAsYouGoPaidInFullDropInContract
billing_interval_type
enum<string>Â
optional
Day -Week -Month -Allowed values:
DayWeekMonth
billing_interval_value
integer <int32>
optional
name_primary_language
string  | nullÂ
optional
name_secondary_language
string  | nullÂ
optional
description_primary_language
string  | nullÂ
optional
description_secondary_language
string  | nullÂ
optional
invoice_issue_date
string <date-time>
optional
invoice_billing_name
string  | nullÂ
optional
is_coupon_code_applied
booleanÂ
optional
coupon_code
string  | nullÂ
optional
is_offline_payment
booleanÂ
optional
feature_is_cash_recurring
booleanÂ
optional
charging_today
object (SubscriptionSignUpChargingToday)Â
optional
service_first_charge
object (SubscriptionSignupServiceFirstCharge)Â
optional
service_first_charge_addons
array[object (SubscriptionSignupServiceFirstCharge) {4}]  | nullÂ
optional
service_non_recurring
object (SubscriptionSignupNonRecurringService)Â
optional
signup_charges
array[object (SubscriptionSignupCharges) {19}]  | nullÂ
optional
deposit
array[object (SubscriptionSignUpDeposit) {3}]  | nullÂ
optional
charging_recurring
object (SubscriptionSignupRecurringService)Â
optional
services
array[object (SubscriptionSignupService) {29}]  | nullÂ
optional
prorata_future_recurring
object (SubscriptionSignUpFutureCharge)Â
optional
service_first_charge
object (SubscriptionSignupServiceFirstCharge)Â
optional
service_first_charge_addons
array[object (SubscriptionSignupServiceFirstCharge) {4}]  | nullÂ
optional
service_non_recurring
object (SubscriptionSignupNonRecurringService)Â
optional
signup_charges
array[object (SubscriptionSignupCharges) {19}]  | nullÂ
optional
deposit
array[object (SubscriptionSignUpDeposit) {3}]  | nullÂ
optional
Adhoc_with_Month
array[object (AdHocChargesWithMonthBillingJson) {2}]  | nullÂ
optional
adhoc_charges
object (ChargeBreakUp)Â
optional
month
integer <int32>
optional
contract_length
integer <int32>
optional
subscription_mode
enum<string>Â
optional
SignUp -Transfer -Upgrade -MidCycleAddons -Allowed values:
SignUpTransferUpgradeMidCycleAddons
transfered_details
object (TransferSignUpRequest)Â
optional
id
integer <int32>
optional
transfer_type
enum<string>Â
optional
LocationToLocation -ClientToClient -Allowed values:
LocationToLocationClientToClient
transfer_date
string <date-time>
optional
transfer_to_start_date
string <date-time>
optional
transfer_from_tenantid
integer <int32>
optional
transfer_from_clientId
integer <int64>
optional
transfer_from_subscriptionidÂ
integer <int32>
optional
json
string  | nullÂ
optional
deferred_value
integer <int64>
optional
track_mode
enum<string>Â
optional
StaffWebApp -StaffMobileApp -ClientMobileApp -ClientPurchasePortal -ClientWebsiteWidget -FFMavrick -ClientWebSignup -FFHangfireJob -Widget -Allowed values:
StaffWebAppStaffMobileAppClientMobileAppClientPurchasePortalClientWebsiteWidgetFFMavrickClientWebSignupFFHangfireJobWidget
getout_of_contract_x_days
integer <int32>
optional
is_paid
booleanÂ
optional
invoice_uuid
string  | nullÂ
optional
is_token_generated
booleanÂ
optional
is_presale
booleanÂ
optional
Example
{
"link_type": "SignUp",
"company_id": 0,
"tenant_id": 0,
"company_uuid": "string",
"tenant_uuid": "string",
"plan_id": 0,
"subscription_start_date": "2019-08-24T14:15:22Z",
"subscription_end_date": "2019-08-24T14:15:22Z",
"subscription_bill_cycle_day": 0,
"subscription_category": "PayAsYouGo",
"billing_interval_type": "Day",
"billing_interval_value": 0,
"name_primary_language": "string",
"name_secondary_language": "string",
"description_primary_language": "string",
"description_secondary_language": "string",
"invoice_issue_date": "2019-08-24T14:15:22Z",
"invoice_billing_name": "string",
"is_coupon_code_applied": true,
"coupon_code": "string",
"is_offline_payment": true,
"feature_is_cash_recurring": true,
"charging_today": {
"service_first_charge": {
"service_start_date": "2019-08-24T14:15:22Z",
"service_end_date": "2019-08-24T14:15:22Z",
"service_prorata_days": 0,
"services": [
{
"id": 0,
"service_category_uuid": "string",
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"taxable_cost_in_minor_curr": 0,
"base_cost_in_minor_curr": 0,
"discount_amount_in_minor_curr": 0,
"sessions": 0,
"category_name_pri_lang": "string",
"category_name_sec_lang": "string",
"category_description_pri_lang": "string",
"category_description_sec_lang": "string",
"behaviour": "MemberShip",
"tax_item_code": "string",
"is_base_membership": true,
"require_base_membership": true,
"is_session_owner_required": true,
"session_owner_id": 0,
"category_icon": "string",
"taxgrp_id": 0,
"interval_type": "Day",
"interval_value": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": {
"taxgrp_id": 0,
"taxgrp_name_pri_lang": "string",
"taxgrp_name_sec_lang": "string",
"tax_line_items": [
{
"id": 0,
"amt_in_minor_curr": 0,
"name_pri_lang": "string",
"name_sec_lang": "string",
"type": "CGST",
"rate": 0
}
]
},
"discount_reason": "string",
"plan_id": 0,
"is_addons": true
}
]
},
"service_first_charge_addons": [
{
"service_start_date": "2019-08-24T14:15:22Z",
"service_end_date": "2019-08-24T14:15:22Z",
"service_prorata_days": 0,
"services": [
{
"id": 0,
"service_category_uuid": "string",
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"taxable_cost_in_minor_curr": 0,
"base_cost_in_minor_curr": 0,
"discount_amount_in_minor_curr": 0,
"sessions": 0,
"category_name_pri_lang": "string",
"category_name_sec_lang": "string",
"category_description_pri_lang": "string",
"category_description_sec_lang": "string",
"behaviour": "MemberShip",
"tax_item_code": "string",
"is_base_membership": true,
"require_base_membership": true,
"is_session_owner_required": true,
"session_owner_id": 0,
"category_icon": "string",
"taxgrp_id": 0,
"interval_type": "Day",
"interval_value": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": {
"taxgrp_id": 0,
"taxgrp_name_pri_lang": "string",
"taxgrp_name_sec_lang": "string",
"tax_line_items": [
{
"id": 0,
"amt_in_minor_curr": 0,
"name_pri_lang": "string",
"name_sec_lang": "string",
"type": "CGST",
"rate": 0
}
]
},
"discount_reason": "string",
"plan_id": 0,
"is_addons": true
}
]
}
],
"service_non_recurring": {
"services": [
{
"id": 0,
"service_category_uuid": "string",
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"taxable_cost_in_minor_curr": 0,
"base_cost_in_minor_curr": 0,
"discount_amount_in_minor_curr": 0,
"sessions": 0,
"category_name_pri_lang": "string",
"category_name_sec_lang": "string",
"category_description_pri_lang": "string",
"category_description_sec_lang": "string",
"behaviour": "MemberShip",
"tax_item_code": "string",
"is_base_membership": true,
"require_base_membership": true,
"is_session_owner_required": true,
"session_owner_id": 0,
"category_icon": "string",
"taxgrp_id": 0,
"interval_type": "Day",
"interval_value": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": {
"taxgrp_id": 0,
"taxgrp_name_pri_lang": "string",
"taxgrp_name_sec_lang": "string",
"tax_line_items": [
{
"id": 0,
"amt_in_minor_curr": 0,
"name_pri_lang": "string",
"name_sec_lang": "string",
"type": "CGST",
"rate": 0
}
]
},
"discount_reason": "string",
"plan_id": 0,
"is_addons": true
}
]
},
"signup_charges": [
{
"chrgmst_id": 0,
"chrgmst_service_category_uuid": "string",
"chrgmst_chrg_category_id": 0,
"chrgmst_name_pri_lang": "string",
"chrgmst_name_sec_lang": "string",
"chrgcategory_name_pri_lang": "string",
"chrgcategory_name_sec_lang": "string",
"chrgcategory_description_pri_lang": "string",
"chrgcategory_description_sec_lang": "string",
"chrgcategory_icon": "string",
"chrgmst_tax_item_code": "string",
"chrgmst_net_cost_in_minor_curr": 0,
"chrgmst_base_cost_in_minor_curr": 0,
"chrgmst_discount_amount_in_minor_curr": 0,
"chrgmst_tax_grp_id": 0,
"chrgmst_migration_id": "string",
"adhoc_id": 0,
"tax": {
"taxgrp_id": 0,
"taxgrp_name_pri_lang": "string",
"taxgrp_name_sec_lang": "string",
"tax_line_items": [
{
"id": 0,
"amt_in_minor_curr": 0,
"name_pri_lang": "string",
"name_sec_lang": "string",
"type": "CGST",
"rate": 0
}
]
},
"discount_reason": "string"
}
],
"deposit": [
{
"deposit_id": "string",
"deposit_occurence": 0,
"services": [
{
"id": 0,
"service_category_uuid": "string",
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"taxable_cost_in_minor_curr": 0,
"base_cost_in_minor_curr": 0,
"discount_amount_in_minor_curr": 0,
"sessions": 0,
"category_name_pri_lang": "string",
"category_name_sec_lang": "string",
"category_description_pri_lang": "string",
"category_description_sec_lang": "string",
"behaviour": "MemberShip",
"tax_item_code": "string",
"is_base_membership": true,
"require_base_membership": true,
"is_session_owner_required": true,
"session_owner_id": 0,
"category_icon": "string",
"taxgrp_id": 0,
"interval_type": "Day",
"interval_value": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": {
"taxgrp_id": 0,
"taxgrp_name_pri_lang": "string",
"taxgrp_name_sec_lang": "string",
"tax_line_items": [
{
"id": 0,
"amt_in_minor_curr": 0,
"name_pri_lang": "string",
"name_sec_lang": "string",
"type": "CGST",
"rate": 0
}
]
},
"discount_reason": "string",
"plan_id": 0,
"is_addons": true
}
]
}
]
},
"charging_recurring": {
"services": [
{
"id": 0,
"service_category_uuid": "string",
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"taxable_cost_in_minor_curr": 0,
"base_cost_in_minor_curr": 0,
"discount_amount_in_minor_curr": 0,
"sessions": 0,
"category_name_pri_lang": "string",
"category_name_sec_lang": "string",
"category_description_pri_lang": "string",
"category_description_sec_lang": "string",
"behaviour": "MemberShip",
"tax_item_code": "string",
"is_base_membership": true,
"require_base_membership": true,
"is_session_owner_required": true,
"session_owner_id": 0,
"category_icon": "string",
"taxgrp_id": 0,
"interval_type": "Day",
"interval_value": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": {
"taxgrp_id": 0,
"taxgrp_name_pri_lang": "string",
"taxgrp_name_sec_lang": "string",
"tax_line_items": [
{
"id": 0,
"amt_in_minor_curr": 0,
"name_pri_lang": "string",
"name_sec_lang": "string",
"type": "CGST",
"rate": 0
}
]
},
"discount_reason": "string",
"plan_id": 0,
"is_addons": true
}
]
},
"prorata_future_recurring": {
"service_first_charge": {
"service_start_date": "2019-08-24T14:15:22Z",
"service_end_date": "2019-08-24T14:15:22Z",
"service_prorata_days": 0,
"services": [
{
"id": 0,
"service_category_uuid": "string",
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"taxable_cost_in_minor_curr": 0,
"base_cost_in_minor_curr": 0,
"discount_amount_in_minor_curr": 0,
"sessions": 0,
"category_name_pri_lang": "string",
"category_name_sec_lang": "string",
"category_description_pri_lang": "string",
"category_description_sec_lang": "string",
"behaviour": "MemberShip",
"tax_item_code": "string",
"is_base_membership": true,
"require_base_membership": true,
"is_session_owner_required": true,
"session_owner_id": 0,
"category_icon": "string",
"taxgrp_id": 0,
"interval_type": "Day",
"interval_value": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": {
"taxgrp_id": 0,
"taxgrp_name_pri_lang": "string",
"taxgrp_name_sec_lang": "string",
"tax_line_items": [
{
"id": 0,
"amt_in_minor_curr": 0,
"name_pri_lang": "string",
"name_sec_lang": "string",
"type": "CGST",
"rate": 0
}
]
},
"discount_reason": "string",
"plan_id": 0,
"is_addons": true
}
]
},
"service_first_charge_addons": [
{
"service_start_date": "2019-08-24T14:15:22Z",
"service_end_date": "2019-08-24T14:15:22Z",
"service_prorata_days": 0,
"services": [
{
"id": 0,
"service_category_uuid": "string",
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"taxable_cost_in_minor_curr": 0,
"base_cost_in_minor_curr": 0,
"discount_amount_in_minor_curr": 0,
"sessions": 0,
"category_name_pri_lang": "string",
"category_name_sec_lang": "string",
"category_description_pri_lang": "string",
"category_description_sec_lang": "string",
"behaviour": "MemberShip",
"tax_item_code": "string",
"is_base_membership": true,
"require_base_membership": true,
"is_session_owner_required": true,
"session_owner_id": 0,
"category_icon": "string",
"taxgrp_id": 0,
"interval_type": "Day",
"interval_value": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": {
"taxgrp_id": 0,
"taxgrp_name_pri_lang": "string",
"taxgrp_name_sec_lang": "string",
"tax_line_items": [
{
"id": 0,
"amt_in_minor_curr": 0,
"name_pri_lang": "string",
"name_sec_lang": "string",
"type": "CGST",
"rate": 0
}
]
},
"discount_reason": "string",
"plan_id": 0,
"is_addons": true
}
]
}
],
"service_non_recurring": {
"services": [
{
"id": 0,
"service_category_uuid": "string",
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"taxable_cost_in_minor_curr": 0,
"base_cost_in_minor_curr": 0,
"discount_amount_in_minor_curr": 0,
"sessions": 0,
"category_name_pri_lang": "string",
"category_name_sec_lang": "string",
"category_description_pri_lang": "string",
"category_description_sec_lang": "string",
"behaviour": "MemberShip",
"tax_item_code": "string",
"is_base_membership": true,
"require_base_membership": true,
"is_session_owner_required": true,
"session_owner_id": 0,
"category_icon": "string",
"taxgrp_id": 0,
"interval_type": "Day",
"interval_value": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": {
"taxgrp_id": 0,
"taxgrp_name_pri_lang": "string",
"taxgrp_name_sec_lang": "string",
"tax_line_items": [
{
"id": 0,
"amt_in_minor_curr": 0,
"name_pri_lang": "string",
"name_sec_lang": "string",
"type": "CGST",
"rate": 0
}
]
},
"discount_reason": "string",
"plan_id": 0,
"is_addons": true
}
]
},
"signup_charges": [
{
"chrgmst_id": 0,
"chrgmst_service_category_uuid": "string",
"chrgmst_chrg_category_id": 0,
"chrgmst_name_pri_lang": "string",
"chrgmst_name_sec_lang": "string",
"chrgcategory_name_pri_lang": "string",
"chrgcategory_name_sec_lang": "string",
"chrgcategory_description_pri_lang": "string",
"chrgcategory_description_sec_lang": "string",
"chrgcategory_icon": "string",
"chrgmst_tax_item_code": "string",
"chrgmst_net_cost_in_minor_curr": 0,
"chrgmst_base_cost_in_minor_curr": 0,
"chrgmst_discount_amount_in_minor_curr": 0,
"chrgmst_tax_grp_id": 0,
"chrgmst_migration_id": "string",
"adhoc_id": 0,
"tax": {
"taxgrp_id": 0,
"taxgrp_name_pri_lang": "string",
"taxgrp_name_sec_lang": "string",
"tax_line_items": [
{
"id": 0,
"amt_in_minor_curr": 0,
"name_pri_lang": "string",
"name_sec_lang": "string",
"type": "CGST",
"rate": 0
}
]
},
"discount_reason": "string"
}
],
"deposit": [
{
"deposit_id": "string",
"deposit_occurence": 0,
"services": [
{
"id": 0,
"service_category_uuid": "string",
"service_pri_lang": "string",
"service_sec_lang": "string",
"category_id": 0,
"taxable_cost_in_minor_curr": 0,
"base_cost_in_minor_curr": 0,
"discount_amount_in_minor_curr": 0,
"sessions": 0,
"category_name_pri_lang": "string",
"category_name_sec_lang": "string",
"category_description_pri_lang": "string",
"category_description_sec_lang": "string",
"behaviour": "MemberShip",
"tax_item_code": "string",
"is_base_membership": true,
"require_base_membership": true,
"is_session_owner_required": true,
"session_owner_id": 0,
"category_icon": "string",
"taxgrp_id": 0,
"interval_type": "Day",
"interval_value": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"tax": {
"taxgrp_id": 0,
"taxgrp_name_pri_lang": "string",
"taxgrp_name_sec_lang": "string",
"tax_line_items": [
{
"id": 0,
"amt_in_minor_curr": 0,
"name_pri_lang": "string",
"name_sec_lang": "string",
"type": "CGST",
"rate": 0
}
]
},
"discount_reason": "string",
"plan_id": 0,
"is_addons": true
}
]
}
]
},
"Adhoc_with_Month": [
{
"adhoc_charges": {
"id": 0,
"name_primary_language": "string",
"name_secondary_language": "string",
"amount_in_minor_currency": 0,
"discount_amt_in_minor_currency": 0,
"taxable_cost_in_minor_currency": 0,
"taxgrp_id": 0,
"tax": [
{
"id": 0,
"type": "CGST",
"amt_in_minor_currency": 0,
"rate": 0
}
]
},
"month": 0
}
],
"contract_length": 0,
"subscription_mode": "SignUp",
"transfered_details": {
"id": 0,
"transfer_type": "LocationToLocation",
"transfer_date": "2019-08-24T14:15:22Z",
"transfer_to_start_date": "2019-08-24T14:15:22Z",
"transfer_from_tenantid": 0,
"transfer_from_clientId": 0,
"transfer_from_subscriptionid ": 0,
"json": "string",
"deferred_value": 0
},
"track_mode": "StaffWebApp",
"getout_of_contract_x_days": 0,
"is_paid": true,
"invoice_uuid": "string",
"is_token_generated": true,
"is_presale": true
}🟠400Bad Request
Modified at 2025-03-21 07:23:14