- 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 Status
GET
/open/companies/{company_uuid}/tenants/{tenant_uuid}/subscription/signup/{sigup_sts_uuid}/get_order_subscription_detail
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_subscription_detail'
Responses
🟢200OK
text/plain
Body
signUpOrderSummaryResponse
object (ClientSubscriptionSignUpWithBillingJsonResponse)Â
optional
id
integer <int64>
optional
uuid
string  | nullÂ
optional
company_id
integer <int32>
optional
tenant_id
integer <int32>
optional
company_uuid
string  | nullÂ
optional
tenant_uuid
string  | nullÂ
optional
client_id
integer <int64>
optional
plan_id
integer <int32>
optional
client_subscription_id
integer <int32>
optional
status
enum<string>Â
optional
Created
-Open
-WaiverDone
-MandatoryInformationDone
-AwaitingPayment
-SignUpSuccessfull
-SignUpFailed
-SignUpExpired
-PendingForMandatoryAction
-Void
-Allowed values:
CreatedOpenWaiverDoneMandatoryInformationDoneAwaitingPaymentSignUpSuccessfullSignUpFailedSignUpExpiredPendingForMandatoryActionVoid
final_status
enum<string>Â
optional
Open
-Closed
-Allowed values:
OpenClosed
short_link
string  | nullÂ
optional
full_link
string  | nullÂ
optional
track_mode
enum<string>Â
optional
StaffWebApp
-StaffMobileApp
-ClientMobileApp
-ClientPurchasePortal
-ClientWebsiteWidget
-FFMavrick
-ClientWebSignup
-FFHangfireJob
-Widget
-Allowed values:
StaffWebAppStaffMobileAppClientMobileAppClientPurchasePortalClientWebsiteWidgetFFMavrickClientWebSignupFFHangfireJobWidget
link_expiry_date
string <date-time>
optional
link_last_opened
string <date-time>
optional
created_by
integer <int32>
optional
created_date
string <date-time>
optional
updated_by
integer <int32>
optional
updated_date
string <date-time>
optional
order_details
object (SubscriptionSignUpOrderSummaryResponse)Â
optional
task_id
integer <int64>
optional
opportunity_id
integer <int64>
optional
booking_id
integer <int64>
optional
appointment_id
integer <int64>
optional
is_presale
booleanÂ
optional
balanceOrderStatus
object (GetBalanceOrderStatus)Â
optional
uuid
string  | nullÂ
optional
id
integer <int64>
optional
company_id
integer <int32>
optional
tenant_id
integer <int32>
optional
company_uuid
string  | nullÂ
optional
tenant_uuid
string  | nullÂ
optional
client_id
integer <int64>
optional
invoice_id
integer <int64>
optional
status
enum<string>Â
optional
Created
-Open
-AwaitingPayment
-Successfull
-Failed
-Expired
-Void
-Allowed values:
CreatedOpenAwaitingPaymentSuccessfullFailedExpiredVoid
final_status
enum<string>Â
optional
Open
-Closed
-Allowed values:
OpenClosed
link_expiry_date
string <date-time>
optional
short_link
string  | nullÂ
optional
full_link
string  | nullÂ
optional
last_open_date
string  | nullÂ
optional
chargeOrderStatus
object (GetChargeOrderStatus)Â
optional
uuid
string  | nullÂ
optional
id
integer <int64>
optional
company_id
integer <int32>
optional
tenant_id
integer <int32>
optional
company_uuid
string  | nullÂ
optional
tenant_uuid
string  | nullÂ
optional
client_id
integer <int64>
optional
invoice_id
integer <int64>
optional
status
enum<string>Â
optional
Created
-Open
-AwaitingPayment
-Successfull
-Failed
-Expired
-Void
-Allowed values:
CreatedOpenAwaitingPaymentSuccessfullFailedExpiredVoid
final_status
enum<string>Â
optional
Open
-Closed
-Allowed values:
OpenClosed
link_expiry_date
string <date-time>
optional
short_link
string  | nullÂ
optional
full_link
string  | nullÂ
optional
last_open_date
string  | nullÂ
optional
productOrderStatus
object (GetProductOrderStatus)Â
optional
Example
{ "signUpOrderSummaryResponse": { "id": 0, "uuid": "string", "company_id": 0, "tenant_id": 0, "company_uuid": "string", "tenant_uuid": "string", "client_id": 0, "plan_id": 0, "client_subscription_id": 0, "status": "Created", "final_status": "Open", "short_link": "string", "full_link": "string", "track_mode": "StaffWebApp", "link_expiry_date": "2019-08-24T14:15:22Z", "link_last_opened": "2019-08-24T14:15:22Z", "created_by": 0, "created_date": "2019-08-24T14:15:22Z", "updated_by": 0, "updated_date": "2019-08-24T14:15:22Z", "order_details": { "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 }, "task_id": 0, "opportunity_id": 0, "booking_id": 0, "appointment_id": 0, "is_presale": true }, "balanceOrderStatus": { "uuid": "string", "id": 0, "company_id": 0, "tenant_id": 0, "company_uuid": "string", "tenant_uuid": "string", "client_id": 0, "invoice_id": 0, "status": "Created", "final_status": "Open", "link_expiry_date": "2019-08-24T14:15:22Z", "short_link": "string", "full_link": "string", "last_open_date": "string" }, "chargeOrderStatus": { "uuid": "string", "id": 0, "company_id": 0, "tenant_id": 0, "company_uuid": "string", "tenant_uuid": "string", "client_id": 0, "invoice_id": 0, "status": "Created", "final_status": "Open", "link_expiry_date": "2019-08-24T14:15:22Z", "short_link": "string", "full_link": "string", "last_open_date": "string" }, "productOrderStatus": {} }
🟠400Bad Request
Modified at 2025-03-21 07:23:14