Skip to content
BoxBilling

Create checkout session

POST
/v1/payments/checkout

Create a checkout session for an invoice.

This creates a payment record and returns a URL where the customer can complete the payment.

Request Body required

Section titled “Request Body required ”
CheckoutSessionCreate

Schema for creating a checkout session.

object
invoice_id
required
Invoice Id
string format: uuid
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
provider
PaymentProvider

Payment provider to use (stripe, ucp, manual)

string
default: stripe
Allowed values: stripe manual ucp gocardless adyen

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

CheckoutSessionResponse

Schema for checkout session response.

object
payment_id
required
Payment Id
string format: uuid
checkout_url
required
Checkout Url
string
provider
required
Provider
string
expires_at
Any of:
string format: date-time

400

Section titled “400 ”

Only finalized invoices can be paid

401

Section titled “401 ”

Unauthorized – invalid or missing API key

404

Section titled “404 ”

Invoice not found

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

500

Section titled “500 ”

Failed to create checkout session

503

Section titled “503 ”

Payment provider not configured