Checkout

allowedCurrencies
Type: array of string
required

The currencies the customer can buy in, as ISO 4217 codes; the checkout's currency when set.
cancelUrl
Type: string | nullFormat: uri
required
collectAddress
Type: boolean
required
collectPhone
Type: boolean
required
createdAt
Type: stringFormat: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
customCards
Type: array of object
required
Properties: 1
customerId
Type: string | null
required

The customer the checkout is for, or null when the customer gives their details on the page.
expiresAt
Type: stringFormat: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
externalCustomerId
Type: string | null
required

Your ID for that customer.
id
Type: string
required

The checkout's Spondo Billing ID.
metadata
Type: nullable
required

Your own key-value data, kept with the record and returned as sent.

Properties: 1
products
Type: array of object
required

The products and plans on offer, as sent.

Properties: 2
singleUse
Type: boolean
required
status
Type: enum
required

active: the link can be used. completed: a single-use checkout whose order has started (paid on Stripe, or started on an invoice). expired: past expiresAt. archived: closed by you.

values
activecompletedexpiredarchived
successMessage
Type: string | null
required
successTitle
Type: string | null
required
successUrl
Type: stringFormat: uri
required
updatedAt
Type: stringFormat: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
url
Type: stringFormat: uri
required

The link to send your customer. When Stripe is connected and a single-use checkout for a known customer offers one plan: a Stripe Checkout page that can be paid until expiresAt or for 23.5 hours from when it was made, whichever is sooner. Otherwise your hosted checkout page on billing.getspondo.com, where the customer picks a plan and pays on Stripe or starts on an invoice.

CheckoutInput

CheckoutSelectedProduct