PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List payments GETCreate a payment POSTGet a payment GETUpdate a payment PATCHRecord a purchase POSTReverse a purchase POST
Payments

Update a payment

A new `amount` on a completed payment posts a ledger adjustment and re-splits revenue share; `adjustmentNote` records why. `status: REFUNDED` on a completed payment runs the full refund (ledger, revenue share, plan access). Refunded payments accept only `note` and `paidAt`. Invoice payments cannot change `amount` (edit the invoice). `customerId` is locked once the payment granted a plan, paid an invoice, or posted to the ledger. Changing `amount` and refunding in one request is rejected. Omit `paidAt` to keep the payment's current paid date.

PATCH
/payments/{paymentId}

A new amount on a completed payment posts a ledger adjustment and re-splits revenue share; adjustmentNote records why. status: REFUNDED on a completed payment runs the full refund (ledger, revenue share, plan access). Refunded payments accept only note and paidAt. Invoice payments cannot change amount (edit the invoice). customerId is locked once the payment granted a plan, paid an invoice, or posted to the ledger. Changing amount and refunding in one request is rejected. Omit paidAt to keep the payment's current paid date.

Authorization

x-api-key<token>

In: header

Path Parameters

paymentId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/payments/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "string",    "amount": 0,    "status": "string",    "paidAt": "2019-08-24T14:15:22Z",    "note": "string",    "invoiceId": "string",    "currency": "string",    "source": "INVOICE",    "sourceLabel": "string",    "externalRef": "string",    "contactId": "string",    "opportunityId": "string",    "items": [      {        "name": "string",        "sku": "string",        "quantity": 0,        "unitAmount": 0      }    ],    "metaEventId": "string",    "metaSend": true,    "reversedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "customer": {      "id": "string",      "name": "string",      "email": "string",      "company": "string"    },    "invoice": {      "id": "string",      "invoiceNumber": "string"    },    "metaConversion": {      "id": "string",      "siteId": "string",      "paymentId": "string",      "eventName": "string",      "eventId": "string",      "contactId": "string",      "value": 0,      "currency": "string",      "eventTime": "2019-08-24T14:15:22Z",      "status": "QUEUED",      "skipReason": "string",      "reversed": true,      "attempts": 0,      "lastError": "string",      "sentAt": "2019-08-24T14:15:22Z",      "exportedAt": "2019-08-24T14:15:22Z"    }  }}

Get a payment GET

Previous Page

Record a purchase POST

Idempotent on `externalRef`. `201` when recorded, `200` when already recorded. Amount is integer minor units.

customerId?string
amount?integer
status?string
paidAt?string

When the money was received. ISO-8601 with seconds and an offset (Z or ±HH:MM), such as 2026-11-01T09:30:00Z. On create it defaults to now for a COMPLETED payment. On update, omit it to keep the current paid date. A value that is invalid or has no offset returns 400.

Formatdate-time
note?string
invoiceId?string
adjustmentNote?string

Reason for an amount change, kept in the payment's amount history.

Lengthlength <= 500