Przejdź do treści
Oplac

Referencja API

Kupony

Rabaty do subskrypcji.

POST/v1/couponsGET/v1/coupons/{id}GET/v1/couponsDELETE/v1/coupons/{id}

Klucz testowy w przykładach

Wklej klucz sk_test_ z panelu (zakładka Deweloperzy), a każdy przykład będzie gotowy do uruchomienia. Klucz zostaje w tej karcie przeglądarki, nie wysyłamy go nigdzie.

Przykłady używają Twojego klucza testowego. Produkcyjnego klucza nie przyjmujemy.

Tryb testowy

Obiekt coupon#

Kupon rabatowy (coupon_) do subskrypcji: procent albo kwota, na pierwszy okres, na stałe albo przez kilka miesięcy.

Pola

  • id string wymagane

    Identyfikator kuponu.

  • object string wymagane

    Nazwa typu obiektu, zawsze "coupon".

  • code string wymagane

    Kod wpisywany przez klienta; wielkimi literami.

  • percent_off integer | null

    Od 1 do 100.

  • amount_off integer | null

    Kwota rabatu w groszach.

  • currency string | null

    Waluta kwoty rabatu; kupon kwotowy pasuje tylko do planów w tej walucie.

  • duration string wymagane
    onceforeverrepeating
  • duration_in_months integer | null
  • max_redemptions integer | null
  • times_redeemed integer
  • active boolean wymagane
  • metadata object wymagane

    Własne pary klucz: wartość (do 50 kluczy, klucz do 40 znaków, wartość tekstowa do 500 znaków). Wracają w obiekcie i w zdarzeniach webhooka. Przy zmianie nowe klucze dochodzą do zapisanych, pusta wartość usuwa klucz, pusty tekst zamiast obiektu czyści wszystko.

  • livemode boolean wymagane

    true dla obiektów produkcyjnych (klucz sk_live_), false dla piaskownicy (sk_test_).

  • created integer wymagane

    Chwila utworzenia jako znacznik czasu Unix (sekundy, UTC).

JSON 
{
  "id": "coupon_Ab12Cd34Ef56",
  "object": "coupon",
  "code": "START20",
  "percent_off": 20,
  "amount_off": null,
  "currency": null,
  "duration": "once",
  "duration_in_months": null,
  "max_redemptions": 100,
  "times_redeemed": 3,
  "active": true,
  "metadata": [],
  "livemode": false,
  "created": 1760000000
}

Utwórz kupon#

POST /v1/coupons

Procent (percent_off) albo kwota (amount_off w groszach, z currency). duration: once (pierwszy okres), forever, repeating (duration_in_months).

Nagłówki opcjonalne: Oplac-Version, Idempotency-Key

Treść żądania JSON

  • code string wymagane

    Do 40 znaków.

  • percent_off integer

    Od 1 do 100.

  • amount_off integer

    Od 1.

  • currency string

    Waluta. EUR i USD od planu Skala.

    PLNEURUSD
  • duration string wymagane
    onceforeverrepeating
  • duration_in_months integer

    Od 1 do 36.

  • max_redemptions integer

    Od 1.

  • metadata object

    Własne pary klucz: wartość (do 50 kluczy, klucz do 40 znaków, wartość tekstowa do 500 znaków). Wracają w obiekcie i w zdarzeniach webhooka. Przy zmianie nowe klucze dochodzą do zapisanych, pusta wartość usuwa klucz, pusty tekst zamiast obiektu czyści wszystko.

Odpowiedź

HTTP 201: obiekt coupon.

Błędy tej operacji: parameter_missing, parameter_invalid, metadata_invalid, expand_invalid, api_version_invalid, idempotency_key_reused, idempotency_key_invalid, api_key_invalid, module_not_in_plan, rate_limited, api_error . Każdy błąd to ten sam obiekt error, opisany w przewodniku Błędy. 

curl https://oplac.pl/api/v1/coupons \
  -H "Authorization: Bearer sk_test_TWOJ_KLUCZ" \
  -H "Idempotency-Key: 5f0c2a4e-7d1b-4e8a-9b2f-1c3d5e7f9a0b" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "START20",
  "percent_off": 20,
  "duration": "once",
  "max_redemptions": 100
}'
$ch = curl_init('https://oplac.pl/api/v1/coupons');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer sk_test_TWOJ_KLUCZ',
        'Idempotency-Key: 5f0c2a4e-7d1b-4e8a-9b2f-1c3d5e7f9a0b',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'code' => 'START20',
        'percent_off' => 20,
        'duration' => 'once',
        'max_redemptions' => 100,
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$coupon = json_decode(curl_exec($ch), true);
const res = await fetch('https://oplac.pl/api/v1/coupons', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer sk_test_TWOJ_KLUCZ',
    'Idempotency-Key': '5f0c2a4e-7d1b-4e8a-9b2f-1c3d5e7f9a0b',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    code: 'START20',
    percent_off: 20,
    duration: 'once',
    max_redemptions: 100,
  }),
});
const coupon = await res.json();
import requests

res = requests.post(
    "https://oplac.pl/api/v1/coupons",
    headers={
        "Authorization": "Bearer sk_test_TWOJ_KLUCZ",
        "Idempotency-Key": "5f0c2a4e-7d1b-4e8a-9b2f-1c3d5e7f9a0b",
    },
    json={
        "code": "START20",
        "percent_off": 20,
        "duration": "once",
        "max_redemptions": 100,
    },
)
coupon = res.json()
Odpowiedź HTTP 201 
{
  "id": "coupon_Ab12Cd34Ef56",
  "object": "coupon",
  "code": "START20",
  "percent_off": 20,
  "amount_off": null,
  "currency": null,
  "duration": "once",
  "duration_in_months": null,
  "max_redemptions": 100,
  "times_redeemed": 3,
  "active": true,
  "metadata": [],
  "livemode": false,
  "created": 1760000000
}

Pobierz kupon#

GET /v1/coupons/{id}

Kupon po identyfikatorze.

Nagłówki opcjonalne: Oplac-Version

Parametry ścieżki

  • id string wymagane

    Identyfikator coupon_.

Odpowiedź

HTTP 200: obiekt coupon.

Błędy tej operacji: parameter_missing, parameter_invalid, metadata_invalid, expand_invalid, api_version_invalid, idempotency_key_reused, idempotency_key_invalid, api_key_invalid, module_not_in_plan, resource_missing, rate_limited, api_error . Każdy błąd to ten sam obiekt error, opisany w przewodniku Błędy. 

curl https://oplac.pl/api/v1/coupons/coupon_Ab12Cd34Ef56 \
  -H "Authorization: Bearer sk_test_TWOJ_KLUCZ"
$ch = curl_init('https://oplac.pl/api/v1/coupons/coupon_Ab12Cd34Ef56');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ['Authorization: Bearer sk_test_TWOJ_KLUCZ'],
    CURLOPT_RETURNTRANSFER => true,
]);
$coupon = json_decode(curl_exec($ch), true);
const res = await fetch('https://oplac.pl/api/v1/coupons/coupon_Ab12Cd34Ef56', {
  headers: {Authorization: 'Bearer sk_test_TWOJ_KLUCZ' },
});
const coupon = await res.json();
import requests

res = requests.get(
    "https://oplac.pl/api/v1/coupons/coupon_Ab12Cd34Ef56",
    headers={"Authorization": "Bearer sk_test_TWOJ_KLUCZ"},
)
coupon = res.json()
Odpowiedź HTTP 200 
{
  "id": "coupon_Ab12Cd34Ef56",
  "object": "coupon",
  "code": "START20",
  "percent_off": 20,
  "amount_off": null,
  "currency": null,
  "duration": "once",
  "duration_in_months": null,
  "max_redemptions": 100,
  "times_redeemed": 3,
  "active": true,
  "metadata": [],
  "livemode": false,
  "created": 1760000000
}

Lista kuponów#

GET /v1/coupons

Kupony konta w trybie klucza.

Nagłówki opcjonalne: Oplac-Version

Parametry zapytania

  • limit integer

    Liczba obiektów na stronie (1 do 100). Domyślnie 10. Od 1 do 100.

  • starting_after string

    Identyfikator obiektu; zwraca starsze od niego (następna strona).

  • ending_before string

    Identyfikator obiektu; zwraca nowsze od niego (poprzednia strona). Nie łączyć ze starting_after.

  • created object

    Filtr po chwili utworzenia (Unix): created[gte]=1760000000.

    • gt integer
    • gte integer
    • lt integer
    • lte integer

Odpowiedź

HTTP 200: lista {object: "list", url, has_more, data} z obiektami coupon od najnowszego. Stronicowanie kursorem opisuje przewodnik.

Błędy tej operacji: parameter_missing, parameter_invalid, metadata_invalid, expand_invalid, api_version_invalid, idempotency_key_reused, idempotency_key_invalid, api_key_invalid, module_not_in_plan, rate_limited, api_error . Każdy błąd to ten sam obiekt error, opisany w przewodniku Błędy. 

curl "https://oplac.pl/api/v1/coupons?limit=3" \
  -H "Authorization: Bearer sk_test_TWOJ_KLUCZ"
$ch = curl_init('https://oplac.pl/api/v1/coupons?limit=3');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ['Authorization: Bearer sk_test_TWOJ_KLUCZ'],
    CURLOPT_RETURNTRANSFER => true,
]);
$coupons = json_decode(curl_exec($ch), true);
const res = await fetch('https://oplac.pl/api/v1/coupons?limit=3', {
  headers: {Authorization: 'Bearer sk_test_TWOJ_KLUCZ' },
});
const coupons = await res.json();
import requests

res = requests.get(
    "https://oplac.pl/api/v1/coupons?limit=3",
    headers={"Authorization": "Bearer sk_test_TWOJ_KLUCZ"},
)
coupons = res.json()
Odpowiedź HTTP 200 
{
  "object": "list",
  "url": "/v1/coupons",
  "has_more": false,
  "data": [
    {
      "id": "coupon_Ab12Cd34Ef56",
      "object": "coupon",
      "code": "START20",
      "percent_off": 20,
      "amount_off": null,
      "currency": null,
      "duration": "once",
      "duration_in_months": null,
      "max_redemptions": 100,
      "times_redeemed": 3,
      "active": true,
      "metadata": [],
      "livemode": false,
      "created": 1760000000
    }
  ]
}

Usuń kupon#

DELETE /v1/coupons/{id}

Kupon przestaje być przyjmowany; subskrypcje, które go mają, zachowują rabat.

Nagłówki opcjonalne: Oplac-Version, Idempotency-Key

Parametry ścieżki

  • id string wymagane

    Identyfikator coupon_.

Odpowiedź

HTTP 200: obiekt {id, object, deleted: true}; usuniętego obiektu nie da się już zmieniać.

Błędy tej operacji: parameter_missing, parameter_invalid, metadata_invalid, expand_invalid, api_version_invalid, idempotency_key_reused, idempotency_key_invalid, api_key_invalid, module_not_in_plan, resource_missing, rate_limited, api_error . Każdy błąd to ten sam obiekt error, opisany w przewodniku Błędy. 

curl https://oplac.pl/api/v1/coupons/coupon_Ab12Cd34Ef56 \
  -X DELETE \
  -H "Authorization: Bearer sk_test_TWOJ_KLUCZ"
$ch = curl_init('https://oplac.pl/api/v1/coupons/coupon_Ab12Cd34Ef56');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => ['Authorization: Bearer sk_test_TWOJ_KLUCZ'],
    CURLOPT_RETURNTRANSFER => true,
]);
$deleted = json_decode(curl_exec($ch), true);
const res = await fetch('https://oplac.pl/api/v1/coupons/coupon_Ab12Cd34Ef56', {
  method: 'DELETE',
  headers: {Authorization: 'Bearer sk_test_TWOJ_KLUCZ' },
});
const deleted = await res.json();
import requests

res = requests.delete(
    "https://oplac.pl/api/v1/coupons/coupon_Ab12Cd34Ef56",
    headers={"Authorization": "Bearer sk_test_TWOJ_KLUCZ"},
)
deleted = res.json()
Odpowiedź HTTP 200 
{
  "id": "coupon_Ab12Cd34Ef56",
  "object": "coupon",
  "deleted": true,
  "livemode": false
}

Klucz testowy dostajesz od razu po zapisie

Adres e-mail, kod z maila i piaskownica z kodami BLIK. Produkcję włączasz sam w panelu: plan, dostawca płatności, klucz sk_live_. Wolisz, żeby wdrożenie w sklepie zrobił nasz zespół? To też jest za darmo.

Zamów integrację za darmo

BLIK, karty, subskrypcje i KSeF w jednym panelu.