{"id":20916246,"url":"https://github.com/qualityunit/crm-api-python-client","last_synced_at":"2025-08-17T22:15:54.282Z","repository":{"id":189611858,"uuid":"645329392","full_name":"QualityUnit/Crm-Api-Python-client","owner":"QualityUnit","description":null,"archived":false,"fork":false,"pushed_at":"2023-05-29T10:34:48.000Z","size":224,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-01T09:45:45.878Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/QualityUnit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-05-25T12:14:22.000Z","updated_at":"2023-05-29T10:34:52.000Z","dependencies_parsed_at":"2023-08-21T02:00:09.421Z","dependency_job_id":"3a5ecadf-3953-4845-a205-90f058ebac02","html_url":"https://github.com/QualityUnit/Crm-Api-Python-client","commit_stats":null,"previous_names":["qualityunit/crm-api-python-client"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/QualityUnit/Crm-Api-Python-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2FCrm-Api-Python-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2FCrm-Api-Python-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2FCrm-Api-Python-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2FCrm-Api-Python-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/QualityUnit","download_url":"https://codeload.github.com/QualityUnit/Crm-Api-Python-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2FCrm-Api-Python-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270914582,"owners_count":24667167,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-17T02:00:09.016Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-18T16:21:00.567Z","updated_at":"2025-08-17T22:15:54.249Z","avatar_url":"https://github.com/QualityUnit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# qu.crm\nThis page contains complete API documentation for CRM software.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 3.0.0\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.PythonNextgenClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/qualityunit/Crm-Api-Python-client.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/qualityunit/Crm-Api-Python-client.git`)\n\nThen import the package:\n```python\nimport qu.crm\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport qu.crm\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport qu.crm\nfrom qu.crm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://crm.qualityunit.com/api/v3\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = qu.crm.Configuration(\n    host = \"https://crm.qualityunit.com/api/v3\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n\n# Enter a context with an instance of the API client\nasync with qu.crm.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = qu.crm.AdminPanelApi(api_client)\n\n    try:\n        # Subscription source list\n        api_response = await api_instance.get_subscription_sources()\n        print(\"The response of AdminPanelApi-\u003eget_subscription_sources:\\n\")\n        pprint(api_response)\n    except ApiException as e:\n        print(\"Exception when calling AdminPanelApi-\u003eget_subscription_sources: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://crm.qualityunit.com/api/v3*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AdminPanelApi* | [**get_subscription_sources**](docs/AdminPanelApi.md#get_subscription_sources) | **GET** /admin_panel/sources | Subscription source list\n*AdminPanelApi* | [**get_subscription_view**](docs/AdminPanelApi.md#get_subscription_view) | **GET** /admin_panel/subscription_view/{subscriptionId} | Subscription view data\n*AttributesApi* | [**get_attribute**](docs/AttributesApi.md#get_attribute) | **GET** /attributes/{attributeId} | Attribute\n*AttributesApi* | [**get_attributes**](docs/AttributesApi.md#get_attributes) | **GET** /attributes | Attribute list\n*AttributesApi* | [**set_attribute**](docs/AttributesApi.md#set_attribute) | **PUT** /attributes/{attributeId} | Attribute\n*BillingApi* | [**check_vat**](docs/BillingApi.md#check_vat) | **POST** /billing/_check_vat | Vat validity\n*CountriesApi* | [**get_countries**](docs/CountriesApi.md#get_countries) | **GET** /countries | Country list\n*CouponApi* | [**get_coupon**](docs/CouponApi.md#get_coupon) | **GET** /coupons/{couponCode} | Coupon\n*CouponsApi* | [**extend_coupon_validity**](docs/CouponsApi.md#extend_coupon_validity) | **POST** /coupons/{couponCode}/_extend_validity | Extend coupon validity\n*DevApi* | [**dev_create_subscription**](docs/DevApi.md#dev_create_subscription) | **POST** /dev/_create_subscription | Create dev subscription\n*EventLogsApi* | [**get_event_logs**](docs/EventLogsApi.md#get_event_logs) | **GET** /event_logs | Event logs list\n*HackApi* | [**hack_dummy_payment_method**](docs/HackApi.md#hack_dummy_payment_method) | **POST** /_hack/_dummy_payment_method | Set dummy payment method\n*InternalApi* | [**account_user_login**](docs/InternalApi.md#account_user_login) | **GET** /subscriptions/{subscriptionId}/_login | Login as account user\n*InternalApi* | [**cancel_discount**](docs/InternalApi.md#cancel_discount) | **DELETE** /discounts/{discountId} | Cancel discount\n*InternalApi* | [**create_coupon**](docs/InternalApi.md#create_coupon) | **POST** /coupons | Create coupon\n*InternalApi* | [**create_discount**](docs/InternalApi.md#create_discount) | **POST** /discounts | Create discount\n*InternalApi* | [**custom_reseller_url**](docs/InternalApi.md#custom_reseller_url) | **GET** /subscriptions/{subscriptionId}/upgrade_url | Custom reseller upgrade URL\n*InternalApi* | [**elastic_reindex**](docs/InternalApi.md#elastic_reindex) | **POST** /subscriptions/{subscriptionId}/elastic_reindex | Elastic reindex subscription LA data\n*InternalApi* | [**elastic_reindex_status**](docs/InternalApi.md#elastic_reindex_status) | **GET** /subscriptions/{subscriptionId}/elastic_status | LA elastic reindex status\n*InternalApi* | [**generate_for_agents**](docs/InternalApi.md#generate_for_agents) | **POST** /my-account/{subscriptionId}/_authorize | \u0026#39;My Account\u0026#39; token\n*InternalApi* | [**get_account_users**](docs/InternalApi.md#get_account_users) | **GET** /subscriptions/{subscriptionId}/account_users | Account users\n*InternalApi* | [**get_coupons**](docs/InternalApi.md#get_coupons) | **GET** /coupons | Coupons list\n*InternalApi* | [**get_discount**](docs/InternalApi.md#get_discount) | **GET** /discounts/{discountId} | Discount\n*InternalApi* | [**get_discounts**](docs/InternalApi.md#get_discounts) | **GET** /discounts | Discount list\n*InternalApi* | [**get_outbox_email**](docs/InternalApi.md#get_outbox_email) | **GET** /outbox/{emailId} | Email\n*InternalApi* | [**get_outbox_emails**](docs/InternalApi.md#get_outbox_emails) | **GET** /outbox | Email list\n*InternalApi* | [**get_subscription_status_history**](docs/InternalApi.md#get_subscription_status_history) | **GET** /subscriptions/{subscriptionId}/status_history | Status history\n*InternalApi* | [**get_usage_breakdown**](docs/InternalApi.md#get_usage_breakdown) | **GET** /subscriptions/{subscriptionId}/__usage_breakdown | Show usage breakdown\n*InvoicesApi* | [**download_invoice**](docs/InvoicesApi.md#download_invoice) | **GET** /invoices/{invoiceNumber}/_download | Download invoice\n*InvoicesApi* | [**get_invoice**](docs/InvoicesApi.md#get_invoice) | **GET** /invoices/{invoiceNumber} | Invoice\n*InvoicesApi* | [**get_invoices**](docs/InvoicesApi.md#get_invoices) | **GET** /invoices | Invoice list\n*InvoicesApi* | [**refund_invoice**](docs/InvoicesApi.md#refund_invoice) | **POST** /invoices/{invoiceNumber}/_refund | Refund invoice\n*InvoicesApi* | [**regenerate_invoice**](docs/InvoicesApi.md#regenerate_invoice) | **POST** /invoices/{invoiceNumber}/_regenerate_pdf | Regenerate invoice pdf\n*LakbdomainApi* | [**check_certificate**](docs/LakbdomainApi.md#check_certificate) | **PUT** /lakbdomain/_check_certificate | Certificate check\n*LiveagentApi* | [**set_knowledgebases**](docs/LiveagentApi.md#set_knowledgebases) | **POST** /subscriptions/{subscriptionId}/liveagent/knowledgebases | Set knowledgebase settings\n*MassActionsApi* | [**mass_delete**](docs/MassActionsApi.md#mass_delete) | **POST** /subscriptions/massAction/_delete | Delete multiple subscriptions\n*MassActionsApi* | [**mass_suspend**](docs/MassActionsApi.md#mass_suspend) | **POST** /subscriptions/massAction/_suspend | Suspend multiple subscriptions\n*MassActionsApi* | [**mass_terminate**](docs/MassActionsApi.md#mass_terminate) | **POST** /subscriptions/massAction/_terminate | Terminate multiple subscriptions\n*MassActionsApi* | [**mass_update**](docs/MassActionsApi.md#mass_update) | **POST** /subscriptions/massAction/_update | Update multiple subscriptions\n*MinionsApi* | [**add_new_minion**](docs/MinionsApi.md#add_new_minion) | **POST** /minions | Add new minion\n*MinionsApi* | [**delete_minion**](docs/MinionsApi.md#delete_minion) | **DELETE** /minions/{minionId} | Delete minion\n*MinionsApi* | [**edit_minion**](docs/MinionsApi.md#edit_minion) | **PUT** /minions/{minionId} | Edit minion\n*MinionsApi* | [**get_minion**](docs/MinionsApi.md#get_minion) | **GET** /minions/{minionId} | Minion\n*MinionsApi* | [**get_minion_cluster_names**](docs/MinionsApi.md#get_minion_cluster_names) | **GET** /minions/options/clusterNames | Minion cluster names list\n*MinionsApi* | [**get_minion_roles**](docs/MinionsApi.md#get_minion_roles) | **GET** /minions/options/roles | Minion roles list\n*MinionsApi* | [**get_minions**](docs/MinionsApi.md#get_minions) | **GET** /minions | Minions list\n*MinionsApi* | [**re_sync_minion**](docs/MinionsApi.md#re_sync_minion) | **POST** /minions/{minionId}/_reSync | Resync minion and set it up\n*MinionsApi* | [**set_minion_down**](docs/MinionsApi.md#set_minion_down) | **POST** /minions/{minionId}/_setDown | Set minion down\n*MinionsApi* | [**set_minion_up**](docs/MinionsApi.md#set_minion_up) | **POST** /minions/{minionId}/_setUp | Set minion up\n*MyAccountApi* | [**cancel_stop**](docs/MyAccountApi.md#cancel_stop) | **POST** /my-account/_cancelStop | Restart billing\n*MyAccountApi* | [**change_addons_for_my_account**](docs/MyAccountApi.md#change_addons_for_my_account) | **PUT** /my-account/addons | Addon change\n*MyAccountApi* | [**download_invoice_for_my_account**](docs/MyAccountApi.md#download_invoice_for_my_account) | **GET** /my-account/invoices/{invoiceNumber}/_download | Download invoice\n*MyAccountApi* | [**download_summary**](docs/MyAccountApi.md#download_summary) | **GET** /my-account/summary/{orderNumber}/_download | Downloads summary\n*MyAccountApi* | [**generate**](docs/MyAccountApi.md#generate) | **POST** /checkout/_authorize | \u0026#39;My Account\u0026#39; token\n*MyAccountApi* | [**get_account_invoices**](docs/MyAccountApi.md#get_account_invoices) | **GET** /my-account/invoices | Invoices list\n*MyAccountApi* | [**get_account_summaries**](docs/MyAccountApi.md#get_account_summaries) | **GET** /my-account/summary/history | Summaries list\n*MyAccountApi* | [**get_active_addons_for_my_account**](docs/MyAccountApi.md#get_active_addons_for_my_account) | **GET** /my-account/addons | Plan addons list\n*MyAccountApi* | [**get_agents_count**](docs/MyAccountApi.md#get_agents_count) | **GET** /my-account/usage/agents/count | Agents count\n*MyAccountApi* | [**get_all_variation_addons_for_my_account**](docs/MyAccountApi.md#get_all_variation_addons_for_my_account) | **GET** /my-account/variations/{variationId}/addons | Variations addons\n*MyAccountApi* | [**get_billing_info_for_my_account**](docs/MyAccountApi.md#get_billing_info_for_my_account) | **GET** /my-account/billingInfo | Billing info\n*MyAccountApi* | [**get_billing_status_for_my_account**](docs/MyAccountApi.md#get_billing_status_for_my_account) | **GET** /my-account/billingStatus | Billing status\n*MyAccountApi* | [**get_coupon_for_my_account**](docs/MyAccountApi.md#get_coupon_for_my_account) | **GET** /my-account/coupons/{couponCode} | Coupon\n*MyAccountApi* | [**get_knowledgebases_count**](docs/MyAccountApi.md#get_knowledgebases_count) | **GET** /my-account/usage/knowledgebases/count | Knowledgebases count\n*MyAccountApi* | [**get_payment_method_for_my_account**](docs/MyAccountApi.md#get_payment_method_for_my_account) | **GET** /my-account/paymentMethod | Get Payment method\n*MyAccountApi* | [**get_payment_processor_for_my_account**](docs/MyAccountApi.md#get_payment_processor_for_my_account) | **GET** /my-account/paymentProcessor | Payment processor\n*MyAccountApi* | [**get_subscription_for_my_account**](docs/MyAccountApi.md#get_subscription_for_my_account) | **GET** /my-account/subscription | Subscription\n*MyAccountApi* | [**get_summary_for_my_account**](docs/MyAccountApi.md#get_summary_for_my_account) | **GET** /my-account/summary | Current period summary\n*MyAccountApi* | [**get_upgrade_variations_for_my_account**](docs/MyAccountApi.md#get_upgrade_variations_for_my_account) | **GET** /my-account/upgradeVariations | Upgrade variation list\n*MyAccountApi* | [**get_variation_for_my_account**](docs/MyAccountApi.md#get_variation_for_my_account) | **GET** /my-account/variation | Variation\n*MyAccountApi* | [**parameters**](docs/MyAccountApi.md#parameters) | **GET** /my-account/parameters | \u0026#39;My Account\u0026#39; parameters\n*MyAccountApi* | [**predict_price**](docs/MyAccountApi.md#predict_price) | **POST** /my-account/_predictPrice | Returns list of items and predicted price\n*MyAccountApi* | [**send_payment_error**](docs/MyAccountApi.md#send_payment_error) | **POST** /my-account/sendPaymentError | Sends payment error to server\n*MyAccountApi* | [**stop_account**](docs/MyAccountApi.md#stop_account) | **POST** /my-account/_stop | Stop billing\n*MyAccountApi* | [**update_billing_info**](docs/MyAccountApi.md#update_billing_info) | **PUT** /my-account/billingInfo | Billing info\n*MyAccountApi* | [**update_payment_method**](docs/MyAccountApi.md#update_payment_method) | **PUT** /my-account/paymentMethod | Update payment method\n*MyAccountApi* | [**upgrade_plan**](docs/MyAccountApi.md#upgrade_plan) | **POST** /my-account/_upgrade | Change plan\n*MyAccountApi* | [**validate_billing_info_for_my_account**](docs/MyAccountApi.md#validate_billing_info_for_my_account) | **POST** /my-account/_validateBillingInfo | Test Billing info\n*ProductsApi* | [**create_product_version**](docs/ProductsApi.md#create_product_version) | **POST** /products/{productId}/versions | Create new product version\n*ProductsApi* | [**delete_product_version**](docs/ProductsApi.md#delete_product_version) | **DELETE** /products/{productId}/versions/{productVersionName} | Delete product version\n*ProductsApi* | [**get_all_product_available_versions**](docs/ProductsApi.md#get_all_product_available_versions) | **GET** /products/{productId}/available_versions | Product available versions\n*ProductsApi* | [**get_product**](docs/ProductsApi.md#get_product) | **GET** /products/{productId} | Product\n*ProductsApi* | [**get_product_version**](docs/ProductsApi.md#get_product_version) | **GET** /products/{productId}/versions/{productVersionName} | Product version\n*ProductsApi* | [**get_product_versions**](docs/ProductsApi.md#get_product_versions) | **GET** /products/{productId}/versions | Product versions\n*ProductsApi* | [**get_products**](docs/ProductsApi.md#get_products) | **GET** /products | Products list\n*ProductsApi* | [**mark_product_version_for_deletion**](docs/ProductsApi.md#mark_product_version_for_deletion) | **PUT** /products/{productId}/versions/{productVersionName}/mark_for_deletion | Mark product version for deletion\n*ProductsApi* | [**update_product_version**](docs/ProductsApi.md#update_product_version) | **PUT** /products/{productId}/versions/{productVersionName} | Update product version\n*RedeemCodesApi* | [**create_redeem_code**](docs/RedeemCodesApi.md#create_redeem_code) | **POST** /redeem_codes | Create redeem code\n*RedeemCodesApi* | [**get_redeem_code**](docs/RedeemCodesApi.md#get_redeem_code) | **GET** /redeem_codes/{redeemCode} | Redeem code\n*RedeemCodesApi* | [**get_redeem_codes**](docs/RedeemCodesApi.md#get_redeem_codes) | **GET** /redeem_codes | Redeem codes list\n*RedeemCodesApi* | [**redeem_code_signup**](docs/RedeemCodesApi.md#redeem_code_signup) | **POST** /redeem_code/signup | Create subscription\n*RedeemCodesApi* | [**redeem_codes_import**](docs/RedeemCodesApi.md#redeem_codes_import) | **POST** /redeem_codes/import | Import redeem codes\n*RefundsApi* | [**get_refund**](docs/RefundsApi.md#get_refund) | **GET** /refunds/{refundId} | Refund\n*RefundsApi* | [**get_refunds**](docs/RefundsApi.md#get_refunds) | **GET** /refunds | Refund list\n*ResellerApi* | [**get_reseller_billed_periods**](docs/ResellerApi.md#get_reseller_billed_periods) | **GET** /reseller/subscriptions/{subscriptionId}/billed_periods | Reseller subscription billed period list\n*ResellerApi* | [**get_reseller_invoices**](docs/ResellerApi.md#get_reseller_invoices) | **GET** /reseller/invoices | Reseller invoice list\n*ResellerApi* | [**get_reseller_subscription**](docs/ResellerApi.md#get_reseller_subscription) | **GET** /reseller/subscriptions/{subscriptionId} | Get reseller subscription\n*ResellerApi* | [**get_reseller_subscription_usage**](docs/ResellerApi.md#get_reseller_subscription_usage) | **GET** /reseller/subscriptions/{subscriptionId}/usage/agents | Get reseller subscription usage\n*ResellerApi* | [**get_reseller_subscriptions**](docs/ResellerApi.md#get_reseller_subscriptions) | **GET** /reseller/subscriptions | Get reseller subscriptions\n*ResellerApi* | [**reseller_change_plan**](docs/ResellerApi.md#reseller_change_plan) | **POST** /reseller/subscriptions/{subscriptionId}/_upgrade | Change plan\n*ResellerApi* | [**reseller_signup**](docs/ResellerApi.md#reseller_signup) | **POST** /reseller/subscriptions | Create reseller subscription\n*ResellerApi* | [**suspend_reseller_subscription**](docs/ResellerApi.md#suspend_reseller_subscription) | **POST** /reseller/subscriptions/{subscriptionId}/_suspend | Suspend reseller subscription\n*ResellerApi* | [**unsuspend_reseller_subscription**](docs/ResellerApi.md#unsuspend_reseller_subscription) | **POST** /reseller/subscriptions/{subscriptionId}/_unsuspend | Unsuspend reseller subscription\n*SettingsApi* | [**get_settings**](docs/SettingsApi.md#get_settings) | **GET** /settings | Settings list\n*SettingsApi* | [**update_setting_group**](docs/SettingsApi.md#update_setting_group) | **PUT** /settings | Update setting group\n*StatsApi* | [**get_account_stats**](docs/StatsApi.md#get_account_stats) | **GET** /stats/account | Account stats\n*StatsApi* | [**get_agents_stats**](docs/StatsApi.md#get_agents_stats) | **GET** /stats/agents | Agents stats for accounts with 10 or more agents\n*StatsApi* | [**get_sale_stats**](docs/StatsApi.md#get_sale_stats) | **GET** /stats/sale | Sale stats\n*StatsApi* | [**get_versions_stats**](docs/StatsApi.md#get_versions_stats) | **GET** /stats/versions | Versions stats\n*SubscriptionsApi* | [**add_free_addons**](docs/SubscriptionsApi.md#add_free_addons) | **POST** /subscriptions/{subscriptionId}/_addFreeAddons | Add free addons\n*SubscriptionsApi* | [**aet_account_manager**](docs/SubscriptionsApi.md#aet_account_manager) | **PUT** /subscriptions/{subscriptionId}/account_manager | Assign account manager\n*SubscriptionsApi* | [**agree_with_request_billing**](docs/SubscriptionsApi.md#agree_with_request_billing) | **POST** /subscriptions/{subscriptionId}/pap_request_billing | PAP agree with additional billing\n*SubscriptionsApi* | [**change_addons**](docs/SubscriptionsApi.md#change_addons) | **PUT** /subscriptions/{subscriptionId}/addons | Addon change\n*SubscriptionsApi* | [**change_plan**](docs/SubscriptionsApi.md#change_plan) | **POST** /subscriptions/{subscriptionId}/_upgrade | Change plan\n*SubscriptionsApi* | [**check_domain**](docs/SubscriptionsApi.md#check_domain) | **POST** /subscriptions/_check_domain | Domain availability\n*SubscriptionsApi* | [**clear_last_payment_fail**](docs/SubscriptionsApi.md#clear_last_payment_fail) | **POST** /subscriptions/{subscriptionId}/_clearLastPaymentFail | Clear last payment fail\n*SubscriptionsApi* | [**delete**](docs/SubscriptionsApi.md#delete) | **POST** /subscriptions/{subscriptionId}/_delete | Delete subscription\n*SubscriptionsApi* | [**extend_validity**](docs/SubscriptionsApi.md#extend_validity) | **POST** /subscriptions/{subscriptionId}/_extendValidity | Extends account validity\n*SubscriptionsApi* | [**get_account**](docs/SubscriptionsApi.md#get_account) | **GET** /accounts/{accountId} | Account\n*SubscriptionsApi* | [**get_account_manager**](docs/SubscriptionsApi.md#get_account_manager) | **GET** /subscriptions/{subscriptionId}/account_manager | Get account manager\n*SubscriptionsApi* | [**get_active_addons**](docs/SubscriptionsApi.md#get_active_addons) | **GET** /subscriptions/{subscriptionId}/addons | Addon list\n*SubscriptionsApi* | [**get_billing_info**](docs/SubscriptionsApi.md#get_billing_info) | **GET** /subscriptions/{subscriptionId}/billingInfo | Billing info\n*SubscriptionsApi* | [**get_billing_metrics**](docs/SubscriptionsApi.md#get_billing_metrics) | **GET** /subscriptions/{subscriptionId}/billingMetrics | Billing metrics\n*SubscriptionsApi* | [**get_billing_status**](docs/SubscriptionsApi.md#get_billing_status) | **GET** /subscriptions/{subscriptionId}/billingStatus | Billing status\n*SubscriptionsApi* | [**get_domain_info**](docs/SubscriptionsApi.md#get_domain_info) | **GET** /subscriptions/{subscriptionId}/domain | Domain info\n*SubscriptionsApi* | [**get_failed_payment**](docs/SubscriptionsApi.md#get_failed_payment) | **GET** /failed_payments/{failedPaymentId} | Failed payment\n*SubscriptionsApi* | [**get_failed_payments**](docs/SubscriptionsApi.md#get_failed_payments) | **GET** /failed_payments | Failed payment list\n*SubscriptionsApi* | [**get_install_progress**](docs/SubscriptionsApi.md#get_install_progress) | **GET** /subscriptions/{subscriptionId}/install_progress | Install progress\n*SubscriptionsApi* | [**get_note**](docs/SubscriptionsApi.md#get_note) | **GET** /subscriptions/{subscriptionId}/note | Note\n*SubscriptionsApi* | [**get_payment_method**](docs/SubscriptionsApi.md#get_payment_method) | **GET** /subscriptions/{subscriptionId}/paymentMethod | Payment method\n*SubscriptionsApi* | [**get_payment_processor**](docs/SubscriptionsApi.md#get_payment_processor) | **GET** /subscriptions/{subscriptionId}/paymentProcessor | Payment processor\n*SubscriptionsApi* | [**get_source**](docs/SubscriptionsApi.md#get_source) | **GET** /subscriptions/{subscriptionId}/source | Install source\n*SubscriptionsApi* | [**get_subscription**](docs/SubscriptionsApi.md#get_subscription) | **GET** /subscriptions/{subscriptionId} | Subscription\n*SubscriptionsApi* | [**get_subscription_attributes**](docs/SubscriptionsApi.md#get_subscription_attributes) | **GET** /subscriptions/{subscriptionId}/attributes | Subscription attribute list\n*SubscriptionsApi* | [**get_subscription_discounts**](docs/SubscriptionsApi.md#get_subscription_discounts) | **GET** /subscriptions/{subscriptionId}/discounts | Subscription discounts\n*SubscriptionsApi* | [**get_subscription_invoices**](docs/SubscriptionsApi.md#get_subscription_invoices) | **GET** /subscriptions/{subscriptionId}/invoices | Subscription invoice list\n*SubscriptionsApi* | [**get_subscriptions**](docs/SubscriptionsApi.md#get_subscriptions) | **GET** /subscriptions | Subscription list\n*SubscriptionsApi* | [**get_upgrade_variations**](docs/SubscriptionsApi.md#get_upgrade_variations) | **GET** /subscriptions/{subscriptionId}/upgradeVariations | Upgrade variation list\n*SubscriptionsApi* | [**is_additional_billing_agreed**](docs/SubscriptionsApi.md#is_additional_billing_agreed) | **GET** /subscriptions/{subscriptionId}/pap_request_billing | PAP get additional billing\n*SubscriptionsApi* | [**refresh_account**](docs/SubscriptionsApi.md#refresh_account) | **POST** /subscriptions/{subscriptionId}/_refreshAccount | Refresh account\n*SubscriptionsApi* | [**remove_lock**](docs/SubscriptionsApi.md#remove_lock) | **PUT** /subscriptions/{subscriptionId}/unlock | Remove lock\n*SubscriptionsApi* | [**resume_billing**](docs/SubscriptionsApi.md#resume_billing) | **POST** /subscriptions/{subscriptionId}/_cancelStop | Restart billing\n*SubscriptionsApi* | [**set_billing_info**](docs/SubscriptionsApi.md#set_billing_info) | **PUT** /subscriptions/{subscriptionId}/billingInfo | Billing info\n*SubscriptionsApi* | [**set_custom_domain**](docs/SubscriptionsApi.md#set_custom_domain) | **PUT** /subscriptions/{subscriptionId}/custom_domain | Custom domain\n*SubscriptionsApi* | [**set_default_domain**](docs/SubscriptionsApi.md#set_default_domain) | **PUT** /subscriptions/{subscriptionId}/default_domain | Default domain\n*SubscriptionsApi* | [**set_domain**](docs/SubscriptionsApi.md#set_domain) | **PUT** /subscriptions/{subscriptionId}/domain | Custom domain\n*SubscriptionsApi* | [**set_lock**](docs/SubscriptionsApi.md#set_lock) | **PUT** /subscriptions/{subscriptionId}/lock | Set subscription lock\n*SubscriptionsApi* | [**set_note**](docs/SubscriptionsApi.md#set_note) | **PUT** /subscriptions/{subscriptionId}/note | Note\n*SubscriptionsApi* | [**set_owner_email**](docs/SubscriptionsApi.md#set_owner_email) | **PUT** /subscriptions/{subscriptionId}/owner_email | Owner\u0026#39;s email\n*SubscriptionsApi* | [**set_pap_tracking_params**](docs/SubscriptionsApi.md#set_pap_tracking_params) | **PUT** /subscriptions/{subscriptionId}/pap_tracking_params | PAP tracking params\n*SubscriptionsApi* | [**set_payment_method**](docs/SubscriptionsApi.md#set_payment_method) | **PUT** /subscriptions/{subscriptionId}/paymentMethod | Payment method\n*SubscriptionsApi* | [**set_source**](docs/SubscriptionsApi.md#set_source) | **PUT** /subscriptions/{subscriptionId}/source | Install source\n*SubscriptionsApi* | [**set_subscription_usage**](docs/SubscriptionsApi.md#set_subscription_usage) | **PUT** /subscriptions/{subscriptionId}/usage | Subscription usage\n*SubscriptionsApi* | [**set_update_policy**](docs/SubscriptionsApi.md#set_update_policy) | **PUT** /subscriptions/{subscriptionId}/update_policy | Set update policy\n*SubscriptionsApi* | [**signup**](docs/SubscriptionsApi.md#signup) | **POST** /subscriptions | Create subscription\n*SubscriptionsApi* | [**stop_billing**](docs/SubscriptionsApi.md#stop_billing) | **POST** /subscriptions/{subscriptionId}/_stop | Stop billing\n*SubscriptionsApi* | [**suspend**](docs/SubscriptionsApi.md#suspend) | **POST** /subscriptions/{subscriptionId}/_suspend | Suspend subscription\n*SubscriptionsApi* | [**terminate**](docs/SubscriptionsApi.md#terminate) | **POST** /subscriptions/{subscriptionId}/_terminate | Terminate subscription\n*SubscriptionsApi* | [**unsuspend**](docs/SubscriptionsApi.md#unsuspend) | **POST** /subscriptions/{subscriptionId}/_unsuspend | Unsuspend subscription\n*SubscriptionsApi* | [**update_application**](docs/SubscriptionsApi.md#update_application) | **POST** /subscriptions/{subscriptionId}/_update | Update subscription\n*SubscriptionsApi* | [**validate_billing_info**](docs/SubscriptionsApi.md#validate_billing_info) | **POST** /subscriptions/{subscriptionId}/_validateBillingInfo | Test Billing info\n*TasksApi* | [**get_rich_task**](docs/TasksApi.md#get_rich_task) | **GET** /executor/tasks/{taskId} | Task\n*TasksApi* | [**get_rich_task_attempt**](docs/TasksApi.md#get_rich_task_attempt) | **GET** /executor/task_attempts/{taskAttemptId} | Task attempt\n*TasksApi* | [**get_task_action**](docs/TasksApi.md#get_task_action) | **GET** /executor/actions/{actionId} | Action\n*TasksApi* | [**get_task_minion_job**](docs/TasksApi.md#get_task_minion_job) | **GET** /executor/actions/{actionId}/minion_jobs/{minionId} | Minion job\n*TasksApi* | [**get_tasks**](docs/TasksApi.md#get_tasks) | **GET** /executor/tasks | List of tasks\n*TasksApi* | [**mark_task_broken**](docs/TasksApi.md#mark_task_broken) | **POST** /executor/tasks/{taskId}/_mark_broken | Mark task broken\n*TasksApi* | [**retry_task_attempt**](docs/TasksApi.md#retry_task_attempt) | **POST** /executor/tasks/{taskAttemptId}/_retry | Retry task attempt\n*TemplatesApi* | [**get_template**](docs/TemplatesApi.md#get_template) | **GET** /templates/{templateId} | Template\n*TemplatesApi* | [**get_templates**](docs/TemplatesApi.md#get_templates) | **GET** /templates | Template list\n*TemplatesApi* | [**update_template**](docs/TemplatesApi.md#update_template) | **PUT** /templates/{templateId} | Template\n*TokenApi* | [**get_access_token**](docs/TokenApi.md#get_access_token) | **POST** /token | Access token\n*VariationsApi* | [**get_all_variation_addons**](docs/VariationsApi.md#get_all_variation_addons) | **GET** /variations/{variationId}/addons | Variations addons\n*VariationsApi* | [**get_variation**](docs/VariationsApi.md#get_variation) | **GET** /variations/{variationId} | Variation\n*VariationsApi* | [**get_variation_addons**](docs/VariationsApi.md#get_variation_addons) | **GET** /variations/{variationId}/available_addons | Variations addons\n*VariationsApi* | [**get_variations**](docs/VariationsApi.md#get_variations) | **GET** /variations | Variation list\n\n\n## Documentation For Models\n\n - [Account](docs/Account.md)\n - [AccountManager](docs/AccountManager.md)\n - [AccountStats](docs/AccountStats.md)\n - [AccountUser](docs/AccountUser.md)\n - [Addon](docs/Addon.md)\n - [AddonList](docs/AddonList.md)\n - [AgentsCount](docs/AgentsCount.md)\n - [AgentsStats](docs/AgentsStats.md)\n - [AsteriskHost](docs/AsteriskHost.md)\n - [Attribute](docs/Attribute.md)\n - [AttributeSimple](docs/AttributeSimple.md)\n - [AwsRegion](docs/AwsRegion.md)\n - [BilledPeriod](docs/BilledPeriod.md)\n - [BilledPeriodItem](docs/BilledPeriodItem.md)\n - [BillingInfo](docs/BillingInfo.md)\n - [BillingMetric](docs/BillingMetric.md)\n - [BillingParameters](docs/BillingParameters.md)\n - [BillingStatus](docs/BillingStatus.md)\n - [BooleanResponse](docs/BooleanResponse.md)\n - [CalculatedItem](docs/CalculatedItem.md)\n - [CalculatedItems](docs/CalculatedItems.md)\n - [Country](docs/Country.md)\n - [Coupon](docs/Coupon.md)\n - [Credentials](docs/Credentials.md)\n - [CustomDomain](docs/CustomDomain.md)\n - [Customer](docs/Customer.md)\n - [DefaultDomain](docs/DefaultDomain.md)\n - [DeletionMarker](docs/DeletionMarker.md)\n - [DevSignup](docs/DevSignup.md)\n - [Discount](docs/Discount.md)\n - [DiscountTemplate](docs/DiscountTemplate.md)\n - [DiscountValue](docs/DiscountValue.md)\n - [Domain](docs/Domain.md)\n - [Email](docs/Email.md)\n - [ErrorResponse](docs/ErrorResponse.md)\n - [EventLogs](docs/EventLogs.md)\n - [FailedPayment](docs/FailedPayment.md)\n - [HackDummyPayment](docs/HackDummyPayment.md)\n - [HostedApiKey](docs/HostedApiKey.md)\n - [Ids](docs/Ids.md)\n - [IndexStatus](docs/IndexStatus.md)\n - [InitialLang](docs/InitialLang.md)\n - [InitialLoginAttempts](docs/InitialLoginAttempts.md)\n - [InstallProgress](docs/InstallProgress.md)\n - [Invoice](docs/Invoice.md)\n - [InvoiceItem](docs/InvoiceItem.md)\n - [KnowledgebasesCount](docs/KnowledgebasesCount.md)\n - [LaKbCollection](docs/LaKbCollection.md)\n - [LaKbDomain](docs/LaKbDomain.md)\n - [LaKbParked](docs/LaKbParked.md)\n - [LaKbProxy](docs/LaKbProxy.md)\n - [LoginUrl](docs/LoginUrl.md)\n - [MassResponse](docs/MassResponse.md)\n - [Message](docs/Message.md)\n - [Minion](docs/Minion.md)\n - [MinionInfo](docs/MinionInfo.md)\n - [MinionJob](docs/MinionJob.md)\n - [MyAccountParameters](docs/MyAccountParameters.md)\n - [MyAccountToken](docs/MyAccountToken.md)\n - [Note](docs/Note.md)\n - [OwnerEmail](docs/OwnerEmail.md)\n - [PapTrackingParams](docs/PapTrackingParams.md)\n - [PaymentErrorInfo](docs/PaymentErrorInfo.md)\n - [PaymentInfo](docs/PaymentInfo.md)\n - [PaymentMethod](docs/PaymentMethod.md)\n - [PaymentProcessorType](docs/PaymentProcessorType.md)\n - [PeriodPricing](docs/PeriodPricing.md)\n - [Product](docs/Product.md)\n - [ProductVersion](docs/ProductVersion.md)\n - [PublicIp](docs/PublicIp.md)\n - [RangeValue](docs/RangeValue.md)\n - [RedeemCode](docs/RedeemCode.md)\n - [RedeemCodeSignup](docs/RedeemCodeSignup.md)\n - [RedeemCodesImport](docs/RedeemCodesImport.md)\n - [Redemption](docs/Redemption.md)\n - [Refund](docs/Refund.md)\n - [RefundRequest](docs/RefundRequest.md)\n - [ReindexData](docs/ReindexData.md)\n - [ReindexStatusData](docs/ReindexStatusData.md)\n - [ResellerSignup](docs/ResellerSignup.md)\n - [ResellerSubscription](docs/ResellerSubscription.md)\n - [ResellerUpgrade](docs/ResellerUpgrade.md)\n - [SaleStats](docs/SaleStats.md)\n - [Score](docs/Score.md)\n - [Setting](docs/Setting.md)\n - [SettingGroup](docs/SettingGroup.md)\n - [Signup](docs/Signup.md)\n - [Source](docs/Source.md)\n - [Subscription](docs/Subscription.md)\n - [SubscriptionStatusHistory](docs/SubscriptionStatusHistory.md)\n - [SubscriptionViewData](docs/SubscriptionViewData.md)\n - [SubscriptionViewDb](docs/SubscriptionViewDb.md)\n - [Summary](docs/Summary.md)\n - [SummaryHistoryItem](docs/SummaryHistoryItem.md)\n - [SummaryInvoice](docs/SummaryInvoice.md)\n - [Task](docs/Task.md)\n - [TaskAttempt](docs/TaskAttempt.md)\n - [TaskStep](docs/TaskStep.md)\n - [TaskStepAction](docs/TaskStepAction.md)\n - [Template](docs/Template.md)\n - [Token](docs/Token.md)\n - [TrackGaClient](docs/TrackGaClient.md)\n - [TrackPapSignupIp](docs/TrackPapSignupIp.md)\n - [TrackPapUserAgent](docs/TrackPapUserAgent.md)\n - [Upgrade](docs/Upgrade.md)\n - [UpgradeUrl](docs/UpgradeUrl.md)\n - [UsageData](docs/UsageData.md)\n - [ValidityExtension](docs/ValidityExtension.md)\n - [Variation](docs/Variation.md)\n - [VariationUpgrade](docs/VariationUpgrade.md)\n - [VariationUpgrades](docs/VariationUpgrades.md)\n - [VersionInfo](docs/VersionInfo.md)\n - [VersionName](docs/VersionName.md)\n - [VersionStats](docs/VersionStats.md)\n\n\n\u003ca id=\"documentation-for-authorization\"\u003e\u003c/a\u003e\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n\u003ca id=\"privileges\"\u003e\u003c/a\u003e\n### privileges\n\n- **Type**: OAuth\n- **Flow**: accessCode\n- **Authorization URL**: \n- **Scopes**: \n - **hack.dummy_payment**: set dummy payment\n - **agent.login**: Log into an account\n - **attribute.read**: Read attributes\n - **attribute.write**: Change attributes\n - **dev.create_subscription**: Create dev subscription\n - **event_logs.read**: Event logs read\n - **invoice.read**: Read invoices\n - **job.read**: Jobs read\n - **product.read**: Products read\n - **product.write**: Products write\n - **refund.read**: Refunds read\n - **refund.write**: Refunds write\n - **reseller.own**: Read info related to reseller making the call\n - **reseller.signup**: Create new reseller subscription\n - **reseller.read**: Read information about reseller\n - **reseller.write**: Manage reseller or reseller subscriptions\n - **subscription.own**: Read/write own subscriptions (use 'me' as subscriptionId)\n - **subscription.read**: Subscriptions read\n - **subscription.basicOperations**: Subscriptions operations allowed for agent\n - **subscription.write**: Subscriptions write\n - **subscription.delete**: Subscriptions delete\n - **subscription.reindex**: Reindex of account\n - **subscription.massActions**: Subscriptions mass actions\n - **subscription.changeDomain**: Change default or custom domain\n - **subscription.changeDefaultDomain**: Change default domain\n - **subscription.changeCustomDomain**: Change custom domain\n - **task.read**: Tasks read\n - **task.write**: Tasks write\n - **template.read**: Read templates\n - **template.write**: Change templates\n - **variation.read**: Variations read\n - **minion.read**: Minions read\n - **minion.write**: Minions write\n - **stats.sale**: Sale stats\n - **stats.account**: Account numbers stats\n - **settings.read**: Read settings\n - **settings.write**: Change settings\n - **stats.versions**: Get stat versions\n - **stats.agents**: Get stat agents\n\n\n## Author\n\nsupport@qualityunit.com\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqualityunit%2Fcrm-api-python-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqualityunit%2Fcrm-api-python-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqualityunit%2Fcrm-api-python-client/lists"}