value-receipts

Publish a value receipt

Make a value receipt publicly accessible via URL. An archived receipt is rejected with 409 — unarchive it first. So is one with no content, which has nothing to show.

post/value-receipts/{id}/publish

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/value-receipts/{id}/publish
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

publishExpiresAtstring date-time nullable

Response

200

idstring required
statusstring required

Always "posted": a value receipt is immutable from creation.

publicUrlTokenstring required
publicUrlstring uri required
isPublishedboolean required
customerIdstring nullable required
customerNamestring nullable required
customerExternalIdstring nullable required
orderIdstring nullable required
productIdstring nullable required
currencystring required
startDatestring date-time nullable required
endDatestring date-time nullable required
totalDeliveredValuenumber double nullable required
archivedAtstring date-time nullable required
createdAtstring date-time required
publishedAtstring date-time nullable required
publishExpiresAtstring date-time nullable required
allowEmbedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.