agilicus 1.271.16__py3-none-any.whl → 1.271.18__py3-none-any.whl

agilicus/agilicus_api/docs/BillingApi.md

@@ -33,12 +33,14 @@ Method | HTTP request | Description
 [**list_subscription_features**](BillingApi.md#list_subscription_features) | **GET** /v1/billing_subscriptions/{billing_subscription_id}/features | Get all subscription features
 [**list_subscriptions**](BillingApi.md#list_subscriptions) | **GET** /v1/billing_subscriptions | Get all billing subscriptions for a billing account
 [**list_subscriptions_with_feature**](BillingApi.md#list_subscriptions_with_feature) | **GET** /v1/features/{feature_id}/subscriptions | Get all subscriptions using feature_id
+[**new_subscription**](BillingApi.md#new_subscription) | **POST** /v1/billing_subscriptions/{billing_subscription_id}/new_subscription | Create a new upstream subscription
 [**remove_org_from_billing_account**](BillingApi.md#remove_org_from_billing_account) | **DELETE** /v1/billing_accounts/{billing_account_id}/orgs/{org_id} | Remove an org from a billing account
 [**remove_org_from_billing_subscription**](BillingApi.md#remove_org_from_billing_subscription) | **DELETE** /v1/billing_subscriptions/{billing_subscription_id}/orgs/{org_id} | Remove an org from a billing subscription
 [**replace_billing_account**](BillingApi.md#replace_billing_account) | **PUT** /v1/billing_accounts/{billing_account_id} | Create or update a billing account
 [**replace_feature**](BillingApi.md#replace_feature) | **PUT** /v1/features/{feature_id} | update a Feature
 [**replace_product**](BillingApi.md#replace_product) | **PUT** /v1/products/{product_id} | Create or update a product
 [**replace_subscription**](BillingApi.md#replace_subscription) | **PUT** /v1/billing_subscriptions/{billing_subscription_id} | Create or update a billing subscription
+[**update_subscription_cancellation**](BillingApi.md#update_subscription_cancellation) | **POST** /v1/billing_subscriptions/{billing_subscription_id}/cancel | Update the subscription cancellation detail
 
 
 # **add_billing_usage_record**
@@ -696,6 +698,16 @@ with agilicus_api.ApiClient(configuration) as api_client:
                             "123",
                         ],
                         product_id="123",
+                        cancel_detail=BillingSubscriptionCancelDetail(
+                            cancel_at_period_end=True,
+                            cancel_at=dateutil_parser('2025-07-07T15:49:51.23+02:00'),
+                            immediately=True,
+                            comment="comment_example",
+                            feedback="feedback_example",
+                            subscription=BillingSubscription(
+                                id="id_example",
+                            ),
+                        ),
                     ),
                     status=BillingOrgSubscriptionStatus(
                         orgs=[
@@ -1243,6 +1255,16 @@ with agilicus_api.ApiClient(configuration) as api_client:
                 "123",
             ],
             product_id="123",
+            cancel_detail=BillingSubscriptionCancelDetail(
+                cancel_at_period_end=True,
+                cancel_at=dateutil_parser('2025-07-07T15:49:51.23+02:00'),
+                immediately=True,
+                comment="comment_example",
+                feedback="feedback_example",
+                subscription=BillingSubscription(
+                    id="id_example",
+                ),
+            ),
         ),
         status=BillingOrgSubscriptionStatus(
             orgs=[
@@ -3055,12 +3077,14 @@ with agilicus_api.ApiClient(configuration) as api_client:
     expand_feature_overrides_query = "aba23" # str | expand all feature overrides (optional)
     get_usage_metrics = False # bool | In billing response, return all associated usage metrics (optional) if omitted the server will use the default value of False
     page_at_id = "foo@example.com" # str | Pagination based query with the id as the key. To get the initial entries supply an empty string. On subsequent requests, supply the `page_at_id` field from the list response.  (optional)
+    active_orgs_since = dateutil_parser('2015-07-07T15:49:51.230+02:00') # datetime | For billing accounts query, return only billing accounts that are associated with organisations that are active since the specific datetime (optional)
+    has_cancel_detail = True # bool | For query of billing subscriptions, query if cancel_detail exists  (optional)
 
     # example passing only required values which don't have defaults set
     # and optional values
     try:
         # Get all billing subscriptions for a billing account
-        api_response = api_instance.list_subscriptions(limit=limit, get_subscription_data=get_subscription_data, get_customer_data=get_customer_data, billing_account_id=billing_account_id, org_id=org_id, customer_id=customer_id, expand_feature_overrides_query=expand_feature_overrides_query, get_usage_metrics=get_usage_metrics, page_at_id=page_at_id)
+        api_response = api_instance.list_subscriptions(limit=limit, get_subscription_data=get_subscription_data, get_customer_data=get_customer_data, billing_account_id=billing_account_id, org_id=org_id, customer_id=customer_id, expand_feature_overrides_query=expand_feature_overrides_query, get_usage_metrics=get_usage_metrics, page_at_id=page_at_id, active_orgs_since=active_orgs_since, has_cancel_detail=has_cancel_detail)
         pprint(api_response)
     except agilicus_api.ApiException as e:
         print("Exception when calling BillingApi->list_subscriptions: %s\n" % e)
@@ -3080,6 +3104,8 @@ Name | Type | Description  | Notes
  **expand_feature_overrides_query** | **str**| expand all feature overrides | [optional]
  **get_usage_metrics** | **bool**| In billing response, return all associated usage metrics | [optional] if omitted the server will use the default value of False
  **page_at_id** | **str**| Pagination based query with the id as the key. To get the initial entries supply an empty string. On subsequent requests, supply the `page_at_id` field from the list response.  | [optional]
+ **active_orgs_since** | **datetime**| For billing accounts query, return only billing accounts that are associated with organisations that are active since the specific datetime | [optional]
+ **has_cancel_detail** | **bool**| For query of billing subscriptions, query if cancel_detail exists  | [optional]
 
 ### Return type
 
@@ -3191,6 +3217,329 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **new_subscription**
+> BillingSubscriptionNewSubscription new_subscription(billing_subscription_id)
+
+Create a new upstream subscription
+
+Create a new upstream subscription
+
+### Example
+
+* Bearer (JWT) Authentication (token-valid):
+```python
+import time
+import agilicus_api
+from agilicus_api.api import billing_api
+from agilicus_api.model.billing_subscription_new_subscription import BillingSubscriptionNewSubscription
+from pprint import pprint
+# Defining the host is optional and defaults to https://api.agilicus.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = agilicus_api.Configuration(
+    host = "https://api.agilicus.com"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): token-valid
+configuration = agilicus_api.Configuration(
+    access_token = 'YOUR_BEARER_TOKEN'
+)
+
+# Enter a context with an instance of the API client
+with agilicus_api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = billing_api.BillingApi(api_client)
+    billing_subscription_id = "1234" # str | Billing subscription Unique identifier
+    billing_subscription_new_subscription = BillingSubscriptionNewSubscription(
+        description="description_example",
+        trial_period=25,
+        updated_subscription=BillingOrgSubscription(
+            metadata=MetadataWithId(),
+            spec=BillingOrgSubscriptionSpec(
+                billing_account_id="123",
+                dev_mode=True,
+                subscription_id="subscription_id_example",
+                usage_override=[
+                    BillingSubscriptionUsageOverrideItem(
+                        metric="metric_example",
+                        min_quantity=1,
+                        max_quantity=1,
+                        step_size=1,
+                        group_by_org=True,
+                    ),
+                ],
+                feature_overrides=[
+                    "123",
+                ],
+                product_id="123",
+                cancel_detail=BillingSubscriptionCancelDetail(
+                    cancel_at_period_end=True,
+                    cancel_at=dateutil_parser('2025-07-07T15:49:51.23+02:00'),
+                    immediately=True,
+                    comment="comment_example",
+                    feedback="feedback_example",
+                    subscription=BillingSubscription(
+                        id="id_example",
+                    ),
+                ),
+            ),
+            status=BillingOrgSubscriptionStatus(
+                orgs=[
+                    Organisation(
+                        all_users_group_id="123",
+                        all_users_all_suborgs_group_id="123",
+                        all_users_direct_suborgs_group_id="123",
+                        auto_created_users_group_id="123",
+                        external_id="123",
+                        organisation="some name",
+                        issuer="app1",
+                        issuer_id="123",
+                        subdomain="app1.example.com",
+                        name_slug=K8sSlug("81c2v7s6djuy1zmetozkhdomha1bae37b8ocvx8o53ow2eg7p6qw9qklp6l4y010fogx"),
+                        contact_id="123",
+                        parent_id="123",
+                        root_org_id="aB29sdkD3jlaAbl7",
+                        auto_create=False,
+                        trust_on_first_use_duration=86400,
+                        feature_flags=[
+                            FeatureFlag(
+                                feature="saml_auth",
+                                enabled=True,
+                                setting="stable",
+                            ),
+                        ],
+                        admin_state=OrganisationStateSelector("active"),
+                        status=OrganisationStatus(
+                            all_up=True,
+                            admin_up=True,
+                            issuer_up=True,
+                            current_state=OrganisationStateStatus("active"),
+                            capabilities=OrganisationCapabilities(
+                                features=[
+                                    FeatureTagName("north-america"),
+                                ],
+                            ),
+                        ),
+                        billing_account_id="123",
+                        billing_subscription_id="123",
+                        shard="A",
+                        cluster="ca-1",
+                        configured_capabilities=OrganisationCapabilities(
+                            features=[
+                                FeatureTagName("north-america"),
+                            ],
+                        ),
+                        owner_config=OrganisationOwnerConfig(
+                            disable_user_requests=False,
+                        ),
+                        product_label_override="123",
+                        system_options=OrganisationSystemOptions(
+                            new_subscription_feature_overrides=[
+                                "123",
+                            ],
+                            allowed_domains=[
+                                "app1.subdomain.com",
+                            ],
+                        ),
+                        ruleset_bundle_id="123",
+                    ),
+                ],
+                subscription=BillingSubscription(
+                    id="id_example",
+                ),
+                balance=BillingOrgSubscriptionBalance(
+                    upcoming_invoice={},
+                    subscription_balance=1,
+                    estimate_balance_end_date=dateutil_parser('1970-01-01T00:00:00.00Z'),
+                ),
+                feature_overrides=[
+                    Feature(
+                        metadata=MetadataWithId(),
+                        spec=FeatureSpec(
+                            name="name_example",
+                            description="description_example",
+                            priority=1,
+                            key="e",
+                            value=FeatureValue(
+                                enabled=True,
+                                min=1,
+                                max=1,
+                            ),
+                        ),
+                        status=FeatureStatus(
+                            products=[
+                                Product(
+                                    metadata=MetadataWithId(),
+                                    spec=ProductSpec(
+                                        name="name_example",
+                                        description="description_example",
+                                        dev_mode=True,
+                                        label="123",
+                                        billing_product_prices=[
+                                            BillingProductPrice(
+                                                id="id_example",
+                                            ),
+                                        ],
+                                        trial_period=25,
+                                        features=[
+                                            "123",
+                                        ],
+                                    ),
+                                    status=ProductStatus(
+                                        billing_product_prices=[
+                                            BillingProductPrice(
+                                                id="id_example",
+                                            ),
+                                        ],
+                                        features=[
+                                            Feature(),
+                                        ],
+                                    ),
+                                ),
+                            ],
+                        ),
+                    ),
+                ],
+                usage_metrics=UsageMetrics(
+                    metrics=[
+                        UsageMetric(
+                            type="application",
+                            org_id="IAsl3dl40aSsfLKiU76",
+                            org_ids=[
+                                "123",
+                            ],
+                            provisioned=UsageMeasurement(
+                                peak=0,
+                                current=0,
+                            ),
+                            active=UsageMeasurement(
+                                peak=0,
+                                current=0,
+                            ),
+                        ),
+                    ],
+                ),
+                products=[
+                    BillingProduct(
+                        id="id_example",
+                        name="name_example",
+                    ),
+                ],
+                product=Product(
+                    metadata=MetadataWithId(),
+                    spec=ProductSpec(
+                        name="name_example",
+                        description="description_example",
+                        dev_mode=True,
+                        label="123",
+                        billing_product_prices=[
+                            BillingProductPrice(
+                                id="id_example",
+                            ),
+                        ],
+                        trial_period=25,
+                        features=[
+                            "123",
+                        ],
+                    ),
+                    status=ProductStatus(
+                        billing_product_prices=[
+                            BillingProductPrice(
+                                id="id_example",
+                            ),
+                        ],
+                        features=[
+                            Feature(
+                                metadata=MetadataWithId(),
+                                spec=FeatureSpec(
+                                    name="name_example",
+                                    description="description_example",
+                                    priority=1,
+                                    key="e",
+                                    value=FeatureValue(
+                                        enabled=True,
+                                        min=1,
+                                        max=1,
+                                    ),
+                                ),
+                                status=FeatureStatus(
+                                    products=[
+                                        Product(),
+                                    ],
+                                ),
+                            ),
+                        ],
+                    ),
+                ),
+                provider_status=BillingProviderSubscriptionStatus(
+                    product_subscription_match=True,
+                    subscription_missing_prices=[
+                        BillingProductPrice(
+                            id="id_example",
+                        ),
+                    ],
+                    subscription_additional_prices=[
+                        BillingProductPrice(
+                            id="id_example",
+                        ),
+                    ],
+                ),
+            ),
+        ),
+    ) # BillingSubscriptionNewSubscription |  (optional)
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Create a new upstream subscription
+        api_response = api_instance.new_subscription(billing_subscription_id)
+        pprint(api_response)
+    except agilicus_api.ApiException as e:
+        print("Exception when calling BillingApi->new_subscription: %s\n" % e)
+
+    # example passing only required values which don't have defaults set
+    # and optional values
+    try:
+        # Create a new upstream subscription
+        api_response = api_instance.new_subscription(billing_subscription_id, billing_subscription_new_subscription=billing_subscription_new_subscription)
+        pprint(api_response)
+    except agilicus_api.ApiException as e:
+        print("Exception when calling BillingApi->new_subscription: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **billing_subscription_id** | **str**| Billing subscription Unique identifier |
+ **billing_subscription_new_subscription** | [**BillingSubscriptionNewSubscription**](BillingSubscriptionNewSubscription.md)|  | [optional]
+
+### Return type
+
+[**BillingSubscriptionNewSubscription**](BillingSubscriptionNewSubscription.md)
+
+### Authorization
+
+[token-valid](../README.md#token-valid)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | New upstream subscription created |  -  |
+**404** | subscription does not exist |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **remove_org_from_billing_account**
 > remove_org_from_billing_account(billing_account_id, org_id)
 
@@ -3540,6 +3889,16 @@ with agilicus_api.ApiClient(configuration) as api_client:
                             "123",
                         ],
                         product_id="123",
+                        cancel_detail=BillingSubscriptionCancelDetail(
+                            cancel_at_period_end=True,
+                            cancel_at=dateutil_parser('2025-07-07T15:49:51.23+02:00'),
+                            immediately=True,
+                            comment="comment_example",
+                            feedback="feedback_example",
+                            subscription=BillingSubscription(
+                                id="id_example",
+                            ),
+                        ),
                     ),
                     status=BillingOrgSubscriptionStatus(
                         orgs=[
@@ -4118,6 +4477,16 @@ with agilicus_api.ApiClient(configuration) as api_client:
                 "123",
             ],
             product_id="123",
+            cancel_detail=BillingSubscriptionCancelDetail(
+                cancel_at_period_end=True,
+                cancel_at=dateutil_parser('2025-07-07T15:49:51.23+02:00'),
+                immediately=True,
+                comment="comment_example",
+                feedback="feedback_example",
+                subscription=BillingSubscription(
+                    id="id_example",
+                ),
+            ),
         ),
         status=BillingOrgSubscriptionStatus(
             orgs=[
@@ -4372,3 +4741,322 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **update_subscription_cancellation**
+> BillingOrgSubscription update_subscription_cancellation(billing_subscription_id)
+
+Update the subscription cancellation detail
+
+Update the subscription cancellation detail
+
+### Example
+
+* Bearer (JWT) Authentication (token-valid):
+```python
+import time
+import agilicus_api
+from agilicus_api.api import billing_api
+from agilicus_api.model.billing_org_subscription import BillingOrgSubscription
+from pprint import pprint
+# Defining the host is optional and defaults to https://api.agilicus.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = agilicus_api.Configuration(
+    host = "https://api.agilicus.com"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): token-valid
+configuration = agilicus_api.Configuration(
+    access_token = 'YOUR_BEARER_TOKEN'
+)
+
+# Enter a context with an instance of the API client
+with agilicus_api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = billing_api.BillingApi(api_client)
+    billing_subscription_id = "1234" # str | Billing subscription Unique identifier
+    billing_org_subscription = BillingOrgSubscription(
+        metadata=MetadataWithId(),
+        spec=BillingOrgSubscriptionSpec(
+            billing_account_id="123",
+            dev_mode=True,
+            subscription_id="subscription_id_example",
+            usage_override=[
+                BillingSubscriptionUsageOverrideItem(
+                    metric="metric_example",
+                    min_quantity=1,
+                    max_quantity=1,
+                    step_size=1,
+                    group_by_org=True,
+                ),
+            ],
+            feature_overrides=[
+                "123",
+            ],
+            product_id="123",
+            cancel_detail=BillingSubscriptionCancelDetail(
+                cancel_at_period_end=True,
+                cancel_at=dateutil_parser('2025-07-07T15:49:51.23+02:00'),
+                immediately=True,
+                comment="comment_example",
+                feedback="feedback_example",
+                subscription=BillingSubscription(
+                    id="id_example",
+                ),
+            ),
+        ),
+        status=BillingOrgSubscriptionStatus(
+            orgs=[
+                Organisation(
+                    all_users_group_id="123",
+                    all_users_all_suborgs_group_id="123",
+                    all_users_direct_suborgs_group_id="123",
+                    auto_created_users_group_id="123",
+                    external_id="123",
+                    organisation="some name",
+                    issuer="app1",
+                    issuer_id="123",
+                    subdomain="app1.example.com",
+                    name_slug=K8sSlug("81c2v7s6djuy1zmetozkhdomha1bae37b8ocvx8o53ow2eg7p6qw9qklp6l4y010fogx"),
+                    contact_id="123",
+                    parent_id="123",
+                    root_org_id="aB29sdkD3jlaAbl7",
+                    auto_create=False,
+                    trust_on_first_use_duration=86400,
+                    feature_flags=[
+                        FeatureFlag(
+                            feature="saml_auth",
+                            enabled=True,
+                            setting="stable",
+                        ),
+                    ],
+                    admin_state=OrganisationStateSelector("active"),
+                    status=OrganisationStatus(
+                        all_up=True,
+                        admin_up=True,
+                        issuer_up=True,
+                        current_state=OrganisationStateStatus("active"),
+                        capabilities=OrganisationCapabilities(
+                            features=[
+                                FeatureTagName("north-america"),
+                            ],
+                        ),
+                    ),
+                    billing_account_id="123",
+                    billing_subscription_id="123",
+                    shard="A",
+                    cluster="ca-1",
+                    configured_capabilities=OrganisationCapabilities(
+                        features=[
+                            FeatureTagName("north-america"),
+                        ],
+                    ),
+                    owner_config=OrganisationOwnerConfig(
+                        disable_user_requests=False,
+                    ),
+                    product_label_override="123",
+                    system_options=OrganisationSystemOptions(
+                        new_subscription_feature_overrides=[
+                            "123",
+                        ],
+                        allowed_domains=[
+                            "app1.subdomain.com",
+                        ],
+                    ),
+                    ruleset_bundle_id="123",
+                ),
+            ],
+            subscription=BillingSubscription(
+                id="id_example",
+            ),
+            balance=BillingOrgSubscriptionBalance(
+                upcoming_invoice={},
+                subscription_balance=1,
+                estimate_balance_end_date=dateutil_parser('1970-01-01T00:00:00.00Z'),
+            ),
+            feature_overrides=[
+                Feature(
+                    metadata=MetadataWithId(),
+                    spec=FeatureSpec(
+                        name="name_example",
+                        description="description_example",
+                        priority=1,
+                        key="e",
+                        value=FeatureValue(
+                            enabled=True,
+                            min=1,
+                            max=1,
+                        ),
+                    ),
+                    status=FeatureStatus(
+                        products=[
+                            Product(
+                                metadata=MetadataWithId(),
+                                spec=ProductSpec(
+                                    name="name_example",
+                                    description="description_example",
+                                    dev_mode=True,
+                                    label="123",
+                                    billing_product_prices=[
+                                        BillingProductPrice(
+                                            id="id_example",
+                                        ),
+                                    ],
+                                    trial_period=25,
+                                    features=[
+                                        "123",
+                                    ],
+                                ),
+                                status=ProductStatus(
+                                    billing_product_prices=[
+                                        BillingProductPrice(
+                                            id="id_example",
+                                        ),
+                                    ],
+                                    features=[
+                                        Feature(),
+                                    ],
+                                ),
+                            ),
+                        ],
+                    ),
+                ),
+            ],
+            usage_metrics=UsageMetrics(
+                metrics=[
+                    UsageMetric(
+                        type="application",
+                        org_id="IAsl3dl40aSsfLKiU76",
+                        org_ids=[
+                            "123",
+                        ],
+                        provisioned=UsageMeasurement(
+                            peak=0,
+                            current=0,
+                        ),
+                        active=UsageMeasurement(
+                            peak=0,
+                            current=0,
+                        ),
+                    ),
+                ],
+            ),
+            products=[
+                BillingProduct(
+                    id="id_example",
+                    name="name_example",
+                ),
+            ],
+            product=Product(
+                metadata=MetadataWithId(),
+                spec=ProductSpec(
+                    name="name_example",
+                    description="description_example",
+                    dev_mode=True,
+                    label="123",
+                    billing_product_prices=[
+                        BillingProductPrice(
+                            id="id_example",
+                        ),
+                    ],
+                    trial_period=25,
+                    features=[
+                        "123",
+                    ],
+                ),
+                status=ProductStatus(
+                    billing_product_prices=[
+                        BillingProductPrice(
+                            id="id_example",
+                        ),
+                    ],
+                    features=[
+                        Feature(
+                            metadata=MetadataWithId(),
+                            spec=FeatureSpec(
+                                name="name_example",
+                                description="description_example",
+                                priority=1,
+                                key="e",
+                                value=FeatureValue(
+                                    enabled=True,
+                                    min=1,
+                                    max=1,
+                                ),
+                            ),
+                            status=FeatureStatus(
+                                products=[
+                                    Product(),
+                                ],
+                            ),
+                        ),
+                    ],
+                ),
+            ),
+            provider_status=BillingProviderSubscriptionStatus(
+                product_subscription_match=True,
+                subscription_missing_prices=[
+                    BillingProductPrice(
+                        id="id_example",
+                    ),
+                ],
+                subscription_additional_prices=[
+                    BillingProductPrice(
+                        id="id_example",
+                    ),
+                ],
+            ),
+        ),
+    ) # BillingOrgSubscription |  (optional)
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Update the subscription cancellation detail
+        api_response = api_instance.update_subscription_cancellation(billing_subscription_id)
+        pprint(api_response)
+    except agilicus_api.ApiException as e:
+        print("Exception when calling BillingApi->update_subscription_cancellation: %s\n" % e)
+
+    # example passing only required values which don't have defaults set
+    # and optional values
+    try:
+        # Update the subscription cancellation detail
+        api_response = api_instance.update_subscription_cancellation(billing_subscription_id, billing_org_subscription=billing_org_subscription)
+        pprint(api_response)
+    except agilicus_api.ApiException as e:
+        print("Exception when calling BillingApi->update_subscription_cancellation: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **billing_subscription_id** | **str**| Billing subscription Unique identifier |
+ **billing_org_subscription** | [**BillingOrgSubscription**](BillingOrgSubscription.md)|  | [optional]
+
+### Return type
+
+[**BillingOrgSubscription**](BillingOrgSubscription.md)
+
+### Authorization
+
+[token-valid](../README.md#token-valid)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | subscription cancel_detail updated |  -  |
+**404** | subscription does not exist |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+