Create Subscriptions

post

https://api.ksamerchant.geidea.net/subscriptions/api/v1/direct/subscription

This page will help you get started with Checkout - Subscription.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

recurringPaymentAmount

float

required

Defaults to 100

Subscription amount ex: 100.00

currency

string

required

Defaults to AED

The currency of the payment. This is a 3-digit alphabetic code, following the ISO 4217 currency code standard. For example: AED

cycleInterval

string

enum

required

Defaults to month

Frequency for which a subscription transaction must be executed.

Allowed:

cycleFrequency

int32

required

Defaults to 3

Number of times the subscription must be executed 1, 2, etc...

typeOfPayment

string

enum

required

Defaults to RecurringPayment

Indicates type of Recurring Payment. RecurringPayment: means subsequent payment will be auto-collected from the customer based on his first payment RecurringLink: means a payment link will be sent to the customer based on the cycle interval and frequency. The customer needs to be present every time to pay If you are using Geidea Session or direct API's then you can pass typeOfPayment" = 'RecurringPayment"& "isFirstPmtPBL":false and collect the first payment from the customer via HPP. The subsequent payments will be auto-collected from the customer based on the scheduled job

Allowed:

customerId

string

Defaults to aa6d9ce5-7441-4fff-7328-08dc3cbb2fe8

If you have already created a customer using the customerRequest object, you can pass it here. One of customerRequest Object or customerId is mandatory.

customerRequest

object

Details of the customer required to create a customer. Once a customer is created you can send the customer Id in all future subscription requests. One of customerRequest Object or customerId is mandatory.

description

string

The description of the subscription ex: TV channel plan A

startDate

string

Start date of subscription. Ex: "2024-03-05T09:26:07.472Z"

endDate

string

The end date of the subscription. For creating an endless subscription do not pass the endDate. For creating a subscription for a specific period, pass the endDate or numberOfPayments

numberOfPayments

string

The number of payments for the subscription. For creating an endless subscription do not pass the endDate. For creating a subscription for a specific period, pass the endDate or numberOfPayments

language

string

enum

Defaults to en

The language to be used on the checkout page.

Allowed:

isFirstPmtPBL

boolean

Defaults to true

Use this parameter as with value true or false depending upon how you would like to collect the first payment. If you pass this as true the customer will receive the first payment request as a payment link. If you are using Geidea Session or direct API's please pass the value as false. Default value will be true

paylinkExpirationPeriod

string

The payment link expiration date, is required only when the isFirstPmtPBL parameter is set to true. The default expiration period for the payment link is 7 days. If you want to use any cycle frequency less than 7 days, please make sure you are passing the expiration period accordingly.

timestamp

string

The timestamp of the moment at which the create subscription request has been initiated.

signature

string

required

A parameter to ensure the security and authenticity of API communications. It involves generating a signature using the contents of the API request and secret keys, which is then sent along with the request.

AmountVariability

string

enum

Defaults to VARIABLE

Indicates whether the subscription amount is fixed or changing during the subscription. If value is "FIXED" then the amount does not change during the subscription. If the value is "VARIABLE" then amount can be changed for the subscription. Note: If "FIXED" is used then "currency", "recurringPaymentAmount" and "cycleFrequency" can't be updated

Allowed:

Responses

200200

400400