ValueReceipt
- allowType: boolean
Embed requiredWhether the receipt's page may be framed in another site's page (
shareUrlwithmode=embed).falsefor a new receipt; set it with Update a value receipt. - archivedType: string | nullFormat: date-time
At requiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- createdType: stringFormat: date-time
At requiredWhen the receipt was created and its figures frozen.
- currencyType: stringrequired
The receipt's currency:
product.currencywhen you asked for one, else the value model's. - customerType: string | null
External Id required - customerType: string
Id required - customerType: string | null
Name required - endType: stringFormat: date-time
Date requiredThe period's last moment, included.
- idType: stringrequired
- isType: boolean
Published requiredWhether the public link works now (published, and any expiry hasn't passed).
- orderType: string | null
Id requiredThe order the receipt is scoped to.
- productType: string | null
Id requiredThe product the receipt is scoped to (an order's plan product, for an order-scoped receipt).
- publicType: stringFormat: uri
Url requiredThe page your customer opens without signing in. It works only while
isPublishedis true. - publicType: string
Url Token requiredThe secret in the public link.
- publishedType: string | nullFormat: date-time
At requiredWhen the receipt was last published; null while unpublished.
- publishType: string | nullFormat: date-time
Expires At requiredWhen the public link stops working; null for no expiry.
- shareType: stringFormat: uri
Url requiredThe receipt as a page Spondo Billing renders, to link to or frame in your app. Anyone can open it while
isPublishedis true. While the receipt is private, it opens with atokenquery parameter: an HS256 JWT your backend signs with your receipt signing secret (which Rotate the receipt signing secret creates), withresourcevalue-receipt,subthe customer's Spondo Billing or external ID, anexp, and optionallyresourceId(this receipt's ID or token). Without one, the viewer is sent to your login URL, when you've set one with Update value receipt settings, with the page's address inredirect; otherwise the page says the receipt is private (401). An archived receipt answers 404. Addmode=embedto show it in an iframe, which only a receipt withallowEmbedpermits (set it with Update a value receipt); an embedded private receipt says it's private instead of redirecting. - startType: stringFormat: date-time
Date requiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- statusenumconst:readyrequired
Always
ready. - totalType: number
Delivered Value requiredThe value delivered in the period, as frozen. Decimal amount in major units of
currency.