Lewati ke konten utama

cancelSubscription

Batalkan langganan. 🔐 Metode ini memerlukan otorisasi.

Deskripsi

Metode ini membatalkan langganan pengguna saat ini yang diidentifikasi oleh penandanya. Ini mengembalikan Promise yang menyelesaikan menjadi true jika langganan dibatalkan, atau objek IError jika ada masalah.

⚠️ Dengan pengaturan default errors.isShell: true, permintaan yang ditolak dikembalikan daripada dilempar: metode ini menyelesaikan menjadi objek IError, tidak pernah menjadi false. Periksa result === true - objek kesalahan adalah truthy, jadi if (result) akan memperlakukan kegagalan sebagai keberhasilan.

Langganan.cancelSubscription(

body*

);

Skema parameter

Skema

body(diperlukan): ICancelSubscription
Isi langganan
contoh:

{ marker: "premium" }

body.marker(diperlukan): string
Penanda langganan.
contoh: "premium"

Contoh

Contoh minimal

const response = await Subscriptions.cancelSubscription({ marker: 'premium' });

Contoh respons

{
"statusCode": 404,
"timestamp": "2026-08-14T13:04:36.941Z",
"message": "No subscription found"
}

Skema respons

Details

Skema: boolean boolean: boolean
Mengembalikan true jika langganan dibatalkan.
contoh: true