Przejdź do treści
Oplac

Referencja API

Plany

Plany abonamentowe (moduł Bill).

POST/v1/plansGET/v1/plans/{id}POST/v1/plans/{id}GET/v1/plans

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 plan#

Plan abonamentowy (plan_) dla klientów sprzedawcy (moduł Bill, od planu Firma). Kwota, waluta i okres są stałe po utworzeniu.

Pola

  • id string wymagane

    Identyfikator planu.

  • object string wymagane

    Nazwa typu obiektu, zawsze "plan".

  • name string wymagane

    Do 120 znaków.

  • amount integer wymagane

    Kwota okresu w groszach.

  • currency string wymagane
    PLNEURUSD
  • interval string wymagane
    monthyear
  • trial_days integer

    Dni okresu próbnego bez obciążenia (0 do 365).

  • active boolean wymagane

    Wyłączony plan nie przyjmuje nowych subskrypcji; trwające odnawiają się dalej.

  • 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": "plan_Ab12Cd34Ef56Gh",
  "object": "plan",
  "name": "Pro miesięcznie",
  "amount": 4900,
  "currency": "PLN",
  "interval": "month",
  "trial_days": 14,
  "active": true,
  "metadata": [],
  "livemode": false,
  "created": 1760000000
}

Utwórz plan#

POST /v1/plans

Plan abonamentowy dla klientów sprzedawcy. Kwota, waluta i okres są stałe po utworzeniu (subskrypcje liczą się z nich).

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

Treść żądania JSON

  • name string wymagane

    Do 120 znaków.

  • amount integer wymagane

    Kwota w groszach (najmniejszej jednostce waluty): 12900 to 129,00 zł. Od 100 (1,00). Od 100 do 999999999.

  • currency string wymagane

    Waluta. EUR i USD od planu Skala.

    PLNEURUSD
  • interval string wymagane
    monthyear
  • trial_days integer

    Domyślnie 0. Od 0 do 365.

  • 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 plan.

Błędy tej operacji: parameter_missing, parameter_invalid, metadata_invalid, expand_invalid, api_version_invalid, idempotency_key_reused, idempotency_key_invalid, api_key_invalid, provider_not_connected, 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/plans \
  -H "Authorization: Bearer sk_test_TWOJ_KLUCZ" \
  -H "Idempotency-Key: 5f0c2a4e-7d1b-4e8a-9b2f-1c3d5e7f9a0b" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Pro miesięcznie",
  "amount": 4900,
  "currency": "PLN",
  "interval": "month",
  "trial_days": 14
}'
$ch = curl_init('https://oplac.pl/api/v1/plans');
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([
        'name' => 'Pro miesięcznie',
        'amount' => 4900,
        'currency' => 'PLN',
        'interval' => 'month',
        'trial_days' => 14,
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$plan = json_decode(curl_exec($ch), true);
const res = await fetch('https://oplac.pl/api/v1/plans', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer sk_test_TWOJ_KLUCZ',
    'Idempotency-Key': '5f0c2a4e-7d1b-4e8a-9b2f-1c3d5e7f9a0b',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Pro miesięcznie',
    amount: 4900,
    currency: 'PLN',
    interval: 'month',
    trial_days: 14,
  }),
});
const plan = await res.json();
import requests

res = requests.post(
    "https://oplac.pl/api/v1/plans",
    headers={
        "Authorization": "Bearer sk_test_TWOJ_KLUCZ",
        "Idempotency-Key": "5f0c2a4e-7d1b-4e8a-9b2f-1c3d5e7f9a0b",
    },
    json={
        "name": "Pro miesięcznie",
        "amount": 4900,
        "currency": "PLN",
        "interval": "month",
        "trial_days": 14,
    },
)
plan = res.json()
Odpowiedź HTTP 201 
{
  "id": "plan_Ab12Cd34Ef56Gh",
  "object": "plan",
  "name": "Pro miesięcznie",
  "amount": 4900,
  "currency": "PLN",
  "interval": "month",
  "trial_days": 14,
  "active": true,
  "metadata": [],
  "livemode": false,
  "created": 1760000000
}

Pobierz plan#

GET /v1/plans/{id}

Plan po identyfikatorze.

Nagłówki opcjonalne: Oplac-Version

Parametry ścieżki

  • id string wymagane

    Identyfikator plan_.

Odpowiedź

HTTP 200: obiekt plan.

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/plans/plan_Ab12Cd34Ef56Gh \
  -H "Authorization: Bearer sk_test_TWOJ_KLUCZ"
$ch = curl_init('https://oplac.pl/api/v1/plans/plan_Ab12Cd34Ef56Gh');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ['Authorization: Bearer sk_test_TWOJ_KLUCZ'],
    CURLOPT_RETURNTRANSFER => true,
]);
$plan = json_decode(curl_exec($ch), true);
const res = await fetch('https://oplac.pl/api/v1/plans/plan_Ab12Cd34Ef56Gh', {
  headers: {Authorization: 'Bearer sk_test_TWOJ_KLUCZ' },
});
const plan = await res.json();
import requests

res = requests.get(
    "https://oplac.pl/api/v1/plans/plan_Ab12Cd34Ef56Gh",
    headers={"Authorization": "Bearer sk_test_TWOJ_KLUCZ"},
)
plan = res.json()
Odpowiedź HTTP 200 
{
  "id": "plan_Ab12Cd34Ef56Gh",
  "object": "plan",
  "name": "Pro miesięcznie",
  "amount": 4900,
  "currency": "PLN",
  "interval": "month",
  "trial_days": 14,
  "active": true,
  "metadata": [],
  "livemode": false,
  "created": 1760000000
}

Zmień plan#

POST /v1/plans/{id}

name, active (wyłączony plan nie przyjmuje nowych subskrypcji), metadata. Próba zmiany amount, currency albo interval to 400 parameter_invalid.

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

Parametry ścieżki

  • id string wymagane

    Identyfikator plan_.

Treść żądania JSON, opcjonalna

  • name string

    Do 120 znaków.

  • active boolean
  • 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 200: obiekt plan.

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/plans/plan_Ab12Cd34Ef56Gh \
  -H "Authorization: Bearer sk_test_TWOJ_KLUCZ" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Anna Nowak",
  "active": true,
  "metadata": {
    "order_id": "10482"
  }
}'
$ch = curl_init('https://oplac.pl/api/v1/plans/plan_Ab12Cd34Ef56Gh');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer sk_test_TWOJ_KLUCZ',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'name' => 'Anna Nowak',
        'active' => true,
        'metadata' => [
            'order_id' => '10482',
        ],
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$plan = json_decode(curl_exec($ch), true);
const res = await fetch('https://oplac.pl/api/v1/plans/plan_Ab12Cd34Ef56Gh', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer sk_test_TWOJ_KLUCZ',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Anna Nowak',
    active: true,
    metadata: {
      order_id: '10482',
    },
  }),
});
const plan = await res.json();
import requests

res = requests.post(
    "https://oplac.pl/api/v1/plans/plan_Ab12Cd34Ef56Gh",
    headers={"Authorization": "Bearer sk_test_TWOJ_KLUCZ"},
    json={
        "name": "Anna Nowak",
        "active": True,
        "metadata": {
            "order_id": "10482",
        },
    },
)
plan = res.json()
Odpowiedź HTTP 200 
{
  "id": "plan_Ab12Cd34Ef56Gh",
  "object": "plan",
  "name": "Pro miesięcznie",
  "amount": 4900,
  "currency": "PLN",
  "interval": "month",
  "trial_days": 14,
  "active": true,
  "metadata": [],
  "livemode": false,
  "created": 1760000000
}

Lista planów#

GET /v1/plans

Plany 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
  • active boolean

    Tylko włączone albo wyłączone.

Odpowiedź

HTTP 200: lista {object: "list", url, has_more, data} z obiektami plan 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/plans?limit=3" \
  -H "Authorization: Bearer sk_test_TWOJ_KLUCZ"
$ch = curl_init('https://oplac.pl/api/v1/plans?limit=3');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ['Authorization: Bearer sk_test_TWOJ_KLUCZ'],
    CURLOPT_RETURNTRANSFER => true,
]);
$plans = json_decode(curl_exec($ch), true);
const res = await fetch('https://oplac.pl/api/v1/plans?limit=3', {
  headers: {Authorization: 'Bearer sk_test_TWOJ_KLUCZ' },
});
const plans = await res.json();
import requests

res = requests.get(
    "https://oplac.pl/api/v1/plans?limit=3",
    headers={"Authorization": "Bearer sk_test_TWOJ_KLUCZ"},
)
plans = res.json()
Odpowiedź HTTP 200 
{
  "object": "list",
  "url": "/v1/plans",
  "has_more": false,
  "data": [
    {
      "id": "plan_Ab12Cd34Ef56Gh",
      "object": "plan",
      "name": "Pro miesięcznie",
      "amount": 4900,
      "currency": "PLN",
      "interval": "month",
      "trial_days": 14,
      "active": true,
      "metadata": [],
      "livemode": false,
      "created": 1760000000
    }
  ]
}

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.