Preview a public server-calculated quote

POST/v2/public/quotes/preview

Header parameters

x-request-idstring

Optional caller-provided request correlation ID.

min length 1

Request body

requiredapplication/json

locatorstringrequired

min length 1 · max length 160

offerIdstring<uuid>required

formIdstring<uuid>

customAmountHalalasinteger

min 0 · max 9007199254740991

discountCodestring

max length 64 · matches ^[A-Z0-9_-]{1,64}$

Responses

200OK

quoteobject | anyrequired

Show properties

Any of:

object

offerIdstring<uuid>required

offerTypestringrequired

Allowed:one_timerecurringfreecustom

currencyanyrequired

subtotalHalalasintegerrequired

min 0 · max 9007199254740991

discountHalalasintegerrequired

min 0 · max 9007199254740991

taxableHalalasintegerrequired

min 0 · max 9007199254740991

vatRateBpsintegerrequired

min 0 · max 10000

vatHalalasintegerrequired

min 0 · max 9007199254740991

totalHalalasintegerrequired

min 0 · max 9007199254740991

customAmountHalalasinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

recurringTermsobject | anyrequired

Show properties

Any of:

object

cadenceobjectrequired

Show properties

intervalUnitstringrequired

Allowed:dayweekmonthyear

intervalCountintegerrequired

min -9007199254740991 · max 9007199254740991

trialDaysintegerrequired

min 0 · max 365

regularTotalHalalasintegerrequired

min 0 · max 9007199254740991

discountobject | anyrequired

Show properties

Any of:

object

durationstringrequired

Allowed:onceforeverrepeating

repeatingBillingCyclesinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

any

any

any

any

policyFingerprintstringrequired

matches ^[a-f0-9]{64}$

any

any

404Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

422Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

429Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

500Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

Request

curl -X POST "https://api.cipay.net/v2/public/quotes/preview" \
  -H "Content-Type: application/json" \
  -d '{
  "locator": "string",
  "offerId": "<uuid>",
  "formId": "<uuid>",
  "customAmountHalalas": 0,
  "discountCode": "string"
}'

const response = await fetch("https://api.cipay.net/v2/public/quotes/preview", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "locator": "string",
  "offerId": "<uuid>",
  "formId": "<uuid>",
  "customAmountHalalas": 0,
  "discountCode": "string"
})
});

Response

{
  "quote": {
    "offerId": "<uuid>",
    "offerType": "one_time",
    "currency": "SAR",
    "subtotalHalalas": 0,
    "discountHalalas": 0,
    "taxableHalalas": 0,
    "vatRateBps": 0,
    "vatHalalas": 0,
    "totalHalalas": 0,
    "customAmountHalalas": 0,
    "recurringTerms": {
      "cadence": {
        "intervalUnit": "day",
        "intervalCount": 0
      },
      "trialDays": 0,
      "regularTotalHalalas": 0,
      "discount": {
        "duration": "once",
        "repeatingBillingCycles": 0
      }
    },
    "policyFingerprint": "string"
  }
}