Skip to content

Commit 7e84ace

Browse files
committed
chore: SDK update
1 parent 9dc2fc7 commit 7e84ace

9 files changed

+575
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ Class | Method | HTTP request | Description
127127
*BillingPaymentMethodsApi* | [**delete_payment_method_v1**](docs/BillingPaymentMethodsApi.md#delete_payment_method_v1) | **DELETE** /api/billing/v1/payment-methods/{paymentMethodId} | Delete payment method
128128
*BillingPaymentMethodsApi* | [**get_payment_method_list_v1**](docs/BillingPaymentMethodsApi.md#get_payment_method_list_v1) | **GET** /api/billing/v1/payment-methods | Get payment method list
129129
*BillingPaymentMethodsApi* | [**set_default_payment_method_v1**](docs/BillingPaymentMethodsApi.md#set_default_payment_method_v1) | **POST** /api/billing/v1/payment-methods/{paymentMethodId} | Set default payment method
130+
*BillingSubscriptionsApi* | [**cancel_subscription_v1**](docs/BillingSubscriptionsApi.md#cancel_subscription_v1) | **DELETE** /api/billing/v1/subscriptions/{subscriptionId} | Cancel subscription
130131
*BillingSubscriptionsApi* | [**get_subscription_list_v1**](docs/BillingSubscriptionsApi.md#get_subscription_list_v1) | **GET** /api/billing/v1/subscriptions | Get subscription list
131132
*DomainsPortfolioApi* | [**get_domain_list_v1**](docs/DomainsPortfolioApi.md#get_domain_list_v1) | **GET** /api/domains/v1/portfolio | Get domain list
132133
*VPSActionsApi* | [**get_action_list_v1**](docs/VPSActionsApi.md#get_action_list_v1) | **GET** /api/vps/v1/virtual-machines/{virtualMachineId}/actions | Get action list
@@ -191,6 +192,7 @@ Class | Method | HTTP request | Description
191192
- [BillingV1OrderStoreRequest](docs/BillingV1OrderStoreRequest.md)
192193
- [BillingV1OrderStoreRequestItemsInner](docs/BillingV1OrderStoreRequestItemsInner.md)
193194
- [BillingV1PaymentMethodPaymentMethodResource](docs/BillingV1PaymentMethodPaymentMethodResource.md)
195+
- [BillingV1SubscriptionCancelRequest](docs/BillingV1SubscriptionCancelRequest.md)
194196
- [BillingV1SubscriptionSubscriptionResource](docs/BillingV1SubscriptionSubscriptionResource.md)
195197
- [CommonSchemaErrorResponseSchema](docs/CommonSchemaErrorResponseSchema.md)
196198
- [CommonSchemaUnauthorizedResponseSchema](docs/CommonSchemaUnauthorizedResponseSchema.md)

docs/BillingSubscriptionsApi.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,94 @@ All URIs are relative to *https://developers.hostinger.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7+
[**cancel_subscription_v1**](BillingSubscriptionsApi.md#cancel_subscription_v1) | **DELETE** /api/billing/v1/subscriptions/{subscriptionId} | Cancel subscription
78
[**get_subscription_list_v1**](BillingSubscriptionsApi.md#get_subscription_list_v1) | **GET** /api/billing/v1/subscriptions | Get subscription list
89

910

11+
# **cancel_subscription_v1**
12+
> CommonSuccessEmptyResource cancel_subscription_v1(subscription_id, billing_v1_subscription_cancel_request)
13+
14+
Cancel subscription
15+
16+
This endpoint cancels a subscription and stops any further billing.
17+
18+
### Example
19+
20+
* Bearer Authentication (apiToken):
21+
22+
```python
23+
import hostinger_api
24+
from hostinger_api.models.billing_v1_subscription_cancel_request import BillingV1SubscriptionCancelRequest
25+
from hostinger_api.models.common_success_empty_resource import CommonSuccessEmptyResource
26+
from hostinger_api.rest import ApiException
27+
from pprint import pprint
28+
29+
# Defining the host is optional and defaults to https://developers.hostinger.com
30+
# See configuration.py for a list of all supported configuration parameters.
31+
configuration = hostinger_api.Configuration(
32+
host = "https://developers.hostinger.com"
33+
)
34+
35+
# The client must configure the authentication and authorization parameters
36+
# in accordance with the API server security policy.
37+
# Examples for each auth method are provided below, use the example that
38+
# satisfies your auth use case.
39+
40+
# Configure Bearer authorization: apiToken
41+
configuration = hostinger_api.Configuration(
42+
access_token = os.environ["BEARER_TOKEN"]
43+
)
44+
45+
# Enter a context with an instance of the API client
46+
with hostinger_api.ApiClient(configuration) as api_client:
47+
# Create an instance of the API class
48+
api_instance = hostinger_api.BillingSubscriptionsApi(api_client)
49+
subscription_id = 'Cxy353Uhl1xC54pG6' # str | Subscription ID
50+
billing_v1_subscription_cancel_request = hostinger_api.BillingV1SubscriptionCancelRequest() # BillingV1SubscriptionCancelRequest |
51+
52+
try:
53+
# Cancel subscription
54+
api_response = api_instance.cancel_subscription_v1(subscription_id, billing_v1_subscription_cancel_request)
55+
print("The response of BillingSubscriptionsApi->cancel_subscription_v1:\n")
56+
pprint(api_response)
57+
except Exception as e:
58+
print("Exception when calling BillingSubscriptionsApi->cancel_subscription_v1: %s\n" % e)
59+
```
60+
61+
62+
63+
### Parameters
64+
65+
66+
Name | Type | Description | Notes
67+
------------- | ------------- | ------------- | -------------
68+
**subscription_id** | **str**| Subscription ID |
69+
**billing_v1_subscription_cancel_request** | [**BillingV1SubscriptionCancelRequest**](BillingV1SubscriptionCancelRequest.md)| |
70+
71+
### Return type
72+
73+
[**CommonSuccessEmptyResource**](CommonSuccessEmptyResource.md)
74+
75+
### Authorization
76+
77+
[apiToken](../README.md#apiToken)
78+
79+
### HTTP request headers
80+
81+
- **Content-Type**: application/json
82+
- **Accept**: application/json
83+
84+
### HTTP response details
85+
86+
| Status code | Description | Response headers |
87+
|-------------|-------------|------------------|
88+
**200** | Success empty response | - |
89+
**422** | Validation error response | - |
90+
**401** | Unauthenticated | - |
91+
**500** | Error response | - |
92+
93+
[[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)
94+
1095
# **get_subscription_list_v1**
1196
> List[BillingV1SubscriptionSubscriptionResource] get_subscription_list_v1()
1297
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# BillingV1SubscriptionCancelRequest
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**reason_code** | **str** | Cancellation reason code | [optional]
9+
**cancel_option** | **str** | Cancellation option | [optional]
10+
11+
## Example
12+
13+
```python
14+
from hostinger_api.models.billing_v1_subscription_cancel_request import BillingV1SubscriptionCancelRequest
15+
16+
# TODO update the JSON string below
17+
json = "{}"
18+
# create an instance of BillingV1SubscriptionCancelRequest from a JSON string
19+
billing_v1_subscription_cancel_request_instance = BillingV1SubscriptionCancelRequest.from_json(json)
20+
# print the JSON string representation of the object
21+
print(BillingV1SubscriptionCancelRequest.to_json())
22+
23+
# convert the object into a dict
24+
billing_v1_subscription_cancel_request_dict = billing_v1_subscription_cancel_request_instance.to_dict()
25+
# create an instance of BillingV1SubscriptionCancelRequest from a dict
26+
billing_v1_subscription_cancel_request_from_dict = BillingV1SubscriptionCancelRequest.from_dict(billing_v1_subscription_cancel_request_dict)
27+
```
28+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
29+
30+

hostinger_api/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
from hostinger_api.models.billing_v1_order_store_request import BillingV1OrderStoreRequest
5353
from hostinger_api.models.billing_v1_order_store_request_items_inner import BillingV1OrderStoreRequestItemsInner
5454
from hostinger_api.models.billing_v1_payment_method_payment_method_resource import BillingV1PaymentMethodPaymentMethodResource
55+
from hostinger_api.models.billing_v1_subscription_cancel_request import BillingV1SubscriptionCancelRequest
5556
from hostinger_api.models.billing_v1_subscription_subscription_resource import BillingV1SubscriptionSubscriptionResource
5657
from hostinger_api.models.common_schema_error_response_schema import CommonSchemaErrorResponseSchema
5758
from hostinger_api.models.common_schema_unauthorized_response_schema import CommonSchemaUnauthorizedResponseSchema

0 commit comments

Comments
 (0)