Skip to main content

Refund a Product

DELETE 
/order/:guid/products/:order_product_guid/return
deprecated

Refund a Product. This endpoint has been replaced by DELETE /order/{guid}/custom_refund.

Request​

Path Parameters

    guid stringrequired

    The guid of the Order.

    order_product_guid stringrequired

    The guid of the Product of the Order.

Body

Input data

    comment stringrequired

    Possible values: non-empty and <= 255 characters

    A comment for the Refund.

    includes_fees booleanrequired

    Whether to include the services fees.

Responses​

Product refunded successfully. This returns an empty response.

Schema

    fatals

    object

    subjectType stringrequired

    The type of object which throws the fatal, error or notice.

    guid stringrequired

    The guid of the object which threw the fatal, error or notice.

    reservation string

    In the case the error is about reservation, this will be the reservation key of the object that was used.

    reason string

    The reason why the fatal, error or notice occurred.

    extra object

    Potentially some extra information about the fatal, error or notice.

    parentOf object

    This is the child error and has the same schema as this schema. It recurses on every child fatal, error or notice that gets added.

    errors

    object

    subjectType stringrequired

    The type of object which throws the fatal, error or notice.

    guid stringrequired

    The guid of the object which threw the fatal, error or notice.

    reservation string

    In the case the error is about reservation, this will be the reservation key of the object that was used.

    reason string

    The reason why the fatal, error or notice occurred.

    extra object

    Potentially some extra information about the fatal, error or notice.

    parentOf object

    This is the child error and has the same schema as this schema. It recurses on every child fatal, error or notice that gets added.

    notices

    object

    subjectType stringrequired

    The type of object which throws the fatal, error or notice.

    guid stringrequired

    The guid of the object which threw the fatal, error or notice.

    reservation string

    In the case the error is about reservation, this will be the reservation key of the object that was used.

    reason string

    The reason why the fatal, error or notice occurred.

    extra object

    Potentially some extra information about the fatal, error or notice.

    parentOf object

    This is the child error and has the same schema as this schema. It recurses on every child fatal, error or notice that gets added.

    redirectUrl string

    The redirect URL to where the user should continue.

    amount float

    In case this field is returned, it is the amount of the created Order in cents.

    order_id string

    The guid of the created Order.

Loading...