مرجع نسخه دوم API توسعه‌دهنده

بررسی لغو اشتراک

این متد اشتراک موردنظر را لغو خواهد کرد:

https://pardakht.cafebazaar.ir/devapi/v2/api/applications/<package_name>/subscriptions/<subscription_id>/purchases/<purchase_token>/cancel/

مقادیر داخل پرانتز شکسته – <> – باید با توجه به درخواست جایگزین شوند:

نام مقدار
package_name نام بسته‌ای که اشتراک برای آن تعریف شده‌است.
subscription_id SKU اشتراک.
purchase_token token اشتراک که در هنگام آغاز اشتراک از بازار به برنامه فرستاده شده‌است. شما همچنین می‌توانید از token یکی از شارژهای بعدی اشتراک استفاده کنید.

توجه کنید که برای استفاده از این متد به access_token معتبر نیاز دارید.

در صورت لغو موفق اشتراک، نتیجه این درخواست یک شئ خالی JSON خواهد بود:

{}

در صورتی که به هر دلیل، درخواست معتبر نباشد، پاسخی با کد وضعیت 40X و در قالب JSON دریافت خواهید کرد که دارای یک کلید error با محتوای خطای ایجاد شده‌ و کلید error_desciption با شرحی بیشتر درباره خطا است. به عنوان مثال در صورتی که اشتراک موردنظر یافت نشود، پاسخ بازگشتی با کد وضعیت 404 و به صورت زیر خواهد بود:

{
   "error": "not_found",
   "error_description": "The requested subscription is not found!",
}

اگر اشتراک موردنظر از قبل لغو شده یا منقضی شده باشد، و یا محصول موردنظر یافت نشود، نتیجه خطایی مانند توضیح بالا، و با مقدار error برابر با invalid_value خواهد بود.