Create a subscription

Subscribe a customer to a template. Most merchants let customers subscribe through a subscription link instead.

  1. Call Preview a billing schedule with the template's details.
  2. Send the returned bills as schedules, with the template's fields.

The response id is the customer's subscription key; their page is https://sadadpay.net/subscription/payment/{key}.

🚧

freeTrialPeriod and freeTrialPosition must have valid values (for example Monthly and End) even when freeTrialNo is 0.

Errors

errorKeyCause
VendorIdRequiredvendor_Id is missing
SubscriptionScheduleRequiredschedules is missing
WrongFreeTrialPeriodfreeTrialPeriod is empty or not valid
WrongFreeTrialPositionfreeTrialPosition is empty or not valid
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

Your SADAD Pay vendor ID.

integer
required

The package template ID.

string

The template name, shown to the customer.

string

The customer's name.

string

The customer's mobile number, digits only.

string

The customer's email address.

string

Payment page language: en or ar.

string

How to send the link: SMS or Email.

string

Currency code. Use KWD.

number

Amount in KWD, up to 3 decimal places.

string

First due date (yyyy-MM-dd).

boolean

Renew the package automatically.

integer
string
integer
string
integer
string
string
integer
boolean
integer

Fee charged if the customer cancels.

boolean
integer
integer
schedules
array of objects
required

Every payment: one Down item (if any) plus installment_Count Schedule items.

schedules*
Responses

isValid: validation errors also return HTTP 200 with isValid: false.

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json