Create a package template

Create a package plan.

packageTypeMeaning
CountBasedThe customer gets itemCount uses, for example 10 car washes
CostBasedThe package is based on an amount rather than a number of uses

price is what the customer pays. priceBeforeDiscount and discount show the saving. features are the bullet points shown to customers.

🚧

Only vendor_Id, name_En and name_Ar are checked. Always send price, packageType and the dates too: a template without them is still created.

Errors

errorKeyCause
VendorIdRequiredvendor_Id is missing
NameRequiredname_En or name_Ar is missing
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

Your SADAD Pay vendor ID.

string
required

English name.

string
required

Arabic name.

string

English description.

string

Arabic description.

string

Currency code. Use KWD.

number

Price of one unit, in KWD.

number

Price before the discount, in KWD.

integer

Discount, in KWD.

string

CountBased or CostBased.

integer

Number of uses, for a CountBased package.

string

First due date (yyyy-MM-dd).

string

Last day of the package (yyyy-MM-dd).

boolean

Renew the package automatically.

boolean

Internal use only.

integer

Fee charged if the customer cancels.

boolean

true to hide it without deleting.

features
array of objects

Bullet points shown to customers.

features
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