Subscription

Cancel Subsctipion

post

Path parameters

subscription_idstringRequiredExample: sub_1965979949183705090

Header parameters

x-api-keystringRequiredExample: bagel_test_2A9B6B2438D1473F88ACB8F8128FE5B3

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/subscriptions/{subscription_id}/cancel HTTP/1.1
Host: test.bagelpay.io
x-api-key: text
Accept: */*

200Success

{
  "msg": "Operation successful",
  "code": 200,
  "data": {
    "status": "canceled",
    "remark": null,
    "customer": {
      "id": "1965991816266428417",
      "email": "[e-mail]"
    },
    "mode": "test",
    "last4": "4242",
    "subscription_id": "sub_1965991816836853761",
    "product_id": "prod_1965974356351971329",
    "store_id": "store_1965741114843643906",
    "billing_period_start": "2025-09-11 12:12:24",
    "billing_period_end": "2025-09-12 12:12:24",
    "cancel_at": "2025-09-11 18:58:43",
    "trial_start": null,
    "trial_end": null,
    "units": 1,
    "created_at": "2025-09-11 12:12:29",
    "updated_at": "2025-09-11 12:12:29",
    "product_name": "Test-sub",
    "payment_method": "card",
    "next_billing_amount": 1212,
    "recurring_interval": "daily"
  }
}

List Subscriptions

get

Query parameters

pageNuminteger · min: 1OptionalExample: 1

pageSizeinteger · min: 1OptionalExample: 10

Header parameters

x-api-keystringRequiredExample: bagel_test_2A9B6B2438D1473F88ACB8F8128FE5B3

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/subscriptions/list HTTP/1.1
Host: test.bagelpay.io
x-api-key: text
Accept: */*

200Success

{
  "total": 3,
  "items": [
    {
      "status": "active",
      "remark": null,
      "customer": {
        "id": "1965991816266428417",
        "email": "[e-mail]"
      },
      "mode": "test",
      "last4": "4242",
      "subscription_id": "sub_1965991816836853761",
      "product_id": "prod_1965974356351971329",
      "store_id": "store_1965741114843643906",
      "billing_period_start": "2025-09-11 12:12:24",
      "billing_period_end": "2025-09-12 12:12:24",
      "cancel_at": null,
      "trial_start": null,
      "trial_end": null,
      "units": 1,
      "created_at": "2025-09-11 12:12:29",
      "updated_at": "2025-09-11 12:12:29",
      "product_name": "Test-sub",
      "payment_method": "card",
      "next_billing_amount": 1212,
      "recurring_interval": "daily"
    }
  ],
  "code": 200,
  "msg": "success"
}

Get Subscription Detail

get

Path parameters

subscription_idstringRequired

Header parameters

x-api-keystringRequiredExample: bagel_test_C8E5592161034DE1980D50073923B3DC

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/subscriptions/{subscription_id} HTTP/1.1
Host: test.bagelpay.io
x-api-key: text
Accept: */*

200Success

{
  "msg": "Operation successful",
  "code": 200,
  "data": {
    "status": "trialing",
    "remark": null,
    "customer": {
      "id": "1965976681443401730",
      "email": "[e-mail]"
    },
    "mode": "test",
    "last4": "",
    "subscription_id": "sub_1965976681980272642",
    "product_id": "prod_1965974356351971329",
    "store_id": "store_1965741114843643906",
    "billing_period_start": null,
    "billing_period_end": null,
    "cancel_at": null,
    "trial_start": "2025-09-11 11:12:19",
    "trial_end": "2025-09-20 11:12:19",
    "units": 1,
    "created_at": "2025-09-11 11:12:21",
    "updated_at": "2025-09-11 11:12:21",
    "product_name": "Test-sub",
    "payment_method": "",
    "next_billing_amount": 1212,
    "recurring_interval": "daily"
  }
}