Skip to content

Latest commit

 

History

History
224 lines (152 loc) · 7.29 KB

AdditionalCostApi.md

File metadata and controls

224 lines (152 loc) · 7.29 KB
Raw

Reepay\AdditionalCostApi

All URIs are relative to https://api.reepay.com

Method HTTP request Description
cancelAdditionalCost POST /v1/additional_cost/{handle}/cancel Cancel pending additional cost
createAdditionalCostJson POST /v1/additional_cost Create additional cost
getAdditionalCost GET /v1/additional_cost/{handle} Get additional cost
getAdditionalCosts GET /v1/additional_cost/subscription/{handle} Get additional costs for subscription

cancelAdditionalCost

\Reepay\Model\AdditionalCost cancelAdditionalCost($handle)

Cancel pending additional cost

Example

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

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AdditionalCostApi();
$handle = "handle_example"; // string | Additonal cost handle

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

Parameters

Name Type Description Notes
handle string Additonal cost handle

Return type

\Reepay\Model\AdditionalCost

Authorization

apiKey, basicAuth

HTTP request headers

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

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

createAdditionalCostJson

\Reepay\Model\AdditionalCost createAdditionalCostJson($body)

Create additional cost

Example

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

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AdditionalCostApi();
$body = new \Reepay\Model\CreateAdditionalCost(); // \Reepay\Model\CreateAdditionalCost |

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

Parameters

Name Type Description Notes
body \Reepay\Model\CreateAdditionalCost [optional]

Return type

\Reepay\Model\AdditionalCost

Authorization

apiKey, basicAuth

HTTP request headers

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

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

getAdditionalCost

\Reepay\Model\AdditionalCost getAdditionalCost($handle)

Get additional cost

Example

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

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AdditionalCostApi();
$handle = "handle_example"; // string | Additonal cost handle

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

Parameters

Name Type Description Notes
handle string Additonal cost handle

Return type

\Reepay\Model\AdditionalCost

Authorization

apiKey, basicAuth

HTTP request headers

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

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

getAdditionalCosts

\Reepay\Model\AdditionalCost[] getAdditionalCosts($handle)

Get additional costs for subscription

Example

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

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AdditionalCostApi();
$handle = "handle_example"; // string | Subscription handle

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

Parameters

Name Type Description Notes
handle string Subscription handle

Return type

\Reepay\Model\AdditionalCost[]

Authorization

apiKey, basicAuth

HTTP request headers

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

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