/api/v1/on-boarding/subscriptions
Requires authentication
Rate limited by the `api-global` limiter
v1
Send a bearer token, plus the X-Client-Id and X-Client-Secret headers in the Authorization header.
Kthen abonimet që kompania ka ende në fuqi ose të rezervuara për më vonë: abonimin kryesor
dhe abonimet e njësive që faturohen më vete, nga më i riu. Me endDate dini kur duhet
rinovuar.
Abonimet e anuluara dhe ato që kanë mbaruar nuk kthehen.
URL-ja e plotë: https://fature.al/api/v1/on-boarding/subscriptions
Përgjigjet
200 OK
| Field | Tipi | Përshkrimi |
|---|---|---|
| status | boolean | |
| data | object | |
| data.subscriptions | array | |
| data.subscriptions[].id | integer | Id-ja e abonimit |
| data.subscriptions[].type | string | `main` për abonimin kryesor të kompanisë, `unit` për abonimin e një njësie që faturohet më vete |
| data.subscriptions[].package | string, nullable | Paketa: `cash`, `noncash` ose `full`; `null` kur abonimi nuk ka asnjë lloj fature |
| data.subscriptions[].startDate | string | Data kur nis abonimi, `YYYY-MM-DD` |
| data.subscriptions[].endDate | string | Data kur mbaron, `YYYY-MM-DD`. Abonimi i një njësie mbaron bashkë me abonimin kryesor, që kompania të rinovohet e gjitha bashkë |
| data.subscriptions[].paid | boolean | A është konfirmuar abonimi. Ato që rezervoni me API konfirmohen menjëherë |
| data.subscriptions[].branchIds | array | Njësitë që faturon abonimi i një njësie; bosh për abonimin kryesor, që faturon të gjitha njësitë e tjera |
401 Unauthenticated
| Field | Tipi | Përshkrimi |
|---|---|---|
| message | string |
403 Llogaria nuk është ofruesi i software-it që e regjistroi kompaninë.
| Field | Tipi | Përshkrimi |
|---|---|---|
| status | boolean | Gjithmonë false. Një përgjigje e suksesshme mban `status: true` dhe objektin `data` |
| message | string | Përshkrimi i gabimit. Bosh kur dështimi nuk mban ndonjë mesazh të vetin |
| errors | array | Mesazhe për t'u shfaqur te përdoruesi ose për t'u ruajtur në log. Mungon kur nuk ka gjë për të shtuar përtej `message` |
Shembull kërkese
curl -X GET 'https://fature.al/api/v1/on-boarding/subscriptions' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'X-Client-Id: YOUR_CLIENT_ID' \
-H 'X-Client-Secret: YOUR_CLIENT_SECRET' \
-H 'Accept: application/json'
use Illuminate\Support\Facades\Http;
$response = Http::withHeaders([
'Authorization' => 'Bearer YOUR_TOKEN',
'X-Client-Id' => 'YOUR_CLIENT_ID',
'X-Client-Secret' => 'YOUR_CLIENT_SECRET',
'Accept' => 'application/json',
])->get('https://fature.al/api/v1/on-boarding/subscriptions');
$data = $response->json();
use GuzzleHttp\Client;
$client = new Client();
$response = $client->request('GET', 'https://fature.al/api/v1/on-boarding/subscriptions', [
'headers' => [
'Authorization' => 'Bearer YOUR_TOKEN',
'X-Client-Id' => 'YOUR_CLIENT_ID',
'X-Client-Secret' => 'YOUR_CLIENT_SECRET',
'Accept' => 'application/json',
],
]);
$data = json_decode((string) $response->getBody(), true);
const response = await fetch('https://fature.al/api/v1/on-boarding/subscriptions', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_TOKEN',
'X-Client-Id': 'YOUR_CLIENT_ID',
'X-Client-Secret': 'YOUR_CLIENT_SECRET',
'Accept': 'application/json'
}
});
const data = await response.json();
Shembull përgjigjeje
{
"status": true,
"data": {
"subscriptions": [
{
"id": 5021,
"type": "unit",
"package": "cash",
"startDate": "2026-11-16",
"endDate": "2027-03-01",
"paid": true,
"branchIds": [
13
]
}
]
}
}
{
"message": "Unauthenticated."
}
{
"status": false,
"message": "Te dhenat jo te sakta.",
"errors": [
"errors"
]
}