Create a value receipt | Paid

Creates a value receipt for a customer and date range, optionally scoped to a product or an order. Every call creates a receipt, so calling twice for the same period gives the customer two. The date range must have ended; a range with nothing delivered in it reports zero. Returns the receipt’s ID and public URL.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Request

Body

startDatedatetimeRequired

endDatedatetimeRequired

customerIdstringOptional>=1 character

Mutually exclusive with externalCustomerId. Exactly one is required.

externalCustomerIdstringOptional>=1 character

Mutually exclusive with customerId. Exactly one is required.

productobjectOptional

Mutually exclusive with orderId. Provide at most one.

orderIdstringOptional>=1 character

Mutually exclusive with product. Provide at most one.

Response

201

idstring

statusstring

publicUrlTokenstring

publicUrlstringformat: "uri"

generatedAtdatetime or nullOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	import { PaidClient } from "@paid-ai/paid-node";
2
3	async function main() {
4	const client = new PaidClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.valueReceipts.createValueReceipt({
8	startDate: new Date("2024-01-15T09:30:00Z"),
9	endDate: new Date("2024-01-15T09:30:00Z"),
10	});
11	}
12	main();

1	{
2	"id": "string",
3	"status": "string",
4	"publicUrlToken": "string",
5	"publicUrl": "string",
6	"generatedAt": "2024-01-15T09:30:00Z"
7	}