Delete usage
Last updated: 15-Mar-2021
Rate this article:
Overview
Use the deleteSubscriptionUsages method via SOAP API 6.0 to delete one or more usage entries based on the provided criteria.
Request Parameters
| Parameters | Type | Required | Description |
|---|---|---|---|
| merchantCode | String | Required | The system-generated merchant ID. |
| sessionID | String | Required | The system-generated code of the session. |
| hash | String | Required | The MD5 hmac key for the request. |
| SubscriptionReference | String | Required | The system-generated reference code of the subscription. |
| UsageReference | Number | Optional | The system-generated code for usage. |
| OptionCode | String | Optional | Unique 2Checkout option code. |
| IntervalStart | Number | Optional (mandatory if IntervalEnd is provided) | Deletes all usages where UsageEnd >= IntervalStart. Format "YYYY-MM-DD". The timezone used is the one on the server. |
| IntervalEnd | Number | Optional (mandatory if IntervalStart is provided) | Deletes all usages where UsageEnd <= IntervalEnd. Format "YYYY-MM-DD". The timezone used is the one on the server. |
Request Sample
<?php
require ('PATH_TO_AUTH'); // authentication call
$subscriptionReferencee = '4A1D733696';
$usageReference = 120010776516;
try {
$subscriptionUsageRequest = new stdClass();
$subscriptionUsageRequest->UsageReference = $usageReference;
$subscriptionUsageRequest->OptionCode = 'Units 123';
$subscriptionUsageRequest->IntervalStart = '2020-04-09 16:40:00';
$subscriptionUsageRequest->IntervalEnd = '2020-04-12 15:40:00';
$response = $client->deleteSubscriptionUsages($sessionID, $subscriptionReference, $subscriptionUsageRequest);
var_dump($response);
} catch (SoapFault $ex) {
$faultname = (isset($ex->faultname)) ? " $faultname" : '';
echo "[$ex->faultcode]$faultname: $ex->faultstring" . PHP_EOL;
}
exit;
Response
The deleteSubscriptionUsages method via SOAP APIv6 returns NULL when successful.
NULL
Error Handling
The deleteSubscriptionUsages via SOAP APIv6 returns FALSE if:
| Error message code | Error code | Error message description |
|---|---|---|
|
Provided parameters lack the required type or format. |
MALFORMED_PARAMETER | One or more parameters lack the required format: SubscriptionReference must be a string. |
| MALFORMED_PARAMETER | One or more parameters lack the required format: UsageReference must be a positive integer higher than or equal to 1. | |
| MALFORMED_PARAMETER | One or more parameters lack the required format: Units must be a positive integer higher than or equal to 1. | |
| MALFORMED_PARAMETER | One or more parameters lack the required format: IntervalStart must be a string. | |
| MALFORMED_PARAMETER | One or more parameters lack the required format: IntervalEnd must be a string. | |
|
The subscription or usage line are not found. |
NOT_FOUND | Subscription not found. |
| NOT_FOUND | Usage line described does not exist. | |
| The usage line is already billed. | ALREADY_BILLED | Usage was not deleted as this usage was already billed. |
| The renewal process is in progress for this subscription. | RENEWAL_IN_PROGRESS | There is a renewal in progress for the provided usage line. |
| An unexpected error happens. | GENERIC | There has been an error deleting the usage line. Please try again later. |
Rate this article:
