Skip to main content
PATCH
Accept a payment

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

id
string
required

ProductPayment identifier

Body

application/merge-patch+json

The updated ProductPayment resource

currency
string | null
commentByUser
string | null
commentStatus
string | null

Response

ProductPayment resource updated

id
integer
read-only
product
object | null
subscriptionProfile
object | null
amount
number
periodStart
string<date-time> | null
periodEnd
string<date-time> | null
stripeInvoiceId
string | null
stripePaymentId
string | null
isRefunded
boolean | null
contact
object | null
user
object | null
price
object | null
manualFeePayment
object | null
stripePaymentDate
string<date-time> | null
status
string
default:open
acceptedDate
string<date-time> | null
uid
string | null
currency
string | null
isPublic
boolean | null
identityReminderSent
boolean | null
productOption
object | null
dateCreated
string<date-time> | null
read-only
identity
object | null
localCenterOption
object | null
identityReminder2Sent
boolean | null
identityReminder3Sent
boolean | null
commentByUser
string | null
commentStatus
string | null
invoice
object | null
quantity
integer
default:1
quantityRefunded
integer
default:0
voucherCode
string | null