Pengantar
Jual akses ke produk Anda sebagai langganan berbayar yang berulang.
🔐 Metode dari modul ini memerlukan otorisasi.
Informasi lebih lanjut tentang antarmuka pengguna modul ini https://doc.oneentry.cloud/docs/category/subscriptions
🎯 Apa yang dilakukan modul ini?
Modul Subscriptions memungkinkan Anda untuk mengelola langganan berbayar untuk pengguna saat ini — membuat langganan dan menerima sesi pembayaran, membatalkannya, memulihkannya melalui Stripe Billing Portal, dan mencantumkan penanda langganan yang tersedia atau aktif.
Alih-alih pesanan satu kali, pengguna berlangganan ke sebuah rencana (sebuah penanda seperti premium) dan ditagih secara otomatis oleh penyedia pembayaran.
🚀 Memulai dengan Cepat
Inisialisasi modul dari defineOneEntry:
const { Subscriptions } = defineOneEntry( "your-project-url", { "token": "your-app-token" });
Langganan pengguna saat ini ke sebuah rencana dan arahkan mereka ke sesi pembayaran (otorisasi diperlukan):
// Create a subscription for the "premium" plan.
const session = await Subscriptions.subscribe({ marker: "premium" });
// Send the user to the payment page to complete the first payment.
window.location.href = session.paymentUrl;
✨ Konsep Kunci
Apa itu penanda langganan?
Penanda adalah pengidentifikasi teks unik dari rencana langganan (misalnya premium). Anda mengirimkannya ke setiap metode modul ini untuk memberi tahu OneEntry rencana mana yang Anda maksud. Penanda tidak pernah berubah, jadi selalu rujuk rencana dengan penanda dalam kode Anda.
Sesi pembayaran
subscribe() mengembalikan sesi pembayaran (ICreatedSubscription) — sebuah objek dengan paymentUrl yang harus dibuka pengguna untuk menyelesaikan pembayaran pertama. Arahkan pengguna ke sana untuk menyelesaikan proses checkout.
📋 Apa yang Perlu Anda Ketahui
- Semua metode memerlukan pengguna yang terotorisasi — panggil mereka setelah pengguna masuk melalui modul AuthProvider.
getAllSubscriptions()mengembalikan semua penanda yang tersedia;getActiveSubscriptions()hanya mengembalikan penanda yang dilanggan oleh pengguna saat ini.cancelSubscription()danrecoverSubscriptions()menghasilkantruejika berhasil.subscribe(),cancelSubscription(), danrecoverSubscriptions()menerima body{ marker }.
📊 Tabel Referensi Cepat
| Metode | Deskripsi |
|---|---|
| subscribe() 🔐 | Buat langganan dan dapatkan sesi pembayaran |
| getAllSubscriptions() 🔐 | Dapatkan semua penanda langganan yang tersedia |
| getActiveSubscriptions() 🔐 | Dapatkan penanda langganan aktif pengguna |
| cancelSubscription() 🔐 | Batalkan langganan |
| recoverSubscriptions() 🔐 | Pulihkan langganan melalui Billing Portal |
🔐 = Memerlukan otorisasi
❓ Pertanyaan Umum (FAQ)
Bagaimana cara membuat rencana langganan?
Rencana langganan dikonfigurasi di panel admin OneEntry dan terhubung ke akun pembayaran (misalnya Stripe). SDK merujuk setiap rencana dengan penandanya.
Apa yang dikembalikan oleh subscribe()?
Ini mengembalikan sesi pembayaran dengan paymentUrl. Arahkan pengguna ke URL tersebut untuk menyelesaikan pembayaran pertama dan mengaktifkan langganan.
Apa perbedaan antara membatalkan dan memulihkan?
cancelSubscription() menghentikan penagihan berulang untuk sebuah rencana. recoverSubscriptions() mengembalikan langganan yang sebelumnya dibatalkan melalui Stripe Billing Portal.
🎓 Praktik Terbaik
- Selalu rujuk rencana dengan penanda, jangan pernah dengan nama tampilan.
- Autentikasi pengguna sebelum memanggil metode langganan apa pun.
- Setelah
subscribe(), arahkan pengguna kepaymentUrldan tangani URL kembali di aplikasi Anda. - Gunakan
getActiveSubscriptions()untuk membatasi fitur premium di UI Anda.
🔗 Dokumentasi Terkait
- Modul AuthProvider - Diperlukan untuk mengotorisasi pengguna
- Modul Pembayaran - Akun dan sesi pembayaran
- Modul Pengguna - Kelola pengguna yang berlangganan