Pay an outstanding invoice
POST
/portal/invoices/{invoice_id}/pay
Create a checkout session to pay an outstanding invoice.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” invoice_id
required
Invoice Id
string format: uuid
Query Parameters
Section titled “Query Parameters ” token
required
Token
string
Request Body required
Section titled “Request Body required ” PortalPayNowRequest
Request to initiate payment for an invoice.
object
success_url
required
Success Url
URL to redirect after successful payment
string
cancel_url
required
Cancel Url
URL to redirect if payment is canceled
string
Responses
Section titled “ Responses ”Successful Response
PortalPayNowResponse
Response with checkout URL for paying an invoice.
object
payment_id
required
Payment Id
string format: uuid
checkout_url
required
Checkout Url
string
provider
required
Provider
string
invoice_id
required
Invoice Id
string format: uuid
amount
required
Amount
string
currency
required
Currency
string
Only finalized invoices can be paid
Invalid or expired portal token
Invoice not found
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Payment provider not configured