ValueReceiptSummary

  • the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • When the receipt was created and its figures frozen.

  • The receipt's currency: product.currency when you asked for one, else the value model's.

  • The period's last moment, included.

  • Whether the public link works now (published, and any expiry hasn't passed).

  • The order the receipt is scoped to.

  • The product the receipt is scoped to (an order's plan product, for an order-scoped receipt).

  • The page your customer opens without signing in. It works only while isPublished is true.

  • The secret in the public link.

  • The receipt as a page Spondo Billing renders, to link to or frame in your app. Anyone can open it while isPublished is true. While the receipt is private, it opens with a token query parameter: an HS256 JWT your backend signs with your receipt signing secret (which Rotate the receipt signing secret creates), with resource value-receipt, sub the customer's Spondo Billing or external ID, an exp, and optionally resourceId (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 in redirect; otherwise the page says the receipt is private (401). An archived receipt answers 404. Add mode=embed to show it in an iframe, which only a receipt with allowEmbed permits (set it with Update a value receipt); an embedded private receipt says it's private instead of redirecting.

  • the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • Always ready.

  • The value delivered in the period, as frozen. Decimal amount in major units of currency.