value-receipts

Unpublish a value receipt

Revoke public access to a value receipt. Available for archived receipts too, so a live link can always be revoked.

post/value-receipts/{id}/unpublish

Request

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

Path parameters

idstring required

Request body

object required

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.