Sign in

v1

latestOpenAPI 3.0.32026-07-26618696.8 KB
Subscriptions

Create Subscriptions plans

post/api/v1/subscriptions-plans/

Request body

namestring required
plan_idstring required
frequencyinteger required
frequency_unit'D' | 'W' | 'M' | 'Y'
  • D - day
  • W - week
  • M - month
  • Y - year
billing_cyclesinteger

How many times should we bill the customer

currency'KES' | 'GHS' | 'NGN' | 'UGX' | 'TZS' | 'XAF' | 'XOF' required

Supported currencies:

  • KES - Kenyan Shilling (KE)
  • GHS - Ghanaian Cedi (GH)
  • NGN - Nigerian Naira (NG)
  • UGX - Ugandan Shilling (UG)
  • TZS - Tanzanian Shilling (TZ)
  • XAF - Central African CFA Franc (CM)
  • XOF - West African CFA Franc (BF, CI)
amountstring decimal required
referencestring nullable

Third-party/Internal reference ID

plan_urlstring required
redirect_urlstring uri nullable

Redirect your customer after successful payment

created_atstring date-time nullable required
updated_atstring date-time nullable required

Response

namestring required
plan_idstring required
frequencyinteger required
frequency_unit'D' | 'W' | 'M' | 'Y'
  • D - day
  • W - week
  • M - month
  • Y - year
billing_cyclesinteger

How many times should we bill the customer

currency'KES' | 'GHS' | 'NGN' | 'UGX' | 'TZS' | 'XAF' | 'XOF' required

Supported currencies:

  • KES - Kenyan Shilling (KE)
  • GHS - Ghanaian Cedi (GH)
  • NGN - Nigerian Naira (NG)
  • UGX - Ugandan Shilling (UG)
  • TZS - Tanzanian Shilling (TZ)
  • XAF - Central African CFA Franc (CM)
  • XOF - West African CFA Franc (BF, CI)
amountstring decimal required
referencestring nullable

Third-party/Internal reference ID

plan_urlstring required
redirect_urlstring uri nullable

Redirect your customer after successful payment

created_atstring date-time nullable required
updated_atstring date-time nullable required