الانتقال إلى المحتوى الرئيسي
POST
/
v1
/
public
/
accounts
/
{account_id}
/
billing
/
cancel-plan
إلغاء خطة الفوترة
curl --request POST \
  --url https://api.hybridbox.io/v1/public/accounts/{account_id}/billing/cancel-plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cancel_at_period_end": true,
  "cancel_immediately": false
}
'
{
  "status": "<string>",
  "account_status": "<string>",
  "effective_at": "2023-11-07T05:31:56Z",
  "eligible": true,
  "previous_plan_id": "<string>",
  "target_plan_id": "<string>"
}

التفويضات

​
Authorization
string
header
مطلوب

Public API bearer credential sent as Authorization: Bearer <token>. Use either an OAuth access token or a Hybridbox Service account token.

معلمات المسار

​
account_id
string<uuid>
مطلوب

الجسم

application/json

مخطط طلب عميل لإلغاء خطة اشتراك حساب.

​
cancel_at_period_end
boolean
افتراضي:true

قم بإلغاء الخطة في نهاية فترة الفاتورة

​
cancel_immediately
boolean
افتراضي:false

قم بإلغاء الخطة على الفور

الاستجابة

​
status
string
مطلوب

حالة عملية الفوترة

​
account_status
string | null

حالة الحساب بعد العملية

​
effective_at
string<date-time> | null

عندما أصبح تغيير الفاتورة ساري المفعول

​
eligible
boolean | null

ما إذا كان الحساب مؤهلاً لهذه العملية

​
previous_plan_id
string | null

معرف خطة الفوترة السابقة

​
target_plan_id
string | null

معرف خطة الفوترة المستهدفة