Create a subscription cancellation invoice

Create the invoice for a subscription's cancellation fee. Use the customer's subscription key. The invoice type is SubscriptionCancel.

If an unpaid cancellation invoice already exists, the same invoice is returned and its amount is changed to the new totalAmount.

🚧

totalAmount is not checked against the template's cancelFees. Send the fee from the template.

Errors

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

The customer's subscription key, from /subscription/payment/{key}.

string
required

The customer's name.

string
required

The customer's mobile number, digits only.

string
required

The customer's email address.

string

Payment page language: en or ar.

number
required

Total in KWD. Must equal the sum of the items, where items are sent.

string
required

Currency code. Use KWD.

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