Publish a value receipt | Paid

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

{
  "id": "vr_9f8b7c6d5e4a3b2c1d0e",
  "status": "published",
  "publicUrlToken": "abc123xyz789",
  "publicUrl": "https://value-receipts.agentpaid.io/public/abc123xyz789",
  "isPublished": true,
  "customerId": "cust_456def789abc123",
  "customerName": "Acme Corporation",
  "customerExternalId": "ACME-2024-001",
  "orderId": "ord_1234567890abcdef",
  "productId": "prod_9876543210fedcba",
  "currency": "USD",
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-01-31T23:59:59Z",
  "totalDeliveredValue": 12500.75,
  "archivedAt": "2024-02-15T12:00:00Z",
  "createdAt": "2024-01-15T09:30:00Z",
  "publishedAt": "2024-01-16T10:00:00Z",
  "publishExpiresAt": "2024-07-16T10:00:00Z",
  "allowEmbed": true
}

Make a value receipt publicly accessible via URL.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequired

Request

Body

publishExpiresAtdatetime or nullOptional

Response

200

idstring

statusstring

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

404

Not Found Error

500

Internal Server Error