BillingSubscriptionsApi.md

Hostinger\BillingSubscriptionsApi

All URIs are relative to https://developers.hostinger.com, except if the operation defines another base path.

Method	HTTP request	Description
cancelSubscriptionV1()	DELETE /api/billing/v1/subscriptions/{subscriptionId}	Cancel subscription
getSubscriptionListV1()	GET /api/billing/v1/subscriptions	Get subscription list

cancelSubscriptionV1()

cancelSubscriptionV1($subscriptionId, $billingV1SubscriptionCancelRequest): \Hostinger\Model\CommonSuccessEmptyResource

Cancel subscription

This endpoint cancels a subscription and stops any further billing.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\BillingSubscriptionsApi(config: $config);
$subscriptionId = Cxy353Uhl1xC54pG6; // string | Subscription ID
$billingV1SubscriptionCancelRequest = new \Hostinger\Model\BillingV1SubscriptionCancelRequest(); // \Hostinger\Model\BillingV1SubscriptionCancelRequest

try {
    $result = $apiInstance->cancelSubscriptionV1($subscriptionId, $billingV1SubscriptionCancelRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BillingSubscriptionsApi->cancelSubscriptionV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subscriptionId	string	Subscription ID
billingV1SubscriptionCancelRequest	\Hostinger\Model\BillingV1SubscriptionCancelRequest

Return type

\Hostinger\Model\CommonSuccessEmptyResource

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

getSubscriptionListV1()

getSubscriptionListV1(): \Hostinger\Model\BillingV1SubscriptionSubscriptionResource[]

Get subscription list

This endpoint retrieves a list of all subscriptions associated with your account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\BillingSubscriptionsApi(config: $config);

try {
    $result = $apiInstance->getSubscriptionListV1();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BillingSubscriptionsApi->getSubscriptionListV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\Hostinger\Model\BillingV1SubscriptionSubscriptionResource[]

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