Dokumentacja dla programistów

Subskrypcja aplikacji

API MarketplaceDokumentacja API
Aktualizacja 2026-09-06

Monetyzacja aplikacji wykorzystuje subskrypcje jako umowę rozliczeniową między użytkownikiem a aplikacją. Każda subskrypcja zawiera unikalne dane dotyczące częstotliwości rozliczeń użytkownika, rodzaju planu i okresu odnowienia.

Zapytania

Pobierz subskrypcję aplikacji

  • Zwraca tablicę zawierającą szczegóły bieżącej subskrypcji aplikacji i konta na podstawie użytego tokenu.
  • Jeśli konto ma subskrypcję testową i rzeczywistą, zwrócona zostanie tylko subskrypcja testowa.
  • Zapytanie można wykonać tylko bezpośrednio na poziomie głównym. Nie można zagnieżdżać go w innym zapytaniu.

To zapytanie jest wywoływane na poziomie aplikacji. Można je wywołać tylko w kontekście aplikacji, a nie z poziomu API Playground.

Zwraca szczegóły wyłącznie na podstawie użytego tokenu. Aby pobrać wszystkie subskrypcje aplikacji, użyj zamiast tego obiektu app_subscriptions.

query {
  app_subscription {
    billing_period
    days_left
    is_trial
    max_units
    renewal_date
  }
}
import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });

const query = "query { app_subscription { billing_period days_left is_trial max_units renewal_date } }";
const response = await mondayApiClient.request(query);
{ 
  "data": {
    "app_subscription":[
      {
        "billing_period": "yearly",
        "days_left": 278,
        "is_trial": false,
        "max_units": 15,
        "renewal_date": "2023-08-27T00:00:00+00:00",
      }
    ]
  },
  "account_id": 12345
}

Pola

Pola Typ Opis
billing_period String Częstotliwość okresu rozliczeniowego: monthly lub yearly.
days_left Int Liczba dni pozostałych do końca subskrypcji.
is_trial Boolean Określa, czy subskrypcja jest w okresie próbnym.
max_units Int Maksymalna liczba miejsc dozwolona w planach opartych na miejscach. Zwraca null w planach opartych na funkcjach.
plan_id String! Identyfikator planu subskrypcji po stronie aplikacji.
pricing_version Int Wersja cennika subskrypcji.
renewal_date Date! Data odnowienia subskrypcji.

Mutacje

Ustaw testową subskrypcję aplikacji

Tworzy testową subskrypcję dla konta i aplikacji na podstawie używanego tokenu. Zwraca AppSubscription.

Testowe subskrypcje znikają po 24 godzinach. Każda para konto–aplikacja może utworzyć jedną testową subskrypcję. Po jej utworzeniu może być konieczne odświeżenie przeglądarki, aby subskrypcja była widoczna na koncie.

mutation {
  set_mock_app_subscription(
    app_id: 12345,
        partial_signing_secret: "abcde12345",
    is_trial: true,
    plan_id: "basic_plan_15_users",
    max_units: 15
  ) {
    plan_id
  }
}
import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });

const query = `
  mutation {
    set_mock_app_subscription (
      app_id: 12345,
      partial_signing_secret: "abcde12345",
      is_trial: true,
      plan_id: "basic_plan_15_users",
      max_units: 15
    ) {
      plan_id
    }
  }`;
const response = await mondayApiClient.request(query);

Argumenty

Argument Typ Opis
app_id ID! Unikalny identyfikator aplikacji. Znajdziesz go w adresie URL aplikacji w następującym formacie: myaccount.monday.com/apps/manage/{YOUR_APP_ID}/app_versions/12345/sections/appDetails.
billing_period String Częstotliwość okresu rozliczeniowego: monthly lub yearly.
is_trial Boolean Określa, czy subskrypcja jest w okresie próbnym. Wartość domyślna to false.
max_units Int W przypadku aplikacji opartych na miejscach - maksymalna liczba miejsc dozwolona w planie testowym.
partial_signing_secret String! Ostatnie 10 znaków klucza podpisującego aplikacji.
plan_id String Unikalny identyfikator planu testowej subskrypcji.
pricing_version Int Wersja cennika subskrypcji.
renewal_date Date Data odnowienia subskrypcji. Domyślnie przypada rok później i jest podawana w formacie UTC DateTime. Mutacja zakończy się niepowodzeniem, jeśli podasz datę z przeszłości.

Usuń testową subskrypcję aplikacji

Usuwa testową subskrypcję bieżącego konta. Zwraca AppSubscription.

mutation {
  remove_mock_app_subscription(
    app_id: 12345
    partial_signing_secret: "abcde12345"
  ) {
    billing_period
    days_left
    is_trial
  }
}
import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });

const query = `mutation {
  remove_mock_app_subscription (app_id: 12345, partial_signing_secret: "abcde12345") {
    billing_period
    days_left
    is_trial
 }
}`;
const response = await mondayApiClient.request(query);

Argumenty

Argument Typ Opis
app_id ID! Unikalny identyfikator aplikacji.
partial_signing_secret String! Ostatnie 10 znaków klucza podpisującego aplikacji.