Skip to content

BillingSubscriptionsApi.md

Latest commit

 

History

History
223 lines (145 loc) · 6.83 KB

BillingSubscriptionsApi.md

File metadata and controls

223 lines (145 loc) · 6.83 KB

hostinger_api.BillingSubscriptionsApi

All URIs are relative to https://developers.hostinger.com

Method HTTP request Description
disable_auto_renewal_v1 DELETE /api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/disable Disable auto-renewal
enable_auto_renewal_v1 PATCH /api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/enable Enable auto-renewal
get_subscription_list_v1 GET /api/billing/v1/subscriptions Get subscription list

disable_auto_renewal_v1

BillingV1SubscriptionSubscriptionResource disable_auto_renewal_v1(subscription_id)

Disable auto-renewal

Disable auto-renewal for a subscription.

Use this endpoint when disable auto-renewal for a subscription.

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.billing_v1_subscription_subscription_resource import BillingV1SubscriptionSubscriptionResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.BillingSubscriptionsApi(api_client)
    subscription_id = 'Cxy353Uhl1xC54pG6' # str | Subscription ID

    try:
        # Disable auto-renewal
        api_response = api_instance.disable_auto_renewal_v1(subscription_id)
        print("The response of BillingSubscriptionsApi->disable_auto_renewal_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BillingSubscriptionsApi->disable_auto_renewal_v1: %s\n" % e)

Parameters

Name Type Description Notes
subscription_id str Subscription ID

Return type

BillingV1SubscriptionSubscriptionResource

Authorization

apiToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success response -
401 Unauthenticated response -
500 Error response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enable_auto_renewal_v1

BillingV1SubscriptionSubscriptionResource enable_auto_renewal_v1(subscription_id)

Enable auto-renewal

Enable auto-renewal for a subscription.

Use this endpoint when enable auto-renewal for a subscription.

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.billing_v1_subscription_subscription_resource import BillingV1SubscriptionSubscriptionResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.BillingSubscriptionsApi(api_client)
    subscription_id = 'Cxy353Uhl1xC54pG6' # str | Subscription ID

    try:
        # Enable auto-renewal
        api_response = api_instance.enable_auto_renewal_v1(subscription_id)
        print("The response of BillingSubscriptionsApi->enable_auto_renewal_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BillingSubscriptionsApi->enable_auto_renewal_v1: %s\n" % e)

Parameters

Name Type Description Notes
subscription_id str Subscription ID

Return type

BillingV1SubscriptionSubscriptionResource

Authorization

apiToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success response -
401 Unauthenticated response -
500 Error response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_subscription_list_v1

List[BillingV1SubscriptionSubscriptionResource] get_subscription_list_v1()

Get subscription list

Retrieve a list of all subscriptions associated with your account.

Use this endpoint to monitor active services and billing status.

Example

  • Bearer Authentication (apiToken):
import hostinger_api
from hostinger_api.models.billing_v1_subscription_subscription_resource import BillingV1SubscriptionSubscriptionResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.BillingSubscriptionsApi(api_client)

    try:
        # Get subscription list
        api_response = api_instance.get_subscription_list_v1()
        print("The response of BillingSubscriptionsApi->get_subscription_list_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BillingSubscriptionsApi->get_subscription_list_v1: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[BillingV1SubscriptionSubscriptionResource]

Authorization

apiToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success response -
401 Unauthenticated response -
500 Error response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]