# Pobieranie listy subskrypcji

Zobacz https://docs.simpay.pl/payment/blik-recurrent po więcej informacji.

Endpoint: GET /payment/{serviceId}/subscriptions
Version: 1.0.0
Security: bearerAuth

## Path parameters:

  - `serviceId` (string, required)
    Id usługi

## Query parameters:

  - `filter[status]` (string)
    Status subskrypcji
    Enum: "subscription_pending", "subscription_active", "subscription_cancelled", "subscription_expired", "subscription_finished", "subscription_fraudulent"

  - `filter[mode]` (string)
    Tryb subskrypcji
    Enum: "BLIK", "CARD"

  - `filter[uuid]` (string)
    Id subskrypcji
    Example: "019970c6-3d3e-708c-9313-5f89e251e2c0"

  - `page` (integer)
    Numer strony
    Example: 1

  - `perPage` (integer)
    Ile wyników na stronę pokazać
    Example: 20

  - `sort` (string)
    Pokazuj w kolejności od (-created_at = najnowszych, created_at = najstarszych)
    Enum: "-created_at", "created_at"

## Response 200 fields (application/json):

  - `success` (boolean, required)
    Request status
    Example: true

  - `data` (array, required)
    Example: [{"id":"019970c6-3d3e-708c-9313-5f89e251e2c0","status":"subscription_active","mode":"BLIK","blik":{"model":"O","alias":{"id":"019970c6-3ce8-71e7-8214-20fd635532fb","type":"PAYID","value":"AABBCC","label":"Płatność za pakiet premium","blik_key":null,"status":"alias_active","expires_at":"2035-07-15T00:00:00+02:00","created_at":"2025-09-22T11:34:23+02:00","updated_at":"2025-09-22T11:34:32+02:00"}},"frequency":null,"initiation_date":null,"total_amount_limit":null,"total_transactions_limit":null,"cancelled":null,"created_at":"2025-09-22T11:34:24+02:00","updated_at":"2025-09-22T11:34:32+02:00"},{"id":"0198a54d-05e1-72b8-b835-f2258609bb52","status":"subscription_cancelled","mode":"BLIK","blik":{"model":"O","alias":{"id":"0198a54d-05d9-7177-9ac6-5d9831bc988d","type":"PAYID","value":"CCBBAA","label":"Subskrypcja za muzykę","blik_key":null,"status":"alias_unregistered","expires_at":null,"created_at":"2025-08-13T23:19:05+02:00","updated_at":"2025-08-13T23:19:16+02:00"}},"frequency":"1M","initiation_date":"2025-08-13T23:15:13+02:00","total_amount_limit":null,"total_transactions_limit":null,"cancelled":{"by":"merchant","reason":"Rezygnacja przez użytkownika"},"created_at":"2025-08-13T23:19:05+02:00","updated_at":"2025-08-13T23:19:16+02:00"}]

  - `data.id` (string, required)
    Id subskrypcji

  - `data.status` (string, required)
    Status subskrypcji
    Enum: "subscription_pending", "subscription_active", "subscription_cancelled", "subscription_expired", "subscription_finished", "subscription_fraudulent"

  - `data.mode` (string, required)
    Tryb subskrypcji
    Enum: "BLIK", "CARD"

  - `data.blik` (object)

  - `data.blik.model` (string, required)
    Model Płatności Powtarzalnej BLIK
    Enum: "A", "O", "M"

  - `data.blik.alias` (object, required)

  - `data.blik.alias.id` (string, required)
    Id aliasu

  - `data.blik.alias.type` (string, required)
    Typ aliasu BLIK
    Enum: "PAYID", "UID"

  - `data.blik.alias.value` (string, required)
    Wartość aliasu
    Example: "AABBCC"

  - `data.blik.alias.label` (string, required)
    Etykieta wyświetlana w aplikacji mobilnej
    Example: "Płatność za pakiet premium w serwisie aaa"

  - `data.blik.alias.blik_key` (string,null)
    Identyfikator aliasu w BLIK (w przypadku aliasu PAYID będzie pusty)

  - `data.blik.alias.status` (string, required)
    Status aliasu BLIK
    Enum: "alias_pending_registration", "alias_active", "alias_expired", "alias_unregistered"

  - `data.blik.alias.expires_at` (string)
    Data utworzenia w formacie: ISO 8601

  - `data.blik.alias.created_at` (string, required)
    Data utworzenia w formacie: ISO 8601

  - `data.blik.alias.updated_at` (string, required)
    Data utworzenia w formacie: ISO 8601

  - `data.frequency` (string,null)
    Częstotliwość subskrypcji
    Example: "1M"

  - `data.initiation_date` (string,null)
    Data pierwszej możliwej Płatności Powtarzalnej
    Example: "2025-08-13T23:15:13+02:00"

  - `data.total_amount_limit` (number,null)
    Całkowita kwota, która jest dla tej Płatności Powtarzalnej
    Example: 4000

  - `data.total_transactions_limit` (integer,null)
    Całkowita ilość możliwych transakcji dla Płatności Powtarzalnej
    Example: 12

  - `data.cancelled` (object,null)

  - `data.cancelled.by` (string, required)
    Subskrypcja anulowana przez
    Enum: "system", "antifraud", "merchant", "payer", "blik"

  - `data.cancelled.reason` (string,null)
    Powód anulowania subskrypcji

  - `pagination` (object, required)

  - `pagination.total` (integer, required)
    Liczba wszystkich rekordów
    Example: 1

  - `pagination.count` (integer, required)
    Liczba rekordów na danej stronie
    Example: 1

  - `pagination.per_page` (integer, required)
    Maksymalna ilość rekordów na strone
    Example: 15

  - `pagination.current_page` (integer, required)
    Aktualna strona
    Example: 1

  - `pagination.total_pages` (integer, required)
    Ilość stron
    Example: 1

  - `pagination.links` (object, required)
    Adresy URL do stron

  - `pagination.links.next_page` (string,null, required)
    Adres URL do następnej strony

  - `pagination.links.prev_page` (string,null, required)
    Adres URL do poprzedniej strony

## Response 401 fields (application/json):

  - `success` (boolean, required)
    Request status

  - `errorCode` (string, required)
    Error status code
    Enum: "UNAUTHORIZED"

## Response 403 fields (application/json):

  - `success` (boolean, required)
    Request status

  - `errorCode` (string, required)
    Error status code
    Enum: "INVALID_ABILITY_PROVIDED", "IP_ADDRESS_NOT_WHITELISTED"

## Response 404 fields (application/json):

  - `success` (boolean, required)
    Request status

  - `errorCode` (string, required)
    Error status code
    Enum: "SERVICE_NOT_FOUND", "TRANSACTION_NOT_FOUND", "ROUTE_NOT_FOUND"

## Response 422 fields (application/json):

  - `success` (boolean, required)
    Request status

  - `errorCode` (string, required)
    Error status code
    Enum: "VALIDATION_ERROR"

  - `errors` (object, required)
    Example: {"amount":["The amount field is required."],"currency":["The selected currency is invalid."]}

  - `errors.amount` (array)
    Example: ["The amount field is required."]