BillingTopUp

One hosted top-up page and what has happened on it.

  • amount_in_cents
    Type: integer
    greater than:  
    0
    required

    The amount this top-up adds, in whole US cents.

  • checkout_session_id
    Type: string
    min length:  
    1
    max length:  
    512
    required

    Stripe's identifier for the hosted page.

  • credited
    Type: boolean
    required

    Whether the payment is in the balance. It can become true a few seconds after payment_status becomes paid.

  • expires_at
    Type: stringFormat: date-time
    required

    When the page stops accepting payment.

  • payment_status
    Type: BillingPaymentStatusenum
    required

    paid once the money is collected.

    values
    unpaidpaidno_payment_required
  • status
    Type: BillingTopUpStatusenum
    required

    open while the page accepts payment, complete after payment, expired when the page closed without payment.

    values
    opencompleteexpired
  • url
    Type: stringnullable

    Open this page to pay. Empty once the page is complete or expired.