Skip to main content

Cancel an order

POST 
/v1/orders/:id/cancel

This is to allow developers to trigger and test the 'order.cancelled' webhook event in test environments. This operation will return a 403 response in production.

Request​

Path Parameters

    id integerrequired

    The ID of the order to cancel

Body

Context of the cancellation

    reason string

    Why are you cancelling this order?

Responses​

OK

Schema
    order object

    An order for an insurance product

    id integer

    The unique ID of the order.

    status string

    the current status of the order.

    amount_due float

    the amount due for payment by partner, excluding the partner's commission

    policy_start_date date

    The date when the policy coverage is due to start

    asset_ref string

    An optional identifier for the asset the insurance covers. You may set this to a value that uniquley identifies the asset on your database.

    currency string

    The currency of all monetary parameters.

    channel string

    The channel through which the order was made.

    created_at date
    payment_made_at date
    payment_method string

    The method of payment used for the order.

    product object

    An individual insurance product or plan

    title string

    The name of the product

    code string

    The unique identifier for technical purposes

    id integer

    Unique Id of the product.

    insurer object

    An insurance provider

    code string

    The unique code of the insurer

    name string

    The name of the insurer

    logo_url string

    A link to the Insurer's logo

    terms_conditions string

    Insurer's terms and conditions

    product type object

    A major category of insurance e.g Health, Automobile, Life, Gadget, Goods in transit, etc

    name string

    The generally accepted human friendly name

    slug string

    The unique identifier for technical purposes

    cover-benefits object

    list of the nefits covered.

    created-at string

    Date of product creation

    price integer

    Price of product

    premium-type string

    Define the product premium tier.

    premium-rate-unit integer
    premium-rate number
    premium number
    partner-commision-rate number
    min-premium string
    premium-rules string
    premium_frequency string

    Possible values: [monthly, quarterly, annually]

    Default value: annually

    customer object

    The the customer's information

    ref stringrequired

    Unique identifier for the customer on your system

    email stringrequired

    The customer's email address

    phone string
    first_name stringrequired
    last_name stringrequired
    policy object

    The policy for which the order was made.

Loading...