Checkout API
- TypeScript
- Python
- Go
- cURL
Endpoints
POST /v1/checkout/sessionsGET /v1/checkout/sessions/{sessionId}
POST /v1/checkout/sessions
Scopes:write or checkout:writeIdempotency-Key: required Request - one-time payment
modeenum required:payment | subscription | creditscustomerIdstring conditional (required if noexternalCustomerId)externalCustomerIdstring conditional (required if nocustomerId)productIdstring conditional (required forpaymentandsubscription)amountstring conditional (required forcredits)currencyenum conditional:BRL | USDC(required whenamountis set)successUrlstring optionalcancelUrlstring optionalmetadataobject optional
201
404 customer_not_found no customer found with the provided id404 product_not_found no product found with the provided id
GET /v1/checkout/sessions/
Scopes:read
Response 200
open: waiting for paymentpaid: payment confirmedexpired: expired without paymentcanceled: canceled