Subscriptions

Handle subscription creation and listing for customers

Get Subscriptions

Retrieve a list of subscriptions

Query Parameters

Content-Type

string

x-kc-token

string

Response

Successful request, returns subscription list

data

array

GET /subscriptions

Response Example

{
  "data": [
    {
      "id": "347aaf81-40bf-4ff3-9902-0ea5d40b4f21",
      "user_created": "caa870ba-2752-4e64-92e5-18dc7122afda",
      "date_created": "2025-03-06T05:46:12.576Z",
      "status": "published",
      "date_updated": null,
      "user_updated": null,
      "product": "48ee7ff6-dc73-48b5-9775-76a43e9dbf06",
      "customer": "ee509335-8b43-4d59-ad02-95f5b1fbd51e",
      "cycle_end_date": null,
      "cycle_start_date": null,
      "next_billing_date": null,
      "auto_renew": false,
      "discount_coupon": null,
      "trial_end_date": null,
      "selected_billing_cycle": "months-1",
      "selected_currency": "KES"
    }
  ]
}

Create Subscription

Initiate a new subscription for a customer

Query Parameters

Content-Type

string

x-kc-token

string

x-idempotency-id

string

Request Body

customer

string

product

string

selected_currency

string

selected_billing_cycle

string

trial_end_date

string

auto_renew

boolean

Response

Subscription created successfully

data

array

POST /subscriptions

Response Example

{
  "data": [
    {
      "id": "347aaf81-40bf-4ff3-9902-0ea5d40b4f21",
      "user_created": "caa870ba-2752-4e64-92e5-18dc7122afda",
      "date_created": "2025-03-06T05:46:12.576Z",
      "status": "published",
      "date_updated": null,
      "user_updated": null,
      "product": "48ee7ff6-dc73-48b5-9775-76a43e9dbf06",
      "customer": "ee509335-8b43-4d59-ad02-95f5b1fbd51e",
      "cycle_end_date": null,
      "cycle_start_date": null,
      "next_billing_date": null,
      "auto_renew": false,
      "discount_coupon": null,
      "trial_end_date": null,
      "selected_billing_cycle": "months-1",
      "selected_currency": "KES"
    }
  ]
}