Skip to main content

Check if an Extension is unchargable for this specific context or if it must be charged

GET/v2/extensions/{extensionId}/contexts/{contextId}/chargability
API version
v2
Request method
GET
Operation ID
extension-check-extension-is-chargable

Request​

  • extensionIdstring (uuid)required
  • contextIdstringrequired

Responses​

Format
application/json
Description

The calculated chargeability of an extension instance to be created.

  • chargeabilityobjectrequired
    • isChargeablebooleanrequired
    • reasonsobjectrequired
      • isNonChargeableCustomerbooleanrequired
      • isOwnExtensionbooleanrequired
Content-Type: application/json

{
  "chargeability": {
    "isChargeable": true,
    "reasons": {
      "isNonChargeableCustomer": true,
      "isOwnExtension": true
    }
  }
}
{
  "properties": {
    "chargeability": {
      "properties": {
        "isChargeable": {
          "default": false,
          "type": "boolean"
        },
        "reasons": {
          "properties": {
            "isNonChargeableCustomer": {
              "type": "boolean"
            },
            "isOwnExtension": {
              "type": "boolean"
            }
          },
          "required": [
            "isOwnExtension",
            "isNonChargeableCustomer"
          ],
          "type": "object"
        }
      },
      "required": [
        "isChargeable",
        "reasons"
      ],
      "type": "object"
    }
  },
  "required": [
    "chargeability"
  ],
  "type": "object"
}

Usage examples​

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/extensions/f0f86186-0a5a-45b2-aa33-502777496347/contexts/string/chargability?variantKey=string
import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.marketplace.extensionCheckExtensionIsChargable({
  "extensionId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "contextId": "string",
  "queryParameters": {
    "variantKey": "string"
  }
});

assertStatus(response, 200);
  
use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionCheckExtensionIsChargable\ExtensionCheckExtensionIsChargableRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ExtensionCheckExtensionIsChargableRequest(
  extensionId: "f0f86186-0a5a-45b2-aa33-502777496347",
  contextId: "string"
))
  ->withVariantKey("string");
$response = $client->marketplace()->extensionCheckExtensionIsChargable($request);

var_dump($response->getBody();

On this page