Confirm a usage charge
- Path
/partners/domains/usageRecords/confirm- Auth
- Partner token · partner server only
# $SIGNED_PAYLOAD: the request claims as a JWT signed with your private key, see https://releva.ai/documentation/reference/partners/overview/#authenticationcurl --request POST \ --url 'https://releva.ai/api/v0/partners/domains/usageRecords/confirm' \ --header 'content-type: application/json' \ --header "x-rlv-partner-token: $RELEVA_PARTNER_TOKEN" \ --data "{\"payload\": \"$SIGNED_PAYLOAD\"}"Tells Releva that a usage charge it sent to your usage webhook was collected. acceptedAmount (in the charge’s
currency) is capped at the charged amount; zero or less leaves the charge pending so Releva sends it again.
Repeating a confirm changes nothing. Only for partners with external billing.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
The request fields as JWT claims, signed with your RSA private key (RS512 recommended; RS256/384 and PS256/384/512
are also accepted) with a short expiry (expiresIn: '1h'). The operation’s x-signed-claims schema lists the
claims.
Example generated
{ "payload": "example"}Responses
Section titled “Responses”confirmed: true when the charge is (now or already) accepted, false when it stays pending.
object
Example generated
{ "confirmed": true}Partner token, shop lookup or billing mode error.
object
Human-readable error. Several validation errors are joined with a space.
Examples
{ "message": "Partner identification is missing!"}{ "message": "Partner identification is invalid!"}{ "message": "Domain with url demo-partner-internal.example.com cannot be found or you don't have access to it."}{ "message": "Partner Demo Partner Internal Billing it not allowed to use this API because it is not configured for external billing management. Actual value: internal"}No charge with this id for this shop (also for a missing or non-numeric id).
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "Unknown usage charge for this domain"}The payload could not be verified (missing, not a JWT, signed with another key, or expired), or another unexpected error.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "An internal error occurred."}