Skip to content
BoxBilling

Create setup session

POST
/v1/payment_methods/setup

Create a setup session for saving payment details.

Request Body required

Section titled “Request Body required ”
SetupSessionCreate
object
customer_id
required
Customer Id
string format: uuid
success_url
required
Success Url

URL to redirect after successful setup

string
cancel_url
required
Cancel Url

URL to redirect if setup is canceled

string
provider
PaymentProvider

Payment provider to use

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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

SetupSessionResponse
object
setup_id
required
Setup Id
string
setup_url
required
Setup Url
string
provider
required
Provider
string
expires_at
Any of:
string format: date-time

401

Section titled “401 ”

Unauthorized – invalid or missing API key

404

Section titled “404 ”

Customer 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

501

Section titled “501 ”

Provider does not support setup sessions

503

Section titled “503 ”

Payment provider not configured