Get lead tariff options. How many leads did you unlock this month?

GET/customers/{customerId}/lead-fyndr-profile/tariff/

API version

v2

Request method

GET

Operation ID

leadfyndr-get-lead-fyndr-profile-tariff-options

---

Request

• customerIdstring

  required

Responses

Format

application/json

Description

The lead tariff options.

Schema documentation

• nextUnlockRenewalDatestring (date)
• reservationobject

  required
  • availablenumber (≥ 0)

    required
  • tariffLimitnumber (≥ 0)

    required
  • usednumber (≥ 0)

    required
• unlockedobject

  required
  • availablenumber (≥ 0)

    required
  • tariffLimitnumber (≥ 0)

    required
  • usednumber (≥ 0)

    required

Example

Content-Type: application/json

{
  "nextUnlockRenewalDate": "string",
  "reservation": {
    "available": 123,
    "tariffLimit": 123,
    "used": 123
  },
  "unlocked": {
    "available": 123,
    "tariffLimit": 123,
    "used": 123
  }
}

JSON Schema

{
  "properties": {
    "nextUnlockRenewalDate": {
      "format": "date",
      "type": "string"
    },
    "reservation": {
      "properties": {
        "available": {
          "minimum": 0,
          "type": "number"
        },
        "tariffLimit": {
          "minimum": 0,
          "type": "number"
        },
        "used": {
          "minimum": 0,
          "type": "number"
        }
      },
      "required": [
        "used",
        "available",
        "tariffLimit"
      ],
      "type": "object"
    },
    "unlocked": {
      "properties": {
        "available": {
          "minimum": 0,
          "type": "number"
        },
        "tariffLimit": {
          "minimum": 0,
          "type": "number"
        },
        "used": {
          "minimum": 0,
          "type": "number"
        }
      },
      "required": [
        "used",
        "available",
        "tariffLimit"
      ],
      "type": "object"
    }
  },
  "required": [
    "unlocked",
    "reservation"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/customers/string/lead-fyndr-profile/tariff

JavaScript SDK

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.leadFyndr.getLeadFyndrProfileTariffOptions({
  "customerId": "string"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\LeadFyndr\GetLeadFyndrProfileTariffOptions\GetLeadFyndrProfileTariffOptionsRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetLeadFyndrProfileTariffOptionsRequest(
  customerId: "string"
));
$response = $client->leadFyndr()->getLeadFyndrProfileTariffOptions($request);

var_dump($response->getBody();