/api/v1/on-boarding/subscription
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.
Rezervon një abonim për kompaninë jashtë krijimit të një njësie: rinovimin e abonimit
kryesor, ose abonimin më vete të një njësie që ekziston tashmë. Abonimi konfirmohet
menjëherë, si ai që krijon POST /register.
Pa branchId rinovohet abonimi kryesor:
- Nis ditën kur mbaron abonimi aktual dhe zgjat një vit. Kur nuk ka abonim aktiv, nis sot.
- Pa
packagembeten modulet dhe çmimi i abonimit të mëparshëm. Mepackagendryshojnë llojet e faturave dhe çmimi llogaritet nga e para; modulet shtesë mbeten. - Abonimet e njësive që faturohen më vete rinovohen bashkë me të, me paketën që kishin.
- Kur rinovimi është rezervuar tashmë dhe ende nuk ka nisur, kërkesa refuzohet me
409.
Me branchId njësia faturohet më vete me package, që sot deri në mbarimin e abonimit
kryesor aktiv, dhe nuk zë më vend në kufirin e njësive. Selia qendrore, një njësi që ka
tashmë abonimin e vet në këtë periudhë, ose një kompani pa abonim kryesor aktiv refuzohen
me 403.
Vetëm ofruesi i software-it që e regjistroi kompaninë mund të rezervojë abonime.
URL-ja e plotë: https://fature.al/api/v1/on-boarding/subscription
Body parameters
| Name | Tipi | E detyrueshme | Përshkrimi |
|---|---|---|---|
| package | string, nullable | yes | Paketa: `cash`, `noncash` ose `full`. Për abonimin kryesor është opsionale: pa të rinovohet paketa e mëparshme me të njëjtin çmim. Për një njësi (`branchId`) është e detyrueshme. Required when branchId is present. |
| branchId | integer, nullable | no | Id-ja e njësisë që faturohet më vete. Pa të rinovohet abonimi kryesor i kompanisë. |
Përgjigjet
200 Kur njësia nuk gjendet, ose kur ruajtja dështon, përgjigja kthehet me HTTP 200 dhe `status: false`; arsyeja është te `message` ose te `errors`.
| Field | Tipi | Përshkrimi |
|---|---|---|
| status | boolean | |
| data | object | |
| data.subscription | object | |
| data.subscription.id | integer | Id-ja e abonimit |
| data.subscription.type | string | `main` për abonimin kryesor të kompanisë, `unit` për abonimin e një njësie që faturohet më vete |
| data.subscription.package | string, nullable | Paketa: `cash`, `noncash` ose `full`; `null` kur abonimi nuk ka asnjë lloj fature |
| data.subscription.startDate | string | Data kur nis abonimi, `YYYY-MM-DD` |
| data.subscription.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.subscription.paid | boolean | A është konfirmuar abonimi. Ato që rezervoni me API konfirmohen menjëherë |
| data.subscription.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 që e regjistroi kompaninë, kompania nuk ka abonim kryesor aktiv, ose njësia nuk mund të faturohet më vete.
| 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` |
409 Rinovimi i abonimit kryesor është rezervuar tashmë.
| 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` |
422 Të dhënat nuk kaluan validimin. Kjo përgjigje përdor fushën `success`, jo `status`, dhe `errors` është objekt sipas fushës.
| Field | Tipi | Përshkrimi |
|---|---|---|
| success | boolean | Gjithmonë false |
| message | string | Një rresht përmbledhës, i njëjtë për çdo dështim validimi |
| errors | object | Fushat që nuk kaluan validimin, secila me mesazhet e veta. Çelësat me pikë tregojnë brenda objekteve dhe elementëve të array-ve, p.sh. `lines.0.quantity` |
Shembull kërkese
curl -X POST 'https://fature.al/api/v1/on-boarding/subscription' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'X-Client-Id: YOUR_CLIENT_ID' \
-H 'X-Client-Secret: YOUR_CLIENT_SECRET' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"package": "full",
"branchId": 13
}'
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',
'Content-Type' => 'application/json',
])->post('https://fature.al/api/v1/on-boarding/subscription', [
'package' => 'full',
'branchId' => 13,
]);
$data = $response->json();
use GuzzleHttp\Client;
$client = new Client();
$response = $client->request('POST', 'https://fature.al/api/v1/on-boarding/subscription', [
'headers' => [
'Authorization' => 'Bearer YOUR_TOKEN',
'X-Client-Id' => 'YOUR_CLIENT_ID',
'X-Client-Secret' => 'YOUR_CLIENT_SECRET',
'Accept' => 'application/json',
'Content-Type' => 'application/json',
],
'json' => [
'package' => 'full',
'branchId' => 13,
],
]);
$data = json_decode((string) $response->getBody(), true);
const response = await fetch('https://fature.al/api/v1/on-boarding/subscription', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_TOKEN',
'X-Client-Id': 'YOUR_CLIENT_ID',
'X-Client-Secret': 'YOUR_CLIENT_SECRET',
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"package": "full",
"branchId": 13
})
});
const data = await response.json();
Shembull përgjigjeje
{
"status": true,
"data": {
"subscription": {
"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"
]
}
{
"status": false,
"message": "Te dhenat jo te sakta.",
"errors": [
"errors"
]
}
{
"success": false,
"message": "Te dhena jo te sakta",
"errors": []
}