curl --request POST \
--url https://api.paywithlocus.com/api/wrapped/credits/{provider}/{endpoint} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '{}'import requests
url = "https://api.paywithlocus.com/api/wrapped/credits/{provider}/{endpoint}"
payload = {}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
};
fetch('https://api.paywithlocus.com/api/wrapped/credits/{provider}/{endpoint}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paywithlocus.com/api/wrapped/credits/{provider}/{endpoint}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.paywithlocus.com/api/wrapped/credits/{provider}/{endpoint}"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.paywithlocus.com/api/wrapped/credits/{provider}/{endpoint}")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywithlocus.com/api/wrapped/credits/{provider}/{endpoint}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"success": false,
"error": "Upstream API call failed",
"code": "upstream_validation_error",
"upstreamStatus": 400,
"apiCallId": "<string>",
"validation": {
"type": "<string>",
"code": "<string>",
"param": "<string>",
"message": "<string>"
}
}{
"error": "Insufficient credits",
"message": "<string>",
"requiredCredits": "<string>",
"availableCredits": "<string>",
"docsUrl": "<string>"
}{
"error": "Workspace monthly spend limit reached",
"code": "TENANT_MONTHLY_SPEND_LIMIT_EXCEEDED",
"message": "<string>",
"limitUsd": "<string>",
"committedUsd": "<string>",
"requestedUsd": "<string>",
"resetsAt": "2023-11-07T05:31:56Z",
"apiCallId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"success": false
}{
"success": false,
"error": "Upstream API call failed",
"code": "upstream_validation_error",
"upstreamStatus": 400,
"apiCallId": "<string>",
"validation": {
"type": "<string>",
"code": "<string>",
"param": "<string>",
"message": "<string>"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Metered pay-per-use call
The response body is the RAW upstream response (byte-compatible with the provider SDK shape). Cost rides in response headers. X-Locus-End-User present (or an end-user token) charges that user’s account at your effective price; a secret-key call without it charges your platform account at base price with zero markup.
curl --request POST \
--url https://api.paywithlocus.com/api/wrapped/credits/{provider}/{endpoint} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '{}'import requests
url = "https://api.paywithlocus.com/api/wrapped/credits/{provider}/{endpoint}"
payload = {}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
};
fetch('https://api.paywithlocus.com/api/wrapped/credits/{provider}/{endpoint}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paywithlocus.com/api/wrapped/credits/{provider}/{endpoint}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.paywithlocus.com/api/wrapped/credits/{provider}/{endpoint}"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.paywithlocus.com/api/wrapped/credits/{provider}/{endpoint}")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywithlocus.com/api/wrapped/credits/{provider}/{endpoint}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"success": false,
"error": "Upstream API call failed",
"code": "upstream_validation_error",
"upstreamStatus": 400,
"apiCallId": "<string>",
"validation": {
"type": "<string>",
"code": "<string>",
"param": "<string>",
"message": "<string>"
}
}{
"error": "Insufficient credits",
"message": "<string>",
"requiredCredits": "<string>",
"availableCredits": "<string>",
"docsUrl": "<string>"
}{
"error": "Workspace monthly spend limit reached",
"code": "TENANT_MONTHLY_SPEND_LIMIT_EXCEEDED",
"message": "<string>",
"limitUsd": "<string>",
"committedUsd": "<string>",
"requestedUsd": "<string>",
"resetsAt": "2023-11-07T05:31:56Z",
"apiCallId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"success": false
}{
"success": false,
"error": "Upstream API call failed",
"code": "upstream_validation_error",
"upstreamStatus": 400,
"apiCallId": "<string>",
"validation": {
"type": "<string>",
"code": "<string>",
"param": "<string>",
"message": "<string>"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Tenant secret key (lcr_…). Server-side only.
Headers
Required only when the end-user JWT carries sid. Send the original high-entropy session value; sid is its SHA-256 fingerprint. Ignored for secret-key authentication.
16 - 128^[A-Za-z0-9][A-Za-z0-9._:-]{15,127}$Required. Missing → 400. Same key + different body → 409. Retries replay the stored outcome.
Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.
1 - 200^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$Body
Upstream-shaped request body (see the per-endpoint docs at /credits/md)
Response
Raw upstream response