value-receipts

Create a value receipt

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.

post/value-receipts/

Request

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

Request body

customerIdstring

Mutually exclusive with externalCustomerId. Exactly one is required.

externalCustomerIdstring

Mutually exclusive with customerId. Exactly one is required.

startDatestring date-time required
endDatestring date-time required
orderIdstring

Mutually exclusive with product. Provide at most one.

Response

201

idstring required
statusstring required

Always "posted".

publicUrlTokenstring required
publicUrlstring uri required
generatedAtstring date-time nullable

Changes

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