API Langganan

Untuk bekerja dengan langganan dari sisi aplikasi klien, terdapat tiga endpoint: pendaftaran langganan, pembatalan langganan, dan mendapatkan daftar langganan aktif pengguna saat ini.

Semua endpoint dijalankan atas nama pengguna yang terautentikasi — langganan selalu terikat pada token yang digunakan untuk melakukan permintaan.

Pendaftaran Langganan

Membuat langganan baru untuk pengguna saat ini pada token yang ditentukan.

Perilaku tergantung pada jenis akun pembayaran yang terikat pada langganan di pengaturan modul:

• stripe, midtrans — sebuah catatan langganan dibuat dan tautan untuk pembayaran dikembalikan. Langganan menjadi aktif setelah pemotongan berhasil dari penyedia.
• custom — langganan dibuat dan langsung dianggap aktif. Tautan untuk pembayaran tidak dikembalikan, pembayaran dicatat oleh administrator secara manual melalui kartu pengguna.

Pembatalan Langganan

Segera membatalkan langganan aktif pengguna.

Perilaku tergantung pada jenis akun pembayaran:

• stripe, midtrans — langganan dibatalkan melalui API penyedia: pemotongan otomatis dihentikan, status langganan berubah menjadi canceled.
• custom — pembatalan melalui API tidak tersedia. Langganan semacam ini hanya dapat dibatalkan oleh administrator melalui kartu pengguna.

info

Upaya untuk membatalkan langganan custom melalui API akan mengembalikan kesalahan. Ini dilakukan dengan sengaja: langganan manual dikelola oleh administrator, karena pembayaran untuk langganan tersebut dilakukan di luar sistem.

Mendapatkan Langganan Aktif

Mengembalikan array token langganan aktif pengguna saat ini.

Langganan dianggap aktif jika:

• Langganan tersebut telah berhasil didaftarkan.
• Periode saat ini belum berakhir.
• Langganan tersebut belum dibatalkan (canceled).

Jika langganan berakhir atau dibatalkan, tokennya secara otomatis hilang dari daftar. Endpoint ini nyaman digunakan di klien untuk memeriksa akses ke konten: jika token langganan yang diperlukan ada dalam array — akses diberikan.