invoicestring nullable
Invoice ID this payment applies to.
subscriptionstring nullable
Subscription ID when generated by a subscription cycle.
balancenumber
Remaining balance to charge against this payment.
payment_datestring date-time nullable
Effective date the payment was completed.
descriptionstring required
sourceinteger nullable
Primary source ID. (Legacy single source link.)
sourcesinteger[]
All source IDs linked to this payment (multi-source support).
status'cancelled' | 'failed' | 'incomplete' | 'processing' | 'requires_payment_method' | 'succeeded'
failed_reasonstring nullable
Reason code when status=failed.
return_urlstring uri nullable
URL the payer is sent back to after a redirect-flow checkout.
enable_checkoutboolean
Whether the publishable checkout /pay/ is reachable for this payment.