Publish a value receipt

POST

https://api.agentpaid.io/api/v2/value-receipts/:id/publish

POST

/api/v2/value-receipts/:id/publish

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.valueReceipts.publishValueReceipt({
        id: "id",
    });
}
main();

{
  "id": "string",
  "status": "string",
  "publicUrlToken": "string",
  "publicUrl": "string",
  "isPublished": true,
  "customerId": "string",
  "customerName": "string",
  "customerExternalId": "string",
  "orderId": "string",
  "productId": "string",
  "currency": "string",
  "startDate": "2024-01-15T09:30:00Z",
  "endDate": "2024-01-15T09:30:00Z",
  "totalDeliveredValue": 1.1,
  "archivedAt": "2024-01-15T09:30:00Z",
  "createdAt": "2024-01-15T09:30:00Z",
  "publishedAt": "2024-01-15T09:30:00Z",
  "publishExpiresAt": "2024-01-15T09:30:00Z",
  "allowEmbed": true
}

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.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequired

Request

Body

publishExpiresAtdatetime or nullOptional

When the public link stops working. Must be in the future, or the request fails with 409. Omit or set null for a link that does not expire.

Response

200

idstring

statusstring

Always “posted”: a value receipt is immutable from creation.

publicUrlTokenstring

publicUrlstringformat: "uri"

isPublishedboolean

customerIdstring or null

customerNamestring or null

customerExternalIdstring or null

orderIdstring or null

productIdstring or null

currencystring

startDatedatetime or null

endDatedatetime or null

totalDeliveredValuedouble or null

archivedAtdatetime or null

createdAtdatetime

publishedAtdatetime or null

publishExpiresAtdatetime or null

allowEmbedboolean

Errors

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error