swagger

swagger.json

{"info":{"title":"API title","version":"0.0.1"},"swagger":"2.0","produces":["application/xml","application/json"],"securityDefinitions":{"api_key":{"type":"apiKey","name":"api_key","in":"query"}},"security":[{"api_key":[]}],"host":"localhost:3000","tags":[{"name":"api","description":"Operations about apis"}],"paths":{"/api/client/v1/users/{id}":{"get":{"summary":"Get user info by ID","description":"Get user info by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"User ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get user info by ID","schema":{"$ref":"#/definitions/User"}}},"tags":["api"],"operationId":"getApiClientV1UsersId"}},"/api/vendor/v1/users/{id}":{"get":{"summary":"Get user info by ID","description":"Get user info by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"User ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get user info by ID","schema":{"$ref":"#/definitions/User"}}},"tags":["api"],"operationId":"getApiVendorV1UsersId"},"put":{"summary":"Update the user by ID","description":"Update the user by ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"User ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"first_name","description":"First name","type":"string","required":false},{"in":"formData","name":"middle_name","description":"Middle name","type":"string","required":false},{"in":"formData","name":"last_name","description":"Last name","type":"string","required":false},{"in":"formData","name":"password","description":"Password","type":"string","required":false},{"in":"formData","name":"custom_attributes[key]","description":"Custom attribute key","type":"array","items":{"type":"string"},"required":true},{"in":"formData","name":"custom_attributes[value]","description":"Custom attribute value","type":"array","items":{"type":"string"},"required":true}],"responses":{"200":{"description":"Update the user by ID","schema":{"$ref":"#/definitions/User"}}},"tags":["api"],"operationId":"putApiVendorV1UsersId"}},"/api/vendor/v1/users/{id}/accounts":{"get":{"summary":"Get user accounts by ID","description":"Get user accounts by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"User ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get user accounts by ID"}},"tags":["api"],"operationId":"getApiVendorV1UsersIdAccounts"}},"/api/client/v1/users":{"get":{"summary":"Get list of users","description":"Get list of users","produces":["application/json"],"responses":{"200":{"description":"Get list of users","schema":{"$ref":"#/definitions/User"}}},"tags":["api"],"operationId":"getApiClientV1Users"}},"/api/client/v1/users/authorize":{"post":{"summary":"Authorize user by login and password","description":"Authorize user by login and password","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"email","type":"string","required":true},{"in":"formData","name":"password","type":"string","required":true},{"in":"formData","name":"vendor_id","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Authorize user by login and password","schema":{"$ref":"#/definitions/UserAuth"}}},"tags":["api"],"operationId":"postApiClientV1UsersAuthorize"}},"/api/vendor/v1/users":{"get":{"summary":"Get list of users","description":"Get list of users","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false},{"in":"query","name":"sorting[field]","type":"string","required":false},{"in":"query","name":"sorting[reversed]","type":"string","default":"false","enum":["true","false"],"required":false},{"in":"query","name":"filters[created_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[updated_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[status]","type":"string","required":false},{"in":"query","name":"filters[email]","type":"string","required":false},{"in":"query","name":"custom_attribute_filters[key]","type":"string","required":true},{"in":"query","name":"custom_attribute_filters[value]","type":"string","required":true}],"responses":{"200":{"description":"Get list of users","schema":{"$ref":"#/definitions/User"}}},"tags":["api"],"operationId":"getApiVendorV1Users"},"post":{"summary":"Create an user","description":"Create an user","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"first_name","description":"First name","type":"string","required":true},{"in":"formData","name":"last_name","description":"Last name","type":"string","required":true},{"in":"formData","name":"password","description":"Password","type":"string","required":true},{"in":"formData","name":"email","description":"Email","type":"string","required":true},{"in":"formData","name":"middle_name","description":"Middle name","type":"string","required":false},{"in":"formData","name":"custom_attributes[key]","description":"Custom attribute key","type":"array","items":{"type":"string"},"required":true},{"in":"formData","name":"custom_attributes[value]","description":"Custom attribute value","type":"array","items":{"type":"string"},"required":true}],"responses":{"201":{"description":"Create an user","schema":{"$ref":"#/definitions/User"}}},"tags":["api"],"operationId":"postApiVendorV1Users"}},"/api/client/v1/subscriptions/{id}":{"get":{"summary":"Get subscription info by ID","description":"Get subscription info by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"User ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get subscription info by ID","schema":{"$ref":"#/definitions/Subscription"}}},"tags":["api"],"operationId":"getApiClientV1SubscriptionsId"}},"/api/vendor/v1/subscriptions/{id}":{"get":{"summary":"Get subscription info by ID","description":"Get subscription info by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Subscription ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get subscription info by ID","schema":{"$ref":"#/definitions/Subscription"}}},"tags":["api"],"operationId":"getApiVendorV1SubscriptionsId"}},"/api/vendor/v1/subscriptions/{id}/resources":{"get":{"summary":"Get resources list by subscription ID","description":"Get resources list by subscription ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Subscription ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get resources list by subscription ID","schema":{"$ref":"#/definitions/SubscriptionResource"}}},"tags":["api"],"operationId":"getApiVendorV1SubscriptionsIdResources"}},"/api/vendor/v1/subscriptions/{id}/applications":{"get":{"summary":"Get applications list by subscription ID","description":"Get applications list by subscription ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Subscription ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get applications list by subscription ID","schema":{"$ref":"#/definitions/Application"}}},"tags":["api"],"operationId":"getApiVendorV1SubscriptionsIdApplications"}},"/api/vendor/v1/subscriptions/{id}/renew":{"post":{"summary":"Renew subscription by subscription ID","description":"Renew subscription by subscription ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Subscription ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"promo_code","description":"Promocode","type":"string","required":false},{"in":"formData","name":"plan_period_id","description":"PlanPeriod ID","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Renew subscription by subscription ID","schema":{"$ref":"#/definitions/Order"}}},"tags":["api"],"operationId":"postApiVendorV1SubscriptionsIdRenew"}},"/api/vendor/v1/subscriptions/{id}/change":{"post":{"summary":"Change subscription resources(upgrade or downgrade) by subscription ID","description":"Change subscription resources(upgrade or downgrade) by subscription ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Subscription ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"promo_code","description":"Promocode","type":"string","required":false},{"in":"formData","name":"resources[id]","description":"PlanResource ID","type":"array","items":{"type":"integer","format":"int32"},"required":true},{"in":"formData","name":"resources[quantity]","description":"Resource count","type":"array","items":{"type":"integer","format":"int32"},"required":true}],"responses":{"201":{"description":"Change subscription resources(upgrade or downgrade) by subscription ID","schema":{"$ref":"#/definitions/Order"}}},"tags":["api"],"operationId":"postApiVendorV1SubscriptionsIdChange"}},"/api/vendor/v1/subscriptions/{id}/switch":{"post":{"summary":"Switch subscription plan by subscription ID","description":"Switch subscription plan by subscription ID","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Subscription ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"promo_code","description":"Promocode","type":"string","required":false},{"in":"formData","name":"plan_id","description":"Plan ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"plan_period_id","description":"PlanPeriod ID","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Switch subscription plan by subscription ID","schema":{"$ref":"#/definitions/Order"}}},"tags":["api"],"operationId":"postApiVendorV1SubscriptionsIdSwitch"}},"/api/client/v1/subscriptions":{"get":{"summary":"Get list of subscriptions","description":"Get list of subscriptions","produces":["application/json"],"responses":{"200":{"description":"Get list of subscriptions","schema":{"$ref":"#/definitions/Subscription"}}},"tags":["api"],"operationId":"getApiClientV1Subscriptions"}},"/api/vendor/v1/subscriptions":{"get":{"summary":"Get list of subscriptions","description":"Get list of subscriptions","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false},{"in":"query","name":"sorting[field]","type":"string","required":false},{"in":"query","name":"sorting[reversed]","type":"string","default":"false","enum":["true","false"],"required":false},{"in":"query","name":"filters[created_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[updated_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[status]","type":"string","required":false},{"in":"query","name":"filters[account_id]","type":"integer","format":"int32","required":false},{"in":"query","name":"filters[plan_id]","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Get list of subscriptions","schema":{"$ref":"#/definitions/Subscription"}}},"tags":["api"],"operationId":"getApiVendorV1Subscriptions"}},"/api/client/v1/tlds":{"get":{"summary":"Get list of available tlds","description":"Get list of available tlds","produces":["application/json"],"responses":{"200":{"description":"Get list of available tlds","schema":{"$ref":"#/definitions/Tld"}}},"tags":["api"],"operationId":"getApiClientV1Tlds"}},"/api/client/v1/shopping_cart/domains":{"put":{"summary":"Updates current shopping cart","description":"Updates current shopping cart","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"domains[type]","type":"array","items":{"type":"string"},"default":"domain","required":false},{"in":"formData","name":"domains[name]","type":"array","items":{"type":"string"},"required":true},{"in":"formData","name":"domains[plan_period_id]","type":"array","items":{"type":"integer","format":"int32"},"required":true},{"in":"formData","name":"domains[plan_id]","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"formData","name":"domains[params][id]","type":"array","items":{"type":"integer","format":"int32"},"required":true},{"in":"formData","name":"domains[params][value]","type":"array","items":{"type":"string"},"required":true}],"responses":{"200":{"description":"Updates current shopping cart"}},"tags":["api"],"operationId":"putApiClientV1ShoppingCartDomains"},"get":{"produces":["application/json"],"responses":{"200":{"description":"get Domain(s)"}},"tags":["api"],"operationId":"getApiClientV1ShoppingCartDomains"},"delete":{"produces":["application/json"],"parameters":[{"in":"query","name":"domain","type":"string","required":true}],"responses":{"204":{"description":"deleted Domain"}},"tags":["api"],"operationId":"deleteApiClientV1ShoppingCartDomains"}},"/api/client/v1/shopping_cart/payment":{"put":{"produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"account_id","type":"integer","format":"int32","required":false},{"in":"formData","name":"promo_code","type":"string","required":false}],"responses":{"200":{"description":"updated Payment"}},"tags":["api"],"operationId":"putApiClientV1ShoppingCartPayment"}},"/api/client/v1/shopping_cart/check_plan_valid":{"post":{"produces":["application/json"],"consumes":["application/json"],"responses":{"201":{"description":"created CheckPlanValid"}},"tags":["api"],"operationId":"postApiClientV1ShoppingCartCheckPlanValid"}},"/api/client/v1/shopping_cart/possible_account_types":{"get":{"produces":["application/json"],"responses":{"200":{"description":"get PossibleAccountType(s)"}},"tags":["api"],"operationId":"getApiClientV1ShoppingCartPossibleAccountTypes"}},"/api/client/v1/shopping_cart/sales_order_calculations":{"get":{"produces":["application/json"],"responses":{"200":{"description":"get SalesOrderCalculation(s)"}},"tags":["api"],"operationId":"getApiClientV1ShoppingCartSalesOrderCalculations"}},"/api/client/v1/shopping_cart/renew_order_calculations":{"get":{"produces":["application/json"],"responses":{"200":{"description":"get RenewOrderCalculation(s)"}},"tags":["api"],"operationId":"getApiClientV1ShoppingCartRenewOrderCalculations"}},"/api/client/v1/shopping_cart/change_order_calculations":{"get":{"produces":["application/json"],"responses":{"200":{"description":"get ChangeOrderCalculation(s)"}},"tags":["api"],"operationId":"getApiClientV1ShoppingCartChangeOrderCalculations"}},"/api/client/v1/shopping_cart/switch_plan_order_calculations":{"get":{"produces":["application/json"],"responses":{"200":{"description":"get SwitchPlanOrderCalculation(s)"}},"tags":["api"],"operationId":"getApiClientV1ShoppingCartSwitchPlanOrderCalculations"}},"/api/client/v1/shopping_cart/change_order":{"post":{"produces":["application/json"],"consumes":["application/json"],"responses":{"201":{"description":"created ChangeOrder"}},"tags":["api"],"operationId":"postApiClientV1ShoppingCartChangeOrder"}},"/api/client/v1/shopping_cart/switch_plan_order":{"post":{"produces":["application/json"],"consumes":["application/json"],"responses":{"201":{"description":"created SwitchPlanOrder"}},"tags":["api"],"operationId":"postApiClientV1ShoppingCartSwitchPlanOrder"}},"/api/client/v1/shopping_cart/upgrade_resource":{"put":{"produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"quantity","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"updated UpgradeResource"}},"tags":["api"],"operationId":"putApiClientV1ShoppingCartUpgradeResource"}},"/api/client/v1/shopping_cart/downgrade_resource":{"put":{"produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"quantity","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"updated DowngradeResource"}},"tags":["api"],"operationId":"putApiClientV1ShoppingCartDowngradeResource"}},"/api/client/v1/shopping_cart/update_promocode":{"put":{"produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"promo_code","type":"string","required":true}],"responses":{"200":{"description":"updated UpdatePromocode"}},"tags":["api"],"operationId":"putApiClientV1ShoppingCartUpdatePromocode"}},"/api/client/v1/shopping_cart/delete_promocode":{"delete":{"produces":["application/json"],"responses":{"204":{"description":"deleted DeletePromocode"}},"tags":["api"],"operationId":"deleteApiClientV1ShoppingCartDeletePromocode"}},"/api/client/v1/shopping_cart/update_account":{"put":{"produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"account_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"updated UpdateAccount"}},"tags":["api"],"operationId":"putApiClientV1ShoppingCartUpdateAccount"}},"/api/client/v1/shopping_cart/subscription_switchable_plans":{"get":{"produces":["application/json"],"parameters":[{"in":"query","name":"subscription_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"get SubscriptionSwitchablePlan(s)"}},"tags":["api"],"operationId":"getApiClientV1ShoppingCartSubscriptionSwitchablePlans"}},"/api/client/v1/current_user/accounts":{"get":{"summary":"Get list of the logged in user accounts","description":"Get list of the logged in user accounts","produces":["application/json"],"responses":{"200":{"description":"Get list of the logged in user accounts","schema":{"$ref":"#/definitions/Account"}}},"tags":["api"],"operationId":"getApiClientV1CurrentUserAccounts"}},"/api/client/v1/current_user/accounts/admin":{"get":{"produces":["application/json"],"responses":{"200":{"description":"get Admin(s)"}},"tags":["api"],"operationId":"getApiClientV1CurrentUserAccountsAdmin"}},"/api/client/v1/current_user/applications/confirm_passwords":{"post":{"summary":"Confirm password for application","description":"Confirm password for application","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"password","type":"string","required":true}],"responses":{"201":{"description":"Confirm password for application"}},"tags":["api"],"operationId":"postApiClientV1CurrentUserApplicationsConfirmPasswords"}},"/api/client/v1/payment_methods":{"get":{"summary":"Get list of available payment methods for current vendor","description":"Get list of available payment methods for current vendor","produces":["application/json"],"responses":{"200":{"description":"Get list of available payment methods for current vendor","schema":{"$ref":"#/definitions/PaymentMethod"}}},"tags":["api"],"operationId":"getApiClientV1PaymentMethods"}},"/api/client/v1/accounts/{account_id}/payment_methods":{"get":{"produces":["application/json"],"parameters":[{"in":"path","name":"account_id","description":"Account ID","type":"integer","format":"int32","required":true},{"in":"query","name":"order_total","description":"Order total ID","type":"number","format":"float","required":true}],"responses":{"200":{"description":"get PaymentMethod(s)","schema":{"$ref":"#/definitions/PaymentMethod"}}},"tags":["api"],"operationId":"getApiClientV1AccountsAccountIdPaymentMethods"}},"/api/vendor/v1/accounts":{"get":{"summary":"Get list of accounts","description":"Get list of accounts","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false},{"in":"query","name":"sorting[field]","type":"string","required":false},{"in":"query","name":"sorting[reversed]","type":"string","default":"false","enum":["true","false"],"required":false},{"in":"query","name":"filters[created_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[updated_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[status]","type":"string","required":false},{"in":"query","name":"filters[email]","type":"string","required":false}],"responses":{"200":{"description":"Get list of accounts","schema":{"$ref":"#/definitions/Account"}}},"tags":["api"],"operationId":"getApiVendorV1Accounts"},"post":{"summary":"Create an account","description":"Create an account","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"account_type_id","description":"Account Type ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"primary_name","description":"Primary name","type":"string","required":false},{"in":"formData","name":"first_name","description":"First name","type":"string","required":true},{"in":"formData","name":"middle_name","description":"Middle name","type":"string","required":false},{"in":"formData","name":"last_name","description":"Last name","type":"string","required":true},{"in":"formData","name":"owner_id","description":"User ID that will be owner of account","type":"integer","format":"int32","required":false},{"in":"formData","name":"manager_id","description":"Manager ID","type":"integer","format":"int32","required":false},{"in":"formData","name":"account_class_id","description":"Account Class ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"country","description":"Country","type":"string","required":true},{"in":"formData","name":"region","description":"Region","type":"string","required":true},{"in":"formData","name":"city","description":"City","type":"string","required":true},{"in":"formData","name":"street","description":"Street","type":"string","required":true},{"in":"formData","name":"building","description":"Building","type":"string","required":true},{"in":"formData","name":"office","description":"Office","type":"string","required":true},{"in":"formData","name":"zip","description":"Zip code","type":"string","required":true},{"in":"formData","name":"phone","description":"Phone","type":"string","required":true},{"in":"formData","name":"email","description":"Email","type":"string","required":true},{"in":"formData","name":"custom_attributes[key]","description":"Custom attribute key","type":"array","items":{"type":"string"},"required":true},{"in":"formData","name":"custom_attributes[value]","description":"Custom attribute value","type":"array","items":{"type":"string"},"required":true}],"responses":{"201":{"description":"Create an account","schema":{"$ref":"#/definitions/Account"}}},"tags":["api"],"operationId":"postApiVendorV1Accounts"}},"/api/vendor/v1/accounts/{id}":{"put":{"summary":"Update an account","description":"Update an account","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Account ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"manager_id","description":"Manager ID","type":"integer","format":"int32","required":false},{"in":"formData","name":"account_type_id","description":"Account Type ID","type":"integer","format":"int32","required":false},{"in":"formData","name":"account_class_id","description":"Owner User ID","type":"integer","format":"int32","required":false},{"in":"formData","name":"primary_name","description":"Company name (For non-personal accounts)","type":"string","required":false},{"in":"formData","name":"first_name","description":"First name","type":"string","required":false},{"in":"formData","name":"middle_name","description":"Middle name","type":"string","required":false},{"in":"formData","name":"last_name","description":"last name","type":"string","required":false},{"in":"formData","name":"owner_id","description":"Owner User ID","type":"integer","format":"int32","required":false},{"in":"formData","name":"email","description":"Email","type":"string","required":false},{"in":"formData","name":"credit_limit_use_system","description":"Use system credit limit?","type":"boolean","required":false},{"in":"formData","name":"credit_limit","description":"Custom credit limit","type":"integer","format":"int32","required":false},{"in":"formData","name":"country","description":"Country","type":"string","required":false},{"in":"formData","name":"region","description":"Region","type":"string","required":false},{"in":"formData","name":"city","description":"City","type":"string","required":false},{"in":"formData","name":"street","description":"Street","type":"string","required":false},{"in":"formData","name":"building","description":"Building","type":"string","required":false},{"in":"formData","name":"office","description":"Office","type":"string","required":false},{"in":"formData","name":"zip","description":"Zip code","type":"string","required":false},{"in":"formData","name":"phone","description":"Phone","type":"string","required":false},{"in":"formData","name":"custom_attributes[key]","description":"Custom attribute key","type":"array","items":{"type":"string"},"required":true},{"in":"formData","name":"custom_attributes[value]","description":"Custom attribute value","type":"array","items":{"type":"string"},"required":true}],"responses":{"200":{"description":"Update an account","schema":{"$ref":"#/definitions/Account"}}},"tags":["api"],"operationId":"putApiVendorV1AccountsId"},"get":{"summary":"Get account info by ID","description":"Get account info by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Account ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get account info by ID","schema":{"$ref":"#/definitions/Account"}}},"tags":["api"],"operationId":"getApiVendorV1AccountsId"}},"/api/vendor/v1/accounts/{id}/users":{"get":{"summary":"Get account users by ID","description":"Get account users by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Account ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get account users by ID","schema":{"$ref":"#/definitions/User"}}},"tags":["api"],"operationId":"getApiVendorV1AccountsIdUsers"}},"/api/vendor/v1/accounts/{id}/subscriptions":{"get":{"summary":"Get account subscriptions by ID","description":"Get account subscriptions by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Account ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get account subscriptions by ID","schema":{"$ref":"#/definitions/Subscription"}}},"tags":["api"],"operationId":"getApiVendorV1AccountsIdSubscriptions"}},"/api/client/v1/account_types":{"get":{"summary":"Get list of available account types for current vendor","description":"Get list of available account types for current vendor","produces":["application/json"],"responses":{"200":{"description":"Get list of available account types for current vendor","schema":{"$ref":"#/definitions/AccountType"}}},"tags":["api"],"operationId":"getApiClientV1AccountTypes"}},"/api/client/v1/domains/whois":{"get":{"summary":"Returns whois information for a domain","description":"Returns whois information for a domain","produces":["application/json"],"parameters":[{"in":"query","name":"domain","type":"string","required":true}],"responses":{"200":{"description":"Returns whois information for a domain"}},"tags":["api"],"operationId":"getApiClientV1DomainsWhois"}},"/api/client/v1/domains/check":{"post":{"summary":"Check Domain for availability","description":"Check Domain for availability","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"domain","description":"Domain to check","type":"string","required":true}],"responses":{"201":{"description":"Check Domain for availability"}},"tags":["api"],"operationId":"postApiClientV1DomainsCheck"},"get":{"summary":"Get tld statuses for domain","description":"Get tld statuses for domain","produces":["application/json"],"parameters":[{"in":"query","name":"domain_checker_id","description":"Domain checker ID","type":"string","required":true}],"responses":{"200":{"description":"Get tld statuses for domain"}},"tags":["api"],"operationId":"getApiClientV1DomainsCheck"}},"/api/vendor/v1/domains":{"get":{"summary":"Get list of domains","description":"Get list of domains","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false},{"in":"query","name":"sorting[field]","type":"string","required":false},{"in":"query","name":"sorting[reversed]","type":"string","default":"false","enum":["true","false"],"required":false},{"in":"query","name":"filters[created_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[updated_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[account_id]","type":"integer","format":"int32","required":false},{"in":"query","name":"filters[name]","type":"string","required":false}],"responses":{"200":{"description":"Get list of domains","schema":{"$ref":"#/definitions/Domain"}}},"tags":["api"],"operationId":"getApiVendorV1Domains"},"post":{"summary":"Create domain","description":"Create domain","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"account_id","description":"Account ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"name","description":"Domain name","type":"string","required":true}],"responses":{"201":{"description":"Create domain","schema":{"$ref":"#/definitions/Domain"}}},"tags":["api"],"operationId":"postApiVendorV1Domains"}},"/api/vendor/v1/domains/{id}":{"get":{"summary":"Get domain info by ID","description":"Get domain info by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Domain ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get domain info by ID","schema":{"$ref":"#/definitions/Domain"}}},"tags":["api"],"operationId":"getApiVendorV1DomainsId"},"delete":{"summary":"Delete domain","description":"Delete domain","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Domain ID","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete domain"}},"tags":["api"],"operationId":"deleteApiVendorV1DomainsId"}},"/api/vendor/v1/domains/{id}/applications":{"get":{"summary":"Get applications list by domain ID","description":"Get applications list by domain ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Domain ID","type":"integer","format":"int32","required":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false},{"in":"query","name":"sorting[field]","type":"string","required":false},{"in":"query","name":"sorting[reversed]","type":"string","default":"false","enum":["true","false"],"required":false},{"in":"query","name":"filters[created_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[updated_at]","type":"string","format":"date","required":false}],"responses":{"200":{"description":"Get applications list by domain ID","schema":{"$ref":"#/definitions/Application"}}},"tags":["api"],"operationId":"getApiVendorV1DomainsIdApplications"}},"/api/vendor/v1/domains/{id}/applications/{application_id}":{"post":{"summary":"Attach the application to the domain","description":"Attach the application to the domain","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Domain ID","type":"integer","format":"int32","required":true},{"in":"path","name":"application_id","description":"Application ID","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Attach the application to the domain","schema":{"$ref":"#/definitions/Application"}}},"tags":["api"],"operationId":"postApiVendorV1DomainsIdApplicationsApplicationId"},"delete":{"summary":"Detach the application from the domain","description":"Detach the application from the domain","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Domain ID","type":"integer","format":"int32","required":true},{"in":"path","name":"application_id","description":"Application ID","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Detach the application from the domain"}},"tags":["api"],"operationId":"deleteApiVendorV1DomainsIdApplicationsApplicationId"}},"/api/client/v1/notification_categories":{"get":{"summary":"Get list of available notification_categories","description":"Get list of available notification_categories","produces":["application/json"],"parameters":[{"in":"query","name":"account_id","description":"Account ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get list of available notification_categories","schema":{"$ref":"#/definitions/NotificationCategory"}}},"tags":["api"],"operationId":"getApiClientV1NotificationCategories"}},"/api/vendor/v1/charges":{"get":{"summary":"Get list of charges","description":"Get list of charges","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false},{"in":"query","name":"sorting[field]","type":"string","required":false},{"in":"query","name":"sorting[reversed]","type":"string","default":"false","enum":["true","false"],"required":false},{"in":"query","name":"filters[created_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[updated_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[subscription_id]","type":"integer","format":"int32","required":false},{"in":"query","name":"filters[status]","type":"string","required":false},{"in":"query","name":"filters[close_date]","type":"string","format":"date","required":false}],"responses":{"200":{"description":"Get list of charges","schema":{"$ref":"#/definitions/Charge"}}},"tags":["api"],"operationId":"getApiVendorV1Charges"}},"/api/vendor/v1/charges/{id}":{"get":{"summary":"Get charge info by ID","description":"Get charge info by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Charge ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get charge info by ID","schema":{"$ref":"#/definitions/Charge"}}},"tags":["api"],"operationId":"getApiVendorV1ChargesId"}},"/api/vendor/v1/orders":{"get":{"summary":"Get list of orders","description":"Get list of orders","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false},{"in":"query","name":"sorting[field]","type":"string","required":false},{"in":"query","name":"sorting[reversed]","type":"string","default":"false","enum":["true","false"],"required":false},{"in":"query","name":"filters[created_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[updated_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[account_id]","type":"integer","format":"int32","required":false},{"in":"query","name":"filters[type]","type":"string","required":false},{"in":"query","name":"filters[status]","type":"string","required":false}],"responses":{"200":{"description":"Get list of orders","schema":{"$ref":"#/definitions/Order"}}},"tags":["api"],"operationId":"getApiVendorV1Orders"},"post":{"summary":"Create order","description":"Create order","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"account_id","description":"Account ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"promocode","description":"Promocode","type":"string","required":false},{"in":"formData","name":"items[plan_id]","description":"Plan ID","type":"array","items":{"type":"integer","format":"int32"},"required":true},{"in":"formData","name":"items[plan_period_id]","description":"PlanPeriod ID","type":"array","items":{"type":"integer","format":"int32"},"required":true},{"in":"formData","name":"items[name]","description":"Item name","type":"array","items":{"type":"string"},"required":false},{"in":"formData","name":"items[resources][id]","description":"PlanResource ID","type":"array","items":{"type":"integer","format":"int32"},"required":true},{"in":"formData","name":"items[resources][quantity]","description":"Resource count","type":"array","items":{"type":"integer","format":"int32"},"required":true},{"in":"formData","name":"items[additional_params][id]","description":"Parameter ID","type":"array","items":{"type":"string"},"required":true},{"in":"formData","name":"items[additional_params][value]","type":"array","items":{"type":"string"},"required":true}],"responses":{"201":{"description":"Create order","schema":{"$ref":"#/definitions/Order"}}},"tags":["api"],"operationId":"postApiVendorV1Orders"}},"/api/vendor/v1/orders/{id}":{"get":{"summary":"Get order info by ID","description":"Get order info by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Order ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get order info by ID","schema":{"$ref":"#/definitions/Order"}}},"tags":["api"],"operationId":"getApiVendorV1OrdersId"},"put":{"summary":"Update order","description":"Update order","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"payment_id","description":"Payment ID","type":"integer","format":"int32","required":true},{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Update order","schema":{"$ref":"#/definitions/Order"}}},"tags":["api"],"operationId":"putApiVendorV1OrdersId"}},"/api/vendor/v1/plans":{"get":{"summary":"Get list of plans","description":"Get list of plans","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false},{"in":"query","name":"sorting[field]","type":"string","required":false},{"in":"query","name":"sorting[reversed]","type":"string","default":"false","enum":["true","false"],"required":false},{"in":"query","name":"filters[created_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[updated_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[status]","type":"string","required":false},{"in":"query","name":"filters[public]","type":"boolean","required":false}],"responses":{"200":{"description":"Get list of plans","schema":{"$ref":"#/definitions/Plan"}}},"tags":["api"],"operationId":"getApiVendorV1Plans"}},"/api/vendor/v1/plans/{id}":{"get":{"summary":"Get plan info by ID","description":"Get plan info by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Plan ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get plan info by ID","schema":{"$ref":"#/definitions/Plan"}}},"tags":["api"],"operationId":"getApiVendorV1PlansId"}},"/api/vendor/v1/payments":{"get":{"summary":"Get list of payments","description":"Get list of payments","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false},{"in":"query","name":"sorting[field]","type":"string","required":false},{"in":"query","name":"sorting[reversed]","type":"string","default":"false","enum":["true","false"],"required":false},{"in":"query","name":"filters[created_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[updated_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[account_id]","type":"integer","format":"int32","required":false},{"in":"query","name":"filters[payment_method_id]","type":"integer","format":"int32","required":false},{"in":"query","name":"filters[status]","type":"string","required":false}],"responses":{"200":{"description":"Get list of payments","schema":{"$ref":"#/definitions/Payment"}}},"tags":["api"],"operationId":"getApiVendorV1Payments"},"post":{"summary":"Create a payment","description":"Create a payment","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"account_id","description":"Account ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"manager_id","description":"Manager ID","type":"integer","format":"int32","required":false},{"in":"formData","name":"total","description":"Total amount","type":"number","format":"double","required":true},{"in":"formData","name":"comment","description":"Comment","type":"string","required":true}],"responses":{"201":{"description":"Create a payment","schema":{"$ref":"#/definitions/Payment"}}},"tags":["api"],"operationId":"postApiVendorV1Payments"}},"/api/vendor/v1/payments/{id}":{"get":{"summary":"Get payment info by ID","description":"Get payment info by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Payment ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get payment info by ID","schema":{"$ref":"#/definitions/Payment"}}},"tags":["api"],"operationId":"getApiVendorV1PaymentsId"},"delete":{"summary":"Cancel the payment","description":"Cancel the payment","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Payment ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Cancel the payment","schema":{"$ref":"#/definitions/Payment"}}},"tags":["api"],"operationId":"deleteApiVendorV1PaymentsId"}},"/api/vendor/v1/payments/{id}/complete":{"post":{"summary":"Complete the payment","description":"Complete the payment","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Payment ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"payment_method_id","description":"Payment method ID","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Complete the payment","schema":{"$ref":"#/definitions/Payment"}}},"tags":["api"],"operationId":"postApiVendorV1PaymentsIdComplete"}},"/api/vendor/v1/managers":{"get":{"summary":"Get list of managers","description":"Get list of managers","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false},{"in":"query","name":"sorting[field]","type":"string","required":false},{"in":"query","name":"sorting[reversed]","type":"string","default":"false","enum":["true","false"],"required":false},{"in":"query","name":"filters[created_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[updated_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[status]","type":"string","required":false},{"in":"query","name":"custom_attribute_filters[key]","type":"string","required":true},{"in":"query","name":"custom_attribute_filters[value]","type":"string","required":true}],"responses":{"200":{"description":"Get list of managers","schema":{"$ref":"#/definitions/Manager"}}},"tags":["api"],"operationId":"getApiVendorV1Managers"}},"/api/vendor/v1/managers/{id}":{"get":{"summary":"Get manager info by ID","description":"Get manager info by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Manager ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get manager info by ID","schema":{"$ref":"#/definitions/Manager"}}},"tags":["api"],"operationId":"getApiVendorV1ManagersId"}},"/api/vendor/v1/applications":{"get":{"summary":"Get list of applications","description":"Get list of applications","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false},{"in":"query","name":"sorting[field]","type":"string","required":false},{"in":"query","name":"sorting[reversed]","type":"string","default":"false","enum":["true","false"],"required":false},{"in":"query","name":"filters[created_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[updated_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[service_status]","type":"string","required":false},{"in":"query","name":"filters[subscription_id]","type":"integer","format":"int32","required":false},{"in":"query","name":"filters[application_template_id]","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Get list of applications","schema":{"$ref":"#/definitions/Application"}}},"tags":["api"],"operationId":"getApiVendorV1Applications"}},"/api/vendor/v1/applications/{id}":{"get":{"summary":"Get application info by ID","description":"Get application info by ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Application ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get application info by ID","schema":{"$ref":"#/definitions/Application"}}},"tags":["api"],"operationId":"getApiVendorV1ApplicationsId"}},"/api/vendor/v1/applications/{id}/domains":{"get":{"summary":"Get list of the application domains","description":"Get list of the application domains","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Application ID","type":"integer","format":"int32","required":true},{"in":"query","name":"page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false},{"in":"query","name":"sorting[field]","type":"string","required":false},{"in":"query","name":"sorting[reversed]","type":"string","default":"false","enum":["true","false"],"required":false},{"in":"query","name":"filters[created_at]","type":"string","format":"date","required":false},{"in":"query","name":"filters[updated_at]","type":"string","format":"date","required":false}],"responses":{"200":{"description":"Get list of the application domains","schema":{"$ref":"#/definitions/Domain"}}},"tags":["api"],"operationId":"getApiVendorV1ApplicationsIdDomains"}},"/api/vendor/v1/applications/{id}/domains/{domain_id}":{"post":{"summary":"Attach the domain to the application","description":"Attach the domain to the application","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Application ID","type":"integer","format":"int32","required":true},{"in":"path","name":"domain_id","description":"Domain ID","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Attach the domain to the application","schema":{"$ref":"#/definitions/Domain"}}},"tags":["api"],"operationId":"postApiVendorV1ApplicationsIdDomainsDomainId"},"delete":{"summary":"Detach the domain from the application","description":"Detach the domain from the application","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Application ID","type":"integer","format":"int32","required":true},{"in":"path","name":"domain_id","description":"Domain ID","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Detach the domain from the application"}},"tags":["api"],"operationId":"deleteApiVendorV1ApplicationsIdDomainsDomainId"}},"/api/vendor/v1/shc/create_or_update_domain":{"post":{"produces":["application/json"],"consumes":["application/json"],"responses":{"201":{"description":"created CreateOrUpdateDomain"}},"tags":["api"],"operationId":"postApiVendorV1ShcCreateOrUpdateDomain"}}},"definitions":{"User":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"first_name":{"type":"string"},"middle_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"vendor_id":{"type":"integer","format":"int32"},"street":{"type":"string"},"building":{"type":"string"},"office":{"type":"string"},"country":{"type":"string"},"country_name":{"type":"string"},"zip":{"type":"string"},"city":{"type":"string"},"phone":{"type":"string"},"status":{"type":"string"}},"required":["id","first_name","last_name","email"],"description":"Get account users by ID"},"UserAuth":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"api_token":{"type":"string"},"vendor_id":{"type":"integer","format":"int32"}},"required":["id","api_token","vendor_id"],"description":"Authorize user by login and password"},"Subscription":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"integer","format":"int32"},"status":{"type":"string"},"account_id":{"type":"integer","format":"int32"},"expiration_date":{"type":"string","format":"date"},"plan_id":{"type":"integer","format":"int32"},"plan_period_id":{"type":"integer","format":"int32"}},"description":"Get account subscriptions by ID"},"SubscriptionResource":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"additional":{"type":"integer","format":"int32"},"used":{"type":"integer","format":"int32"},"application_id":{"type":"integer","format":"int32"},"plan_resource_id":{"type":"integer","format":"int32"},"name":{"type":"string"},"recurring_fee":{"type":"integer","format":"int32"},"renewal_fee":{"type":"integer","format":"int32"},"setup_fee":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"included":{"type":"integer","format":"int32"},"minimum":{"type":"integer","format":"int32"},"unlimited_units":{"type":"integer","format":"int32"},"overuse_fee":{"type":"integer","format":"int32"}},"required":["id","additional","used","application_id","plan_resource_id","name","recurring_fee","renewal_fee","setup_fee","limit","included","minimum","unlimited_units","overuse_fee"],"description":"Get resources list by subscription ID"},"Application":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"subscription_id":{"type":"integer","format":"int32"},"origin_id":{"type":"integer","format":"int32"},"origin_type":{"type":"string"},"service_status":{"type":"string"},"application_template_id":{"type":"integer","format":"int32"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["id","subscription_id","origin_id","origin_type","service_status","application_template_id","created_at","updated_at"],"description":"Get application info by ID"},"Order":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"document_id":{"type":"string"},"status":{"type":"string"},"account_id":{"type":"integer","format":"int32"},"type":{"type":"string"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"expiration_date":{"type":"string","format":"date"},"total":{"type":"number","format":"float"},"promo_code":{"type":"string"},"payment_id":{"type":"integer","format":"int32"},"items":{"$ref":"#/definitions/ProvisioningItem"},"charges":{"$ref":"#/definitions/Charge"}},"required":["id","document_id","status","account_id","type","created_at","updated_at","expiration_date","total","promo_code","payment_id"],"description":"Update order"},"ProvisioningItem":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"target_id":{"type":"integer","format":"int32"},"target_type":{"type":"string"},"type":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"}},"required":["id","target_id","target_type","type","status","description"]},"Charge":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"subscription_id":{"type":"integer","format":"int32"},"subscription_resource_id":{"type":"integer","format":"int32"},"subscription_resource_name":{"type":"string"},"plan_resource_id":{"type":"integer","format":"int32"},"resource_id":{"type":"integer","format":"int32"},"quantity":{"type":"number","format":"float"},"operate_from":{"type":"string","format":"date"},"operate_to":{"type":"string","format":"date"},"duration":{"type":"number","format":"float"},"description":{"type":"string"},"unit_price":{"type":"decimal"},"amount":{"type":"decimal"},"status":{"type":"string"},"type":{"type":"string"},"order_id":{"type":"integer","format":"int32"},"close_date":{"type":"string","format":"date"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["id","subscription_id","subscription_resource_id","quantity","operate_from","duration","description","unit_price","amount","status","type","created_at","updated_at"],"description":"Get charge info by ID"},"Tld":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"plan_id":{"type":"integer","format":"int32"},"favorite":{"type":"boolean"},"priority":{"type":"integer","format":"int32"},"domain_names_regexp":{"type":"string"},"plan_periods":{"$ref":"#/definitions/TldPlanPeriod"}},"description":"Get list of available tlds"},"TldPlanPeriod":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"duration_value":{"type":"integer","format":"int32"},"duration_type":{"type":"string"},"duration_human_name":{"type":"boolean"},"setup_fee":{"type":"integer","format":"int32"},"recurring_fee":{"type":"integer","format":"int32"},"ordering_fee":{"type":"integer","format":"int32"},"ordering_fee_with_currency":{"type":"integer","format":"int32"}}},"Account":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"trial":{"type":"string"},"payment_methods":{"$ref":"#/definitions/PaymentMethod"},"selected":{"type":"string"}},"description":"Get account info by ID"},"PaymentMethod":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":null},"AccountType":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"payment_methods":{"$ref":"#/definitions/PaymentMethod"}},"description":"Get list of available account types for current vendor"},"Domain":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"account_id":{"type":"integer","format":"int32"},"name":{"type":"string"},"records":{"$ref":"#/definitions/Record"}},"required":["id","account_id","name"],"description":"Attach the domain to the application"},"Record":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"content":{"type":"string"},"ttl":{"type":"integer","format":"int32"},"prio":{"type":"integer","format":"int32"},"raw_content":{"type":"string"}},"required":["name","type","content","ttl","prio"]},"NotificationCategory":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"boolean"},"sms":{"type":"boolean"},"low_balance_type":{"type":"boolean"}},"required":["id","name","email","sms"],"description":"Get list of available notification_categories"},"Plan":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"status":{"type":"string"},"name":{"type":"string"},"description":{"type":"text"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"public":{"type":"boolean"},"plan_class_id":{"type":"integer","format":"int32"},"plan_class":{"type":"string"},"ancestry":{"type":"string"},"plan_resources":{"$ref":"#/definitions/PlanResource"},"plan_periods":{"$ref":"#/definitions/PlanPeriod"},"custom_attributes":{"$ref":"#/definitions/NewCustomAttributeValue"}},"required":["id","status","name","description","created_at","updated_at","public","plan_class_id","ancestry"],"description":"Get plan info by ID"},"PlanResource":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"application_template_name":{"type":"string"},"measurable":{"type":"boolean"},"unit_of_measure":{"type":"string"},"included":{"type":"integer","format":"int32"},"minimum":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"setup_fee":{"type":"decimal"},"recurring_fee":{"type":"decimal"},"overuse_fee":{"type":"decimal"},"renewal_fee":{"type":"decimal"},"unlimited_units":{"type":"boolean"},"public":{"type":"boolean"},"status":{"type":"string"},"resource_id":{"type":"integer","format":"int32"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"custom_attributes":{"$ref":"#/definitions/NewCustomAttributeValue"}},"required":["id","name","application_template_name","measurable","unit_of_measure","included","minimum","limit","setup_fee","recurring_fee","overuse_fee","renewal_fee","unlimited_units","public","status","resource_id","created_at","updated_at"]},"NewCustomAttributeValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"]},"PlanPeriod":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"duration_value":{"type":"integer","format":"int32"},"duration_type":{"type":"string"},"setup_fee":{"type":"decimal"},"recurring_fee":{"type":"decimal"},"renewal_fee":{"type":"decimal"},"trial":{"type":"boolean"},"public":{"type":"boolean"},"status":{"type":"string"},"description":{"type":"text"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["id","duration_value","duration_type","setup_fee","recurring_fee","renewal_fee","trial","public","status","description","created_at","updated_at"]},"Payment":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"document_id":{"type":"string"},"status":{"type":"string"},"account_id":{"type":"integer","format":"int32"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"total":{"type":"decimal"},"comment":{"type":"string"},"requester_ip":{"type":"string"},"manager_id":{"type":"string"},"payment_method_id":{"type":"integer","format":"int32"},"payment_method_name":{"type":"string"},"orders":{"$ref":"#/definitions/Order"}},"required":["id","document_id","status","account_id","created_at","updated_at","total","comment","requester_ip"],"description":"Complete the payment"},"Manager":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"status":{"type":"string"},"name":{"type":"string"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["id","status","name","created_at","updated_at"],"description":"Get manager info by ID"}}}