> For the complete documentation index, see [llms.txt](https://bagelpay.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bagelpay.gitbook.io/docs/apireference/api-document/subscription.md).

# Subscription

## POST /api/subscriptions/{subscription\_id}/cancel

> Cancel Subsctipion

```json
{"openapi":"3.1.0","info":{"title":"BagelPay-SDK","version":"1.0.0"},"tags":[{"name":"Subscription"}],"servers":[{"url":"https://test.bagelpay.io","description":"Development env"}],"security":[],"paths":{"/api/subscriptions/{subscription_id}/cancel":{"post":{"summary":"Cancel Subsctipion","deprecated":false,"description":"","tags":["Subscription"],"parameters":[{"name":"subscription_id","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"x-api-key","in":"header","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"msg":{"type":"string"},"code":{"type":"integer"},"data":{"type":"object","properties":{"status":{"type":"string"},"remark":{"type":["string","null"]},"customer":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"}},"required":["id","email"]},"mode":{"type":"string"},"last4":{"type":"string"},"subscription_id":{"type":"string"},"product_id":{"type":"string"},"store_id":{"type":"string"},"billing_period_start":{"type":["string","null"]},"billing_period_end":{"type":["string","null"]},"cancel_at":{"type":"string"},"trial_start":{"type":["string","null"]},"trial_end":{"type":["string","null"]},"units":{"type":"integer"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"product_name":{"type":"string"},"payment_method":{"type":"string"},"next_billing_amount":{"type":"integer"},"recurring_interval":{"type":"string"}},"required":["status","remark","customer","mode","last4","subscription_id","product_id","store_id","billing_period_start","billing_period_end","cancel_at","trial_start","trial_end","units","created_at","updated_at","product_name","payment_method","next_billing_amount","recurring_interval"]}},"required":["msg","code","data"]}}},"headers":{}}}}}}}
```

## GET /api/subscriptions/list

> List Subscriptions

```json
{"openapi":"3.1.0","info":{"title":"BagelPay-SDK","version":"1.0.0"},"tags":[{"name":"Subscription"}],"servers":[{"url":"https://test.bagelpay.io","description":"Development env"}],"security":[],"paths":{"/api/subscriptions/list":{"get":{"summary":"List Subscriptions","deprecated":false,"description":"","tags":["Subscription"],"parameters":[{"name":"pageNum","in":"query","description":"","required":false,"schema":{"type":"integer","minimum":1}},{"name":"pageSize","in":"query","description":"","required":false,"schema":{"type":"integer","minimum":1}},{"name":"x-api-key","in":"header","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"items":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["active","paused","canceled","trialing"]},"remark":{"type":["string","null"]},"customer":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"}},"required":["id","email"]},"mode":{"type":"string"},"last4":{"type":"string"},"subscription_id":{"type":"string"},"product_id":{"type":"string"},"store_id":{"type":"string"},"billing_period_start":{"type":["string","null"]},"billing_period_end":{"type":["string","null"]},"cancel_at":{"type":["string","null"]},"trial_start":{"type":["string","null"]},"trial_end":{"type":["string","null"]},"units":{"type":"integer"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"product_name":{"type":"string"},"payment_method":{"type":"string"},"next_billing_amount":{"type":"number"},"recurring_interval":{"type":"string"}}}},"code":{"type":"integer"},"msg":{"type":"string"}},"required":["total","items","code","msg"]}}},"headers":{}}}}}}}
```

## GET /api/subscriptions/{subscription\_id}

> Get Subscription Detail

```json
{"openapi":"3.1.0","info":{"title":"BagelPay-SDK","version":"1.0.0"},"tags":[{"name":"Subscription"}],"servers":[{"url":"https://test.bagelpay.io","description":"Development env"}],"security":[],"paths":{"/api/subscriptions/{subscription_id}":{"get":{"summary":"Get Subscription Detail","deprecated":false,"description":"","tags":["Subscription"],"parameters":[{"name":"subscription_id","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"x-api-key","in":"header","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"msg":{"type":"string"},"code":{"type":"integer"},"data":{"type":"object","properties":{"status":{"type":"string"},"remark":{"type":["string","null"]},"customer":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"}},"required":["id","email"]},"mode":{"type":"string"},"last4":{"type":"string"},"subscription_id":{"type":"string"},"product_id":{"type":"string"},"store_id":{"type":"string"},"billing_period_start":{"type":["string","null"]},"billing_period_end":{"type":["string","null"]},"cancel_at":{"type":["string","null"]},"trial_start":{"type":["string","null"]},"trial_end":{"type":["string","null"]},"units":{"type":"integer"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"product_name":{"type":"string"},"payment_method":{"type":"string"},"next_billing_amount":{"type":"integer"},"recurring_interval":{"type":"string"}},"required":["status","remark","customer","mode","last4","subscription_id","product_id","store_id","billing_period_start","billing_period_end","cancel_at","trial_start","trial_end","units","created_at","updated_at","product_name","payment_method","next_billing_amount","recurring_interval"]}},"required":["msg","code","data"]}}},"headers":{}}}}}}}
```