curl --request POST \
  --url https://commet.co/api/v1/payments/{id}/cancel \
  --header 'x-api-key: <api-key>'

import { Commet } from "@commet/node";

const commet = new Commet({ apiKey: "ck_xxx" });

const payment = await commet.payments.cancel({ id: "pay_xxx" });

from commet import Commet

commet = Commet("ck_xxx")

payment = commet.payments.cancel("pay_xxx")

client, err := commet.New("ck_xxx")
if err != nil {
	log.Fatal(err)
}
ctx := context.Background()

payment, err := client.Payments.Cancel(ctx, "pay_xxx", nil)
if err != nil {
	log.Fatal(err)
}

import co.commet.Commet;
import co.commet.params.CancelPaymentParams;

var commet = Commet.builder().apiKey("ck_xxx").build();

var payment = commet.payments().cancel("pay_xxx", CancelPaymentParams.builder().build());

use Commet\Commet;

$commet = new Commet('ck_xxx');

$payment = $commet->payments->cancel(id: 'pay_xxx');

{
  "id": "pay_1a2b3c4d",
  "customerId": "cus_1a2b3c4d",
  "kind": "link",
  "status": "canceled",
  "provider": "commet",
  "amountSubtotal": 2000,
  "taxAmount": 0,
  "amountTotal": 2000,
  "currency": "usd",
  "description": "Onboarding session",
  "metadata": {},
  "url": null,
  "expiresAt": "2026-09-07T13:00:00.000Z",
  "createdAt": "2026-09-07T12:00:00.000Z",
  "updatedAt": "2026-09-07T12:00:00.000Z",
  "object": "payment",
  "livemode": false,
  "paymentContext": {
    "reason": "one_time_payment",
    "paymentLinkId": "pay_1a2b3c4d",
    "recovery": null
  }
}

{
  "error": {
    "type": "validation_error",
    "code": "validation_error",
    "message": "The request contains an invalid parameter.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "unauthorized",
    "message": "A valid API key is required.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "forbidden",
    "message": "You do not have permission to perform this operation.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md"
  }
}

{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "The requested resource was not found.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/not_found.md"
  }
}

{
  "error": {
    "type": "conflict_error",
    "code": "idempotency_in_progress",
    "message": "A request with this idempotency key is still being processed.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_in_progress.md"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Too many requests. Retry after the interval specified in the Retry-After header.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md"
  }
}

{
  "error": {
    "type": "internal_error",
    "code": "internal_error",
    "message": "An unexpected error occurred while processing the request.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md"
  }
}

{
  "error": {
    "type": "internal_error",
    "code": "idempotency_unavailable",
    "message": "Idempotency storage is temporarily unavailable. Retry with the same idempotency key.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_unavailable.md"
  }
}