API
Get Started

Update an order

patch
https://api.clakta.com/v1/orders/{orderId}

Update the status and/or payment method of an existing order. `orderId` is your own order ID — the value sent as `orderId` when the order was created — and the owning project is resolved from the `projectId` field in the request body.

Marking an order as `refunded` stamps its refund date the first time it happens; an existing refund date is never overwritten.

Authentication

Send your API key as a bearer token in the Authorization header.

See Authentication for how to create and scope an API key.

Path parameters

orderIdstringrequired

The order ID in your own system.

Bodyapplication/json

projectIdstringrequired

The project ID (e.g. proj_xxx) or slug that owns the order

statusenum<string>optional

The new order status (e.g. refunded)

Allowed values:paidpendingrejectedrefundedcanceled

paymentMethodenum<string>optional

The new payment method

Allowed values:credit_carddebit_cardpixboletopaypalapple_paygoogle_paysamsung_paystripe_link

Response

The updated order

messagestringrequired

A confirmation message.

dataobjectrequired