{"openapi":"3.1.0","info":{"title":"Orboni API","version":"v1","summary":"Non-custodial crypto payments: checkout sessions, payment links, refunds and signed webhooks.","description":"Orboni is a non-custodial crypto payment gateway: the buyer pays straight into the merchant\u2019s own wallet, and Orboni holds no funds and no private keys. It watches the chain and tells the merchant\u2019s server, by a signed webhook, when a payment is final. Test mode is free (test payments are never billed) and needs no paperwork to start.\n\nA REST API in the shape of Stripe\u2019s: prefixed IDs (`cs_live_\u2026`, `evt_\u2026`, `re_\u2026`, `plink_\u2026`), amounts in the currency\u2019s smallest unit, form-encoded or JSON bodies, cursor-paged lists, `Idempotency-Key` on POSTs and errors as `{\"error\": {\"type\", \"message\", \"param\"}}`. Form-encoded bodies name arrays and objects PHP-style: `payment_methods[]=btc`, `metadata[order]=1042`.\n\n**Money.** A price (`amount`, `amount_total`, a refund\u2019s `amount`, a payment link\u2019s amounts) is an integer in the currency\u2019s smallest unit \u2014 cents for usd, whole yen for jpy. The other sums of a checkout session (`amount_received`, `amount_due`, `amount_remaining`, `*_usd`, a transaction\u2019s `amount`) are decimal strings, as `\"24.90\"`, never floats. A coin amount is a decimal string with the coin\u2019s own decimals. A price must be worth $1 to $100,000 at the day\u2019s exchange rate.\n\n**Limits.** 600 requests a minute per project and mode, 1200 per account (every project and mode together), and of those 120 POSTs with test keys; beyond it `429 rate_limit_error` with `Retry-After`. Answers carry `X-RateLimit-Limit` and `X-RateLimit-Remaining`. Request bodies are at most 64 KB. An address that is no endpoint of the API answers `404 invalid_request_error` (\u201cUnrecognized request URL\u201d), a wrong method on a path too.","termsOfService":"https://orboni.com/page/terms-of-service","contact":{"name":"Orboni support","email":"support@orboni.com","url":"https://orboni.com/docs"},"license":{"name":"Proprietary","url":"https://orboni.com/page/terms-of-service"}},"externalDocs":{"description":"The API reference","url":"https://orboni.com/docs"},"servers":[{"url":"https://orboni.com/v1","description":"Live and test mode alike: the key decides which."}],"security":[{"secretKey":[]},{"secretKeyBasic":[]}],"tags":[{"name":"Checkout Sessions","description":"A checkout session is one payment you wait for: a price that the buyer pays in any coin your project takes, on a page Orboni hosts (`url`). Fulfil the order on `checkout.session.completed`.","externalDocs":{"url":"https://orboni.com/docs#sessions"}},{"name":"Payment Methods","description":"The coins and networks a session of this project would offer now, from its wallets.","externalDocs":{"url":"https://orboni.com/docs#methods"}},{"name":"Currencies","description":"The fiat currencies a price may be set in, and the exchange rate a session would be priced at now.","externalDocs":{"url":"https://orboni.com/docs#currencies"}},{"name":"Refunds","description":"A refund is a record: Orboni never holds the money, so the merchant sends the coins back from its own wallet, then records it here, and the session, reports and a `refund.created` webhook follow.","externalDocs":{"url":"https://orboni.com/docs#refunds"}},{"name":"Payment Links","description":"A reusable link (`/l/plink_\u2026`) that opens a checkout session of its own for each buyer. Never deleted: `active=false` switches one off.","externalDocs":{"url":"https://orboni.com/docs/payment-links"}},{"name":"Events","description":"Everything sent to the webhooks is kept as an event, so a server that was down longer than the retries can catch up, and any event can be sent again.","externalDocs":{"url":"https://orboni.com/docs#events"}},{"name":"Webhooks","description":"What Orboni POSTs to the endpoints set under Developers \u2192 Webhooks, signed in `Webhook-Signature`.","externalDocs":{"url":"https://orboni.com/docs/webhooks"}}],"paths":{"/checkout/sessions":{"post":{"operationId":"createCheckoutSession","tags":["Checkout Sessions"],"summary":"Create a checkout session","description":"Makes a payment to wait for and answers it with `status` `open` and the `url` of its payment page: send the buyer there. They pick a coin on the page; you never handle addresses or rates. A price in another currency than usd is turned into US dollars once, now, at the day\u2019s rate (`exchange_rate`). An account holds at most 1000 open live sessions and 200 open test ones at once, all its projects together (payment links\u2019 sessions not counted); past that this answers `429 rate_limit_error` with `Retry-After` until some complete, run out or are expired. Send an `Idempotency-Key` to retry safely: a successful answer is kept for 24 hours and a retry with the same key gets it again (`Idempotent-Replayed: true`) instead of acting twice.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"description":"JSON, or form-encoded with arrays and objects PHP-style (`payment_methods[]=btc`, `metadata[order]=1042`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCheckoutSessionRequest"},"example":{"amount":2490,"currency":"usd","success_url":"https://shop.example/thanks?session={CHECKOUT_SESSION_ID}","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","customer_email":"buyer@example.com","description":"Pro plan","metadata":{"order_id":"1042"}}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/CreateCheckoutSessionRequest"}}}},"responses":{"201":{"description":"The session, open.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutSession"},"example":{"id":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","object":"checkout.session","livemode":true,"status":"open","payment_status":"unpaid","amount_total":2490,"currency":"usd","exchange_rate":null,"amount_received":"0.00","amount_due":"24.90","amount_remaining":"24.90","amount_due_usd":"24.90","amount_received_usd":"0.00","amount_refunded":0,"payment_methods":[],"payment":null,"url":"https://orboni.com/pay/cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","success_url":"https://shop.example/thanks?session=cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","payment_link":null,"customer_email":"buyer@example.com","customer_email_collection":"required","locale":"auto","description":"Pro plan","details":null,"appearance":null,"metadata":{"order_id":"1042"},"paid_late":false,"needs_review":false,"review_reason":null,"transactions":[],"dust_count":0,"created":1767225600,"expires_at":1767227400,"completed_at":null,"closed_at":null}}}},"400":{"description":"`idempotency_error`: An `Idempotency-Key` reused with other parameters.\n\n`idempotency_error`: An `Idempotency-Key` over 255 characters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"idem_other_parameters":{"summary":"An `Idempotency-Key` reused with other parameters.","value":{"error":{"type":"idempotency_error","message":"This Idempotency-Key was used with other parameters. Use a new key for a new request."}}},"idem_too_long":{"summary":"An `Idempotency-Key` over 255 characters.","value":{"error":{"type":"idempotency_error","message":"Idempotency-Key is at most 255 characters."}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"description":"`account_past_due`: Live only: an Orboni invoice is past due.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"past_due":{"summary":"Live only: an Orboni invoice is past due.","value":{"error":{"type":"account_past_due","message":"This account has an unpaid Orboni invoice past its due date. Pay it in the dashboard under Billing to take live payments again."}}}}}}},"403":{"$ref":"#/components/responses/ForbiddenWrite"},"409":{"$ref":"#/components/responses/IdempotencyConflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"422":{"description":"`invalid_request_error`: A parameter failed validation; `param` names it.\n\n`invalid_request_error`: A price worth less than $1 or more than $100,000 at the day\u2019s rate.\n\n`amount_too_small`: Under the minimum of every network the session could be paid on.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"validation":{"summary":"A parameter failed validation; `param` names it.","value":{"error":{"type":"invalid_request_error","message":"The amount field is required.","param":"amount"}}},"amount_limits":{"summary":"A price worth less than $1 or more than $100,000 at the day\u2019s rate.","value":{"error":{"type":"invalid_request_error","message":"Amount must be at least 100 (USD 1.00).","param":"amount"}}},"amount_too_small":{"summary":"Under the minimum of every network the session could be paid on.","value":{"error":{"type":"amount_too_small","message":"This amount is under the minimum of every network these methods use. Allow a network without one, or ask at least $5.00.","param":"amount"}}}}}}},"429":{"description":"`rate_limit_error`: The account has as many open sessions in this mode as it may; `Retry-After` is 60.\n\n`rate_limit_error`: Over the API\u2019s rate limit.\n\n`rate_limit_error`: Over 60 calls a minute with a wrong key from one address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"too_many_open":{"summary":"The account has as many open sessions in this mode as it may; `Retry-After` is 60.","value":{"error":{"type":"rate_limit_error","message":"This account has 1000 open live checkout sessions, the most it may have at once. Expire the ones you no longer need (POST /v1/checkout/sessions/{id}/expire), or wait until they run out."}}},"rate_limited":{"summary":"Over the API\u2019s rate limit.","value":{"error":{"type":"rate_limit_error","message":"Too many requests. Slow down and retry after the Retry-After header\u2019s seconds."}}},"auth_flood":{"summary":"Over 60 calls a minute with a wrong key from one address.","value":{"error":{"type":"rate_limit_error","message":"Too many requests with an invalid API key. Retry after the Retry-After header\u2019s seconds."}}}}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"description":"`rate_unavailable`: A price in another currency than usd while there is no current exchange rate for it. Retry later, or price it in usd.\n\n`api_error`: An update in progress; `Retry-After` says when to come back.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"rate_unavailable":{"summary":"A price in another currency than usd while there is no current exchange rate for it. Retry later, or price it in usd.","value":{"error":{"type":"rate_unavailable","message":"There is no current exchange rate for EUR right now. Try again later, or set the price in USD.","param":"currency"}}},"maintenance":{"summary":"An update in progress; `Retry-After` says when to come back.","value":{"error":{"type":"api_error","message":"Orboni is being updated. Retry after the Retry-After header\u2019s seconds; with an Idempotency-Key a retry is safe."}}}}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"}}}}},"get":{"operationId":"listCheckoutSessions","tags":["Checkout Sessions"],"summary":"List checkout sessions","description":"The sessions of this key\u2019s project and mode, newest first, narrowed by `status`, `payment_status`, `client_reference_id`, `customer_email` and `created`. Paged by cursor: `limit` (1\u2013100, 10 by default), then `starting_after` the last ID of the page for the next, older page while `has_more` is true, or `ending_before` the first ID for the page before.","parameters":[{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Created"},{"name":"status","in":"query","description":"Only sessions in this status.","schema":{"type":"string","enum":["open","complete","expired"]}},{"name":"payment_status","in":"query","description":"Only sessions with this payment status.","schema":{"type":"string","enum":["unpaid","processing","partially_paid","paid","held"]}},{"name":"client_reference_id","in":"query","description":"Only sessions with exactly this `client_reference_id`.","schema":{"type":"string","maxLength":255}},{"name":"customer_email","in":"query","description":"Only sessions with exactly this `customer_email`.","schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"A page of sessions.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutSessionList"},"example":{"object":"list","data":[{"id":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","object":"checkout.session","livemode":true,"status":"complete","payment_status":"paid","amount_total":2490,"currency":"usd","exchange_rate":null,"amount_received":"24.90","amount_due":"24.90","amount_remaining":"0.00","amount_due_usd":"24.90","amount_received_usd":"24.90","amount_refunded":0,"payment_methods":[],"payment":{"asset":"usdt_tron","chain":"tron","coin":"USDT","amount":"24.9","rate_usd":"1","amount_usd":"24.90","pay_address":"TExampLeAddressDoNotPay1234567890a","memo":null,"quote_expires_at":1767226800},"url":"https://orboni.com/pay/cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","success_url":"https://shop.example/thanks?session=cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","payment_link":null,"customer_email":"buyer@example.com","customer_email_collection":"required","locale":"auto","description":"Pro plan","details":null,"appearance":null,"metadata":{"order_id":"1042"},"paid_late":false,"needs_review":false,"review_reason":null,"transactions":[{"signature":"9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e","asset":"usdt_tron","amount":"24.90","amount_usd":"24.90","amount_coin":"24.9","rate_usd":"1","status":"finalized","confirmations":20,"dust":false,"delivery":"held","from":"TExampLeSenderAddressNotReal12345b","block_time":1767225900,"explorer_url":"https://tronscan.org/#/transaction/9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e"}],"dust_count":0,"created":1767225600,"expires_at":1767227400,"completed_at":1767225912,"closed_at":null}],"has_more":true,"url":"/v1/checkout/sessions"}}}},"400":{"description":"`invalid_request_error`: A bad `limit`.\n\n`invalid_request_error`: A cursor that names no object of this list.\n\n`invalid_request_error`: Both cursors at once.\n\n`invalid_request_error`: A `created` filter that is not Unix seconds of ten digits at most.\n\n`invalid_request_error`: A filter value the list does not know.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"bad_limit":{"summary":"A bad `limit`.","value":{"error":{"type":"invalid_request_error","message":"limit must be a whole number from 1 to 100.","param":"limit"}}},"bad_cursor":{"summary":"A cursor that names no object of this list.","value":{"error":{"type":"invalid_request_error","message":"No such object for starting_after: 'cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6'","param":"starting_after"}}},"both_cursors":{"summary":"Both cursors at once.","value":{"error":{"type":"invalid_request_error","message":"Use either starting_after or ending_before, not both.","param":"starting_after"}}},"bad_created":{"summary":"A `created` filter that is not Unix seconds of ten digits at most.","value":{"error":{"type":"invalid_request_error","message":"created takes unix seconds (not milliseconds), as created[gte]=1767225600 (also gt, lt, lte).","param":"created"}}},"bad_status":{"summary":"A filter value the list does not know.","value":{"error":{"type":"invalid_request_error","message":"status must be one of: open, complete, expired.","param":"status"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/checkout/sessions/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"The checkout session\u2019s ID.","schema":{"type":"string","examples":["cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6"]}}],"get":{"operationId":"retrieveCheckoutSession","tags":["Checkout Sessions"],"summary":"Retrieve a checkout session","description":"A session of this key\u2019s project and mode, as it is now.","responses":{"200":{"description":"The session.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutSession"},"example":{"id":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","object":"checkout.session","livemode":true,"status":"complete","payment_status":"paid","amount_total":2490,"currency":"usd","exchange_rate":null,"amount_received":"24.90","amount_due":"24.90","amount_remaining":"0.00","amount_due_usd":"24.90","amount_received_usd":"24.90","amount_refunded":0,"payment_methods":[],"payment":{"asset":"usdt_tron","chain":"tron","coin":"USDT","amount":"24.9","rate_usd":"1","amount_usd":"24.90","pay_address":"TExampLeAddressDoNotPay1234567890a","memo":null,"quote_expires_at":1767226800},"url":"https://orboni.com/pay/cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","success_url":"https://shop.example/thanks?session=cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","payment_link":null,"customer_email":"buyer@example.com","customer_email_collection":"required","locale":"auto","description":"Pro plan","details":null,"appearance":null,"metadata":{"order_id":"1042"},"paid_late":false,"needs_review":false,"review_reason":null,"transactions":[{"signature":"9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e","asset":"usdt_tron","amount":"24.90","amount_usd":"24.90","amount_coin":"24.9","rate_usd":"1","status":"finalized","confirmations":20,"dust":false,"delivery":"held","from":"TExampLeSenderAddressNotReal12345b","block_time":1767225900,"explorer_url":"https://tronscan.org/#/transaction/9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e"}],"dust_count":0,"created":1767225600,"expires_at":1767227400,"completed_at":1767225912,"closed_at":null}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"description":"`invalid_request_error`: No such session in this project and mode.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"session_not_found":{"summary":"No such session in this project and mode.","value":{"error":{"type":"invalid_request_error","message":"No such checkout session: 'cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6'","param":"id"}}}}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/checkout/sessions/{id}/expire":{"parameters":[{"name":"id","in":"path","required":true,"description":"The checkout session\u2019s ID.","schema":{"type":"string","examples":["cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6"]}}],"post":{"operationId":"expireCheckoutSession","tags":["Checkout Sessions"],"summary":"Expire a checkout session","description":"Closes the link now, for an order cancelled on your side \u2014 also one whose link has already run out, which stays `expired` and is not announced again. From then on whatever still arrives, a payment already on its way included, is held for your review (`review_reason` `closed`), whatever your late-payment setting; `closed_at` says when. A session that is already `complete` is answered as it is. Sends `checkout.session.expired` when an open session expires. Send an `Idempotency-Key` to retry safely: a successful answer is kept for 24 hours and a retry with the same key gets it again (`Idempotent-Replayed: true`) instead of acting twice.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"The session, expired.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutSession"},"example":{"id":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","object":"checkout.session","livemode":true,"status":"expired","payment_status":"unpaid","amount_total":2490,"currency":"usd","exchange_rate":null,"amount_received":"0.00","amount_due":"24.90","amount_remaining":"24.90","amount_due_usd":"24.90","amount_received_usd":"0.00","amount_refunded":0,"payment_methods":[],"payment":null,"url":"https://orboni.com/pay/cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","success_url":"https://shop.example/thanks?session=cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","payment_link":null,"customer_email":"buyer@example.com","customer_email_collection":"required","locale":"auto","description":"Pro plan","details":null,"appearance":null,"metadata":{"order_id":"1042"},"paid_late":false,"needs_review":false,"review_reason":null,"transactions":[],"dust_count":0,"created":1767225600,"expires_at":1767227400,"completed_at":null,"closed_at":1767226200}}}},"400":{"description":"`idempotency_error`: An `Idempotency-Key` reused with other parameters.\n\n`idempotency_error`: An `Idempotency-Key` over 255 characters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"idem_other_parameters":{"summary":"An `Idempotency-Key` reused with other parameters.","value":{"error":{"type":"idempotency_error","message":"This Idempotency-Key was used with other parameters. Use a new key for a new request."}}},"idem_too_long":{"summary":"An `Idempotency-Key` over 255 characters.","value":{"error":{"type":"idempotency_error","message":"Idempotency-Key is at most 255 characters."}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/ForbiddenWrite"},"404":{"description":"`invalid_request_error`: No such session in this project and mode.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"session_not_found":{"summary":"No such session in this project and mode.","value":{"error":{"type":"invalid_request_error","message":"No such checkout session: 'cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6'","param":"id"}}}}}}},"409":{"$ref":"#/components/responses/IdempotencyConflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/payment_methods":{"get":{"operationId":"listPaymentMethods","tags":["Payment Methods"],"summary":"List the project\u2019s payment methods","description":"What a session made with this key would offer now: the ways to pay of every wallet the project has, in the key\u2019s mode, in the order the payment page lists them. With `amount`, the methods whose minimum is above what it is worth are left out. Live, the list is empty while the project could not take a payment (receiving frozen, its email not confirmed, an Orboni invoice past due). One page, never paged: `has_more` is always false.","parameters":[{"$ref":"#/components/parameters/MethodsAmount"},{"$ref":"#/components/parameters/MethodsCurrency"}],"responses":{"200":{"description":"The payment methods.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodList"},"example":{"object":"list","url":"/v1/payment_methods","livemode":true,"has_more":false,"data":[{"object":"payment_method","key":"usdt_tron","coin":"USDT","name":"Tether","chain":"tron","chain_name":"TRON","stable":true,"from_exchange":true,"minimum_amount":300,"simulated_only":false},{"object":"payment_method","key":"btc","coin":"BTC","name":"Bitcoin","chain":"bitcoin","chain_name":"Bitcoin","stable":false,"from_exchange":true,"minimum_amount":null,"simulated_only":false}]}}}},"400":{"description":"`invalid_request_error`: A bad `amount` or `currency`.\n\n`invalid_request_error`: An `amount` outside what a session may ask.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"methods_bad_amount":{"summary":"A bad `amount` or `currency`.","value":{"error":{"type":"invalid_request_error","message":"The amount field must be an integer.","param":"amount"}}},"methods_amount_limits":{"summary":"An `amount` outside what a session may ask.","value":{"error":{"type":"invalid_request_error","message":"Amount must be at least 100 (USD 1.00).","param":"amount"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"description":"`rate_unavailable`: A price in another currency than usd while there is no current exchange rate for it. Retry later, or price it in usd.\n\n`api_error`: An update in progress; `Retry-After` says when to come back.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"rate_unavailable":{"summary":"A price in another currency than usd while there is no current exchange rate for it. Retry later, or price it in usd.","value":{"error":{"type":"rate_unavailable","message":"There is no current exchange rate for EUR right now. Try again later, or set the price in USD.","param":"currency"}}},"maintenance":{"summary":"An update in progress; `Retry-After` says when to come back.","value":{"error":{"type":"api_error","message":"Orboni is being updated. Retry after the Retry-After header\u2019s seconds; with an Idempotency-Key a retry is safe."}}}}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"}}}}}},"/public/payment_methods":{"get":{"operationId":"listPublicPaymentMethods","tags":["Payment Methods"],"summary":"List the payment methods with a publishable key","description":"For a buyer\u2019s browser (what `orboni.js` reads): the same list as `GET /payment_methods` for the key\u2019s mode, with the same `amount` and `currency`, without `simulated_only`. The key goes in the query, any site may ask (`Access-Control-Allow-Origin: *`), and the answer may be cached for a minute (`Cache-Control: public, max-age=60`). An unknown key answers 401; a project that could not take a payment now answers an empty list. At most 120 requests a minute from one address; beyond it `429` with `Retry-After`, which any site can read (`Access-Control-Expose-Headers`).","parameters":[{"$ref":"#/components/parameters/MethodsAmount"},{"$ref":"#/components/parameters/MethodsCurrency"}],"responses":{"200":{"description":"The payment methods.","headers":{"Access-Control-Allow-Origin":{"$ref":"#/components/headers/AccessControlAllowOrigin"},"Cache-Control":{"description":"`public, max-age=60`.","schema":{"type":"string"}},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicPaymentMethodList"},"example":{"object":"list","url":"/v1/public/payment_methods","livemode":true,"has_more":false,"data":[{"object":"payment_method","key":"usdt_tron","coin":"USDT","name":"Tether","chain":"tron","chain_name":"TRON","stable":true,"from_exchange":true,"minimum_amount":300},{"object":"payment_method","key":"btc","coin":"BTC","name":"Bitcoin","chain":"bitcoin","chain_name":"Bitcoin","stable":false,"from_exchange":true,"minimum_amount":null}]}}}},"400":{"description":"`invalid_request_error`: A bad `amount` or `currency`.\n\n`invalid_request_error`: An `amount` outside what a session may ask.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"methods_bad_amount":{"summary":"A bad `amount` or `currency`.","value":{"error":{"type":"invalid_request_error","message":"The amount field must be an integer.","param":"amount"}}},"methods_amount_limits":{"summary":"An `amount` outside what a session may ask.","value":{"error":{"type":"invalid_request_error","message":"Amount must be at least 100 (USD 1.00).","param":"amount"}}}}}},"headers":{"Access-Control-Allow-Origin":{"$ref":"#/components/headers/AccessControlAllowOrigin"}}},"401":{"description":"`authentication_error`: No publishable key, or an unknown one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"public_no_key":{"summary":"No publishable key, or an unknown one.","value":{"error":{"type":"authentication_error","message":"Pass your publishable key as key=pk_live_\u2026 or pk_test_\u2026 (Developers \u2192 API keys).","param":"key"}}}}}},"headers":{"Access-Control-Allow-Origin":{"$ref":"#/components/headers/AccessControlAllowOrigin"}}},"429":{"description":"`rate_limit_error`: Over the API\u2019s rate limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"rate_limited":{"summary":"Over the API\u2019s rate limit.","value":{"error":{"type":"rate_limit_error","message":"Too many requests. Slow down and retry after the Retry-After header\u2019s seconds."}}}}}},"headers":{"Access-Control-Allow-Origin":{"$ref":"#/components/headers/AccessControlAllowOrigin"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"500":{"description":"`api_error`: An error of ours. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"server_error":{"summary":"An error of ours. Retry.","value":{"error":{"type":"api_error","message":"Something went wrong on our side. Retry; with an Idempotency-Key a retry is safe."}}}}}},"headers":{"Access-Control-Allow-Origin":{"$ref":"#/components/headers/AccessControlAllowOrigin"}}},"503":{"description":"`rate_unavailable`: A price in another currency than usd while there is no current exchange rate for it. Retry later, or price it in usd.\n\n`api_error`: An update in progress; `Retry-After` says when to come back.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"rate_unavailable":{"summary":"A price in another currency than usd while there is no current exchange rate for it. Retry later, or price it in usd.","value":{"error":{"type":"rate_unavailable","message":"There is no current exchange rate for EUR right now. Try again later, or set the price in USD.","param":"currency"}}},"maintenance":{"summary":"An update in progress; `Retry-After` says when to come back.","value":{"error":{"type":"api_error","message":"Orboni is being updated. Retry after the Retry-After header\u2019s seconds; with an Idempotency-Key a retry is safe."}}}}}},"headers":{"Access-Control-Allow-Origin":{"$ref":"#/components/headers/AccessControlAllowOrigin"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}}},"security":[{"publishableKey":[]}]}},"/currencies":{"get":{"operationId":"listCurrencies","tags":["Currencies"],"summary":"List the currencies","description":"Every currency a price may be set in, the decimals of its smallest unit, whether a session can be made in it now, and the rate it would be priced at. A store that shows its buyers their own currency asks this before pricing an order in crypto, and falls back to usd for one that is not `available`: a session in it would be refused with `503 rate_unavailable`. Cache it for a few minutes. One page, never paged.","responses":{"200":{"description":"The currencies.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrencyList"},"example":{"object":"list","url":"/v1/currencies","livemode":true,"has_more":false,"data":[{"object":"currency","code":"usd","decimals":2,"available":true,"exchange_rate":null},{"object":"currency","code":"eur","decimals":2,"available":true,"exchange_rate":{"usd":"1.1052","date":"2026-11-13","source":"ecb"}},{"object":"currency","code":"jpy","decimals":0,"available":false,"exchange_rate":null}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/events":{"get":{"operationId":"listEvents","tags":["Events"],"summary":"List events","description":"The events of this key\u2019s project and mode, newest first: what the webhooks said. Narrowed by `type`, `checkout_session` and `created`. Each carries `pending_webhooks`, the endpoints that have not taken it yet. Paged by cursor: `limit` (1\u2013100, 10 by default), then `starting_after` the last ID of the page for the next, older page while `has_more` is true, or `ending_before` the first ID for the page before.","parameters":[{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Created"},{"name":"type","in":"query","description":"Only events of this type.","schema":{"type":"string","enum":["checkout.session.payment_detected","checkout.session.partially_paid","checkout.session.completed","checkout.session.expired","checkout.session.needs_review","checkout.session.extra_received","checkout.session.payment_reversed","refund.created","refund.voided"]}},{"name":"checkout_session","in":"query","description":"Only the events of this checkout session (refund events included). An unknown ID answers 400.","schema":{"type":"string","examples":["cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6"]}}],"responses":{"200":{"description":"A page of events.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventList"},"example":{"object":"list","data":[{"id":"evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz","object":"event","type":"checkout.session.completed","livemode":true,"created":1767225912,"data":{"object":{"id":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","object":"checkout.session","livemode":true,"status":"complete","payment_status":"paid","amount_total":2490,"currency":"usd","exchange_rate":null,"amount_received":"24.90","amount_due":"24.90","amount_remaining":"0.00","amount_due_usd":"24.90","amount_received_usd":"24.90","amount_refunded":0,"payment_methods":[],"payment":{"asset":"usdt_tron","chain":"tron","coin":"USDT","amount":"24.9","rate_usd":"1","amount_usd":"24.90","pay_address":"TExampLeAddressDoNotPay1234567890a","memo":null,"quote_expires_at":1767226800},"url":"https://orboni.com/pay/cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","success_url":"https://shop.example/thanks?session=cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","payment_link":null,"customer_email":"buyer@example.com","customer_email_collection":"required","locale":"auto","description":"Pro plan","details":null,"appearance":null,"metadata":{"order_id":"1042"},"paid_late":false,"needs_review":false,"review_reason":null,"transactions":[{"signature":"9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e","asset":"usdt_tron","amount":"24.90","amount_usd":"24.90","amount_coin":"24.9","rate_usd":"1","status":"finalized","confirmations":20,"dust":false,"delivery":"held","from":"TExampLeSenderAddressNotReal12345b","block_time":1767225900,"explorer_url":"https://tronscan.org/#/transaction/9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e"}],"dust_count":0,"created":1767225600,"expires_at":1767227400,"completed_at":1767225912,"closed_at":null}},"pending_webhooks":0}],"has_more":true,"url":"/v1/events"}}}},"400":{"description":"`invalid_request_error`: A bad `limit`.\n\n`invalid_request_error`: A cursor that names no object of this list.\n\n`invalid_request_error`: A `created` filter that is not Unix seconds of ten digits at most.\n\n`invalid_request_error`: An unknown event type.\n\n`invalid_request_error`: An unknown `checkout_session`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"bad_limit":{"summary":"A bad `limit`.","value":{"error":{"type":"invalid_request_error","message":"limit must be a whole number from 1 to 100.","param":"limit"}}},"bad_cursor":{"summary":"A cursor that names no object of this list.","value":{"error":{"type":"invalid_request_error","message":"No such object for starting_after: 'cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6'","param":"starting_after"}}},"bad_created":{"summary":"A `created` filter that is not Unix seconds of ten digits at most.","value":{"error":{"type":"invalid_request_error","message":"created takes unix seconds (not milliseconds), as created[gte]=1767225600 (also gt, lt, lte).","param":"created"}}},"bad_event_type":{"summary":"An unknown event type.","value":{"error":{"type":"invalid_request_error","message":"type must be one of: checkout.session.payment_detected, checkout.session.partially_paid, checkout.session.completed, checkout.session.expired, checkout.session.needs_review, checkout.session.extra_received, checkout.session.payment_reversed, refund.created, refund.voided.","param":"type"}}},"bad_event_session":{"summary":"An unknown `checkout_session`.","value":{"error":{"type":"invalid_request_error","message":"No such checkout session: 'cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6'","param":"checkout_session"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/events/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"The event\u2019s ID.","schema":{"type":"string","examples":["evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz"]}}],"get":{"operationId":"retrieveEvent","tags":["Events"],"summary":"Retrieve an event","description":"The event as its webhooks carried it, with `pending_webhooks`.","responses":{"200":{"description":"The event.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"},"example":{"id":"evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz","object":"event","type":"checkout.session.completed","livemode":true,"created":1767225912,"data":{"object":{"id":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","object":"checkout.session","livemode":true,"status":"complete","payment_status":"paid","amount_total":2490,"currency":"usd","exchange_rate":null,"amount_received":"24.90","amount_due":"24.90","amount_remaining":"0.00","amount_due_usd":"24.90","amount_received_usd":"24.90","amount_refunded":0,"payment_methods":[],"payment":{"asset":"usdt_tron","chain":"tron","coin":"USDT","amount":"24.9","rate_usd":"1","amount_usd":"24.90","pay_address":"TExampLeAddressDoNotPay1234567890a","memo":null,"quote_expires_at":1767226800},"url":"https://orboni.com/pay/cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","success_url":"https://shop.example/thanks?session=cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","payment_link":null,"customer_email":"buyer@example.com","customer_email_collection":"required","locale":"auto","description":"Pro plan","details":null,"appearance":null,"metadata":{"order_id":"1042"},"paid_late":false,"needs_review":false,"review_reason":null,"transactions":[{"signature":"9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e","asset":"usdt_tron","amount":"24.90","amount_usd":"24.90","amount_coin":"24.9","rate_usd":"1","status":"finalized","confirmations":20,"dust":false,"delivery":"held","from":"TExampLeSenderAddressNotReal12345b","block_time":1767225900,"explorer_url":"https://tronscan.org/#/transaction/9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e"}],"dust_count":0,"created":1767225600,"expires_at":1767227400,"completed_at":1767225912,"closed_at":null}},"pending_webhooks":0}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"description":"`invalid_request_error`: No such event in this project and mode.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"event_not_found":{"summary":"No such event in this project and mode.","value":{"error":{"type":"invalid_request_error","message":"No such event: 'evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz'","param":"id"}}}}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/events/{id}/resend":{"parameters":[{"name":"id","in":"path","required":true,"description":"The event\u2019s ID.","schema":{"type":"string","examples":["evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz"]}}],"post":{"operationId":"resendEvent","tags":["Events"],"summary":"Send an event again","description":"Queues the event now to every enabled webhook endpoint of its mode that takes its type, with a fresh set of retries; an endpoint added since gets its first copy. Answers the event, with `pending_webhooks` counting the endpoints it now waits for. A rate limit of its own: 30 a minute per project and mode, beside the API\u2019s. Send an `Idempotency-Key` to retry safely: a successful answer is kept for 24 hours and a retry with the same key gets it again (`Idempotent-Replayed: true`) instead of acting twice.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"The event, queued again.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"},"example":{"id":"evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz","object":"event","type":"checkout.session.completed","livemode":true,"created":1767225912,"data":{"object":{"id":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","object":"checkout.session","livemode":true,"status":"complete","payment_status":"paid","amount_total":2490,"currency":"usd","exchange_rate":null,"amount_received":"24.90","amount_due":"24.90","amount_remaining":"0.00","amount_due_usd":"24.90","amount_received_usd":"24.90","amount_refunded":0,"payment_methods":[],"payment":{"asset":"usdt_tron","chain":"tron","coin":"USDT","amount":"24.9","rate_usd":"1","amount_usd":"24.90","pay_address":"TExampLeAddressDoNotPay1234567890a","memo":null,"quote_expires_at":1767226800},"url":"https://orboni.com/pay/cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","success_url":"https://shop.example/thanks?session=cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","payment_link":null,"customer_email":"buyer@example.com","customer_email_collection":"required","locale":"auto","description":"Pro plan","details":null,"appearance":null,"metadata":{"order_id":"1042"},"paid_late":false,"needs_review":false,"review_reason":null,"transactions":[{"signature":"9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e","asset":"usdt_tron","amount":"24.90","amount_usd":"24.90","amount_coin":"24.9","rate_usd":"1","status":"finalized","confirmations":20,"dust":false,"delivery":"held","from":"TExampLeSenderAddressNotReal12345b","block_time":1767225900,"explorer_url":"https://tronscan.org/#/transaction/9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e"}],"dust_count":0,"created":1767225600,"expires_at":1767227400,"completed_at":1767225912,"closed_at":null}},"pending_webhooks":1}}}},"400":{"description":"`invalid_request_error`: No enabled endpoint of the mode takes this event\u2019s type.\n\n`invalid_request_error`: A test event, while 1000 test deliveries of the project wait already.\n\n`idempotency_error`: An `Idempotency-Key` reused with other parameters.\n\n`idempotency_error`: An `Idempotency-Key` over 255 characters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"resend_no_endpoint":{"summary":"No enabled endpoint of the mode takes this event\u2019s type.","value":{"error":{"type":"invalid_request_error","message":"No enabled webhook endpoint of this mode takes this event type. Add or enable one in the dashboard under Developers \u2192 Webhooks.","param":"id"}}},"resend_backlog":{"summary":"A test event, while 1000 test deliveries of the project wait already.","value":{"error":{"type":"invalid_request_error","message":"Too many test webhook deliveries of this project are waiting already. Resend this event once they have gone out.","param":"id"}}},"idem_other_parameters":{"summary":"An `Idempotency-Key` reused with other parameters.","value":{"error":{"type":"idempotency_error","message":"This Idempotency-Key was used with other parameters. Use a new key for a new request."}}},"idem_too_long":{"summary":"An `Idempotency-Key` over 255 characters.","value":{"error":{"type":"idempotency_error","message":"Idempotency-Key is at most 255 characters."}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/ForbiddenWrite"},"404":{"description":"`invalid_request_error`: No such event in this project and mode.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"event_not_found":{"summary":"No such event in this project and mode.","value":{"error":{"type":"invalid_request_error","message":"No such event: 'evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz'","param":"id"}}}}}}},"409":{"$ref":"#/components/responses/IdempotencyConflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"429":{"description":"`rate_limit_error`: Over the API\u2019s rate limit, or over 30 resends a minute.\n\n`rate_limit_error`: Over the API\u2019s rate limit.\n\n`rate_limit_error`: Over 60 calls a minute with a wrong key from one address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"resend_rate_limited":{"summary":"Over the API\u2019s rate limit, or over 30 resends a minute.","value":{"error":{"type":"rate_limit_error","message":"Too many requests. Slow down and retry after the Retry-After header\u2019s seconds."}}},"rate_limited":{"summary":"Over the API\u2019s rate limit.","value":{"error":{"type":"rate_limit_error","message":"Too many requests. Slow down and retry after the Retry-After header\u2019s seconds."}}},"auth_flood":{"summary":"Over 60 calls a minute with a wrong key from one address.","value":{"error":{"type":"rate_limit_error","message":"Too many requests with an invalid API key. Retry after the Retry-After header\u2019s seconds."}}}}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/refunds":{"post":{"operationId":"createRefund","tags":["Refunds"],"summary":"Record a refund","description":"Orboni never holds your money, so it cannot send a refund for you. Ask the buyer for a refund address on the same network, send the coins back from your own wallet first, then record it here: the session\u2019s `amount_refunded`, your reports and a `refund.created` webhook follow. Never send to the address the payment came from (`transactions[].from`): an exchange\u2019s or a contract\u2019s address does not credit the buyer. The refund\u2019s `amount` and `currency` are its session\u2019s. Send an `Idempotency-Key` to retry safely: a successful answer is kept for 24 hours and a retry with the same key gets it again (`Idempotent-Replayed: true`) instead of acting twice.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"description":"JSON, or form-encoded with arrays and objects PHP-style (`payment_methods[]=btc`, `metadata[order]=1042`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRefundRequest"},"example":{"checkout_session":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","amount":990,"reason":"requested_by_customer","transaction":"5h9xExampleRefundTransferHash"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/CreateRefundRequest"}}}},"responses":{"201":{"description":"The refund, recorded.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund"},"example":{"id":"re_7Qd2Hf5Jk8Lm1Np4Rs6Tv9Wx","object":"refund","livemode":true,"amount":990,"currency":"usd","checkout_session":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","reason":"requested_by_customer","transaction":"5h9xExampleRefundTransferHash","note":null,"metadata":{},"source":"api","status":"succeeded","voided_at":null,"created":1767312000}}}},"400":{"description":"`idempotency_error`: An `Idempotency-Key` reused with other parameters.\n\n`idempotency_error`: An `Idempotency-Key` over 255 characters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"idem_other_parameters":{"summary":"An `Idempotency-Key` reused with other parameters.","value":{"error":{"type":"idempotency_error","message":"This Idempotency-Key was used with other parameters. Use a new key for a new request."}}},"idem_too_long":{"summary":"An `Idempotency-Key` over 255 characters.","value":{"error":{"type":"idempotency_error","message":"Idempotency-Key is at most 255 characters."}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/ForbiddenWrite"},"404":{"description":"`invalid_request_error`: No such session in this project and mode.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"refund_session_missing":{"summary":"No such session in this project and mode.","value":{"error":{"type":"invalid_request_error","message":"No such checkout session: 'cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6'","param":"checkout_session"}}}}}}},"409":{"$ref":"#/components/responses/IdempotencyConflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"422":{"description":"`invalid_request_error`: A parameter failed validation; `param` names it.\n\n`invalid_request_error`: More than is left to refund, nothing paid, already refunded in full, or the session has the most refunds one may have.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"validation_refund":{"summary":"A parameter failed validation; `param` names it.","value":{"error":{"type":"invalid_request_error","message":"The selected reason is invalid.","param":"reason"}}},"refund_refused":{"summary":"More than is left to refund, nothing paid, already refunded in full, or the session has the most refunds one may have.","value":{"error":{"type":"invalid_request_error","message":"The amount is more than can be refunded: at most 1500 cents ($15.00).","param":"amount"}}}}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"get":{"operationId":"listRefunds","tags":["Refunds"],"summary":"List refunds","description":"The refunds of this key\u2019s project and mode, newest first; `checkout_session` narrows it to one session\u2019s. Paged by cursor: `limit` (1\u2013100, 10 by default), then `starting_after` the last ID of the page for the next, older page while `has_more` is true, or `ending_before` the first ID for the page before.","parameters":[{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Created"},{"name":"checkout_session","in":"query","description":"Only this checkout session\u2019s refunds. An unknown ID answers 400.","schema":{"type":"string","examples":["cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6"]}}],"responses":{"200":{"description":"A page of refunds.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundList"},"example":{"object":"list","data":[{"id":"re_7Qd2Hf5Jk8Lm1Np4Rs6Tv9Wx","object":"refund","livemode":true,"amount":990,"currency":"usd","checkout_session":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","reason":"requested_by_customer","transaction":"5h9xExampleRefundTransferHash","note":null,"metadata":{},"source":"api","status":"succeeded","voided_at":null,"created":1767312000}],"has_more":false,"url":"/v1/refunds"}}}},"400":{"description":"`invalid_request_error`: A bad `limit`.\n\n`invalid_request_error`: A cursor that names no object of this list.\n\n`invalid_request_error`: A `created` filter that is not Unix seconds of ten digits at most.\n\n`invalid_request_error`: An unknown `checkout_session`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"bad_limit":{"summary":"A bad `limit`.","value":{"error":{"type":"invalid_request_error","message":"limit must be a whole number from 1 to 100.","param":"limit"}}},"bad_cursor":{"summary":"A cursor that names no object of this list.","value":{"error":{"type":"invalid_request_error","message":"No such object for starting_after: 'cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6'","param":"starting_after"}}},"bad_created":{"summary":"A `created` filter that is not Unix seconds of ten digits at most.","value":{"error":{"type":"invalid_request_error","message":"created takes unix seconds (not milliseconds), as created[gte]=1767225600 (also gt, lt, lte).","param":"created"}}},"bad_refund_session":{"summary":"An unknown `checkout_session`.","value":{"error":{"type":"invalid_request_error","message":"No such checkout session: 'cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6'","param":"checkout_session"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/refunds/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"The refund\u2019s ID.","schema":{"type":"string","examples":["re_7Qd2Hf5Jk8Lm1Np4Rs6Tv9Wx"]}}],"get":{"operationId":"retrieveRefund","tags":["Refunds"],"summary":"Retrieve a refund","description":"A refund of this key\u2019s project and mode.","responses":{"200":{"description":"The refund.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund"},"example":{"id":"re_7Qd2Hf5Jk8Lm1Np4Rs6Tv9Wx","object":"refund","livemode":true,"amount":990,"currency":"usd","checkout_session":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","reason":"requested_by_customer","transaction":"5h9xExampleRefundTransferHash","note":null,"metadata":{},"source":"api","status":"succeeded","voided_at":null,"created":1767312000}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"description":"`invalid_request_error`: No such refund in this project and mode.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"refund_not_found":{"summary":"No such refund in this project and mode.","value":{"error":{"type":"invalid_request_error","message":"No such refund: 're_7Qd2Hf5Jk8Lm1Np4Rs6Tv9Wx'","param":"id"}}}}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/refunds/{id}/void":{"parameters":[{"name":"id","in":"path","required":true,"description":"The refund\u2019s ID.","schema":{"type":"string","examples":["re_7Qd2Hf5Jk8Lm1Np4Rs6Tv9Wx"]}}],"post":{"operationId":"voidRefund","tags":["Refunds"],"summary":"Void a refund","description":"Only for a refund recorded by mistake: no coins move. Answers the refund with `status` `voided` and `voided_at` set, takes its amount out of the session\u2019s `amount_refunded` and sends `refund.voided`. Voiding a voided refund answers it as it is. Send an `Idempotency-Key` to retry safely: a successful answer is kept for 24 hours and a retry with the same key gets it again (`Idempotent-Replayed: true`) instead of acting twice.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"The refund, voided.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund"},"example":{"id":"re_7Qd2Hf5Jk8Lm1Np4Rs6Tv9Wx","object":"refund","livemode":true,"amount":990,"currency":"usd","checkout_session":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","reason":"requested_by_customer","transaction":"5h9xExampleRefundTransferHash","note":null,"metadata":{},"source":"api","status":"voided","voided_at":1767315600,"created":1767312000}}}},"400":{"description":"`idempotency_error`: An `Idempotency-Key` reused with other parameters.\n\n`idempotency_error`: An `Idempotency-Key` over 255 characters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"idem_other_parameters":{"summary":"An `Idempotency-Key` reused with other parameters.","value":{"error":{"type":"idempotency_error","message":"This Idempotency-Key was used with other parameters. Use a new key for a new request."}}},"idem_too_long":{"summary":"An `Idempotency-Key` over 255 characters.","value":{"error":{"type":"idempotency_error","message":"Idempotency-Key is at most 255 characters."}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/ForbiddenWrite"},"404":{"description":"`invalid_request_error`: No such refund in this project and mode.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"refund_not_found":{"summary":"No such refund in this project and mode.","value":{"error":{"type":"invalid_request_error","message":"No such refund: 're_7Qd2Hf5Jk8Lm1Np4Rs6Tv9Wx'","param":"id"}}}}}}},"409":{"$ref":"#/components/responses/IdempotencyConflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/payment_links":{"post":{"operationId":"createPaymentLink","tags":["Payment Links"],"summary":"Create a payment link","description":"A link to share \u2014 in a message, a post, an invoice \u2014 that opens a checkout session of its own for each buyer. A project has at most 200 links switched on in each mode. Send an `Idempotency-Key` to retry safely: a successful answer is kept for 24 hours and a retry with the same key gets it again (`Idempotent-Replayed: true`) instead of acting twice.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"description":"JSON, or form-encoded with arrays and objects PHP-style (`payment_methods[]=btc`, `metadata[order]=1042`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentLinkRequest"},"example":{"description":"Logo design","amount":4900,"max_payments":1}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/CreatePaymentLinkRequest"}}}},"responses":{"201":{"description":"The payment link.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLink"},"example":{"id":"plink_3Hc9Kd2Lf5Mg8Nh1Pj4Qk7Rm","object":"payment_link","livemode":true,"url":"https://orboni.com/l/plink_3Hc9Kd2Lf5Mg8Nh1Pj4Qk7Rm","active":true,"status":"active","amount":4900,"currency":"usd","custom_amount":false,"min_amount":null,"max_amount":null,"max_payments":1,"payments_paid":0,"expires_at":null,"description":"Logo design","details":null,"success_url":null,"created":1767225600}}}},"400":{"description":"`idempotency_error`: An `Idempotency-Key` reused with other parameters.\n\n`idempotency_error`: An `Idempotency-Key` over 255 characters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"idem_other_parameters":{"summary":"An `Idempotency-Key` reused with other parameters.","value":{"error":{"type":"idempotency_error","message":"This Idempotency-Key was used with other parameters. Use a new key for a new request."}}},"idem_too_long":{"summary":"An `Idempotency-Key` over 255 characters.","value":{"error":{"type":"idempotency_error","message":"Idempotency-Key is at most 255 characters."}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/ForbiddenWrite"},"409":{"$ref":"#/components/responses/IdempotencyConflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"422":{"description":"`invalid_request_error`: A parameter failed validation; `param` names it.\n\n`invalid_request_error`: The link\u2019s amounts, limits, date or currency do not hold together, its currency has no current rate, or the project has the most links switched on it may.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"validation_link":{"summary":"A parameter failed validation; `param` names it.","value":{"error":{"type":"invalid_request_error","message":"The description field is required.","param":"description"}}},"link_invalid":{"summary":"The link\u2019s amounts, limits, date or currency do not hold together, its currency has no current rate, or the project has the most links switched on it may.","value":{"error":{"type":"invalid_request_error","message":"Name the amount, or let the buyer choose it.","param":"amount"}}}}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"get":{"operationId":"listPaymentLinks","tags":["Payment Links"],"summary":"List payment links","description":"The payment links of this key\u2019s project and mode, newest first; `active=true` or `false` narrows it to links switched on or off. Paged by cursor: `limit` (1\u2013100, 10 by default), then `starting_after` the last ID of the page for the next, older page while `has_more` is true, or `ending_before` the first ID for the page before.","parameters":[{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Created"},{"name":"active","in":"query","description":"Only links switched on (`true`) or off (`false`).","schema":{"type":"boolean"}}],"responses":{"200":{"description":"A page of payment links.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLinkList"},"example":{"object":"list","data":[{"id":"plink_3Hc9Kd2Lf5Mg8Nh1Pj4Qk7Rm","object":"payment_link","livemode":true,"url":"https://orboni.com/l/plink_3Hc9Kd2Lf5Mg8Nh1Pj4Qk7Rm","active":true,"status":"active","amount":4900,"currency":"usd","custom_amount":false,"min_amount":null,"max_amount":null,"max_payments":1,"payments_paid":0,"expires_at":null,"description":"Logo design","details":null,"success_url":null,"created":1767225600}],"has_more":false,"url":"/v1/payment_links"}}}},"400":{"description":"`invalid_request_error`: A bad `limit`.\n\n`invalid_request_error`: A cursor that names no object of this list.\n\n`invalid_request_error`: A `created` filter that is not Unix seconds of ten digits at most.\n\n`invalid_request_error`: An `active` filter that is not a boolean.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"bad_limit":{"summary":"A bad `limit`.","value":{"error":{"type":"invalid_request_error","message":"limit must be a whole number from 1 to 100.","param":"limit"}}},"bad_cursor":{"summary":"A cursor that names no object of this list.","value":{"error":{"type":"invalid_request_error","message":"No such object for starting_after: 'cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6'","param":"starting_after"}}},"bad_created":{"summary":"A `created` filter that is not Unix seconds of ten digits at most.","value":{"error":{"type":"invalid_request_error","message":"created takes unix seconds (not milliseconds), as created[gte]=1767225600 (also gt, lt, lte).","param":"created"}}},"bad_active":{"summary":"An `active` filter that is not a boolean.","value":{"error":{"type":"invalid_request_error","message":"active must be true or false.","param":"active"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/payment_links/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"The payment link\u2019s ID.","schema":{"type":"string","examples":["plink_3Hc9Kd2Lf5Mg8Nh1Pj4Qk7Rm"]}}],"get":{"operationId":"retrievePaymentLink","tags":["Payment Links"],"summary":"Retrieve a payment link","description":"A payment link of this key\u2019s project and mode.","responses":{"200":{"description":"The payment link.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLink"},"example":{"id":"plink_3Hc9Kd2Lf5Mg8Nh1Pj4Qk7Rm","object":"payment_link","livemode":true,"url":"https://orboni.com/l/plink_3Hc9Kd2Lf5Mg8Nh1Pj4Qk7Rm","active":true,"status":"active","amount":4900,"currency":"usd","custom_amount":false,"min_amount":null,"max_amount":null,"max_payments":1,"payments_paid":0,"expires_at":null,"description":"Logo design","details":null,"success_url":null,"created":1767225600}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"description":"`invalid_request_error`: No such payment link in this project and mode.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"link_not_found":{"summary":"No such payment link in this project and mode.","value":{"error":{"type":"invalid_request_error","message":"No such payment_link: 'plink_3Hc9Kd2Lf5Mg8Nh1Pj4Qk7Rm'","param":"id"}}}}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"post":{"operationId":"updatePaymentLink","tags":["Payment Links"],"summary":"Update a payment link","description":"Send only what changes: any field of create, and `active=false` to switch the link off (`true` to switch it on again). An empty (null) `expires_at` or `max_payments` removes that limit. A change applies to the payments opened after it; those already open keep what the link said. Send an `Idempotency-Key` to retry safely: a successful answer is kept for 24 hours and a retry with the same key gets it again (`Idempotent-Replayed: true`) instead of acting twice.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"description":"JSON, or form-encoded with arrays and objects PHP-style (`payment_methods[]=btc`, `metadata[order]=1042`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePaymentLinkRequest"},"example":{"active":false}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/UpdatePaymentLinkRequest"}}}},"responses":{"200":{"description":"The payment link, changed.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLink"},"example":{"id":"plink_3Hc9Kd2Lf5Mg8Nh1Pj4Qk7Rm","object":"payment_link","livemode":true,"url":"https://orboni.com/l/plink_3Hc9Kd2Lf5Mg8Nh1Pj4Qk7Rm","active":false,"status":"inactive","amount":4900,"currency":"usd","custom_amount":false,"min_amount":null,"max_amount":null,"max_payments":1,"payments_paid":0,"expires_at":null,"description":"Logo design","details":null,"success_url":null,"created":1767225600}}}},"400":{"description":"`idempotency_error`: An `Idempotency-Key` reused with other parameters.\n\n`idempotency_error`: An `Idempotency-Key` over 255 characters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"idem_other_parameters":{"summary":"An `Idempotency-Key` reused with other parameters.","value":{"error":{"type":"idempotency_error","message":"This Idempotency-Key was used with other parameters. Use a new key for a new request."}}},"idem_too_long":{"summary":"An `Idempotency-Key` over 255 characters.","value":{"error":{"type":"idempotency_error","message":"Idempotency-Key is at most 255 characters."}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/ForbiddenWrite"},"404":{"description":"`invalid_request_error`: No such payment link in this project and mode.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"link_not_found":{"summary":"No such payment link in this project and mode.","value":{"error":{"type":"invalid_request_error","message":"No such payment_link: 'plink_3Hc9Kd2Lf5Mg8Nh1Pj4Qk7Rm'","param":"id"}}}}}}},"409":{"$ref":"#/components/responses/IdempotencyConflict"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"422":{"description":"`invalid_request_error`: A parameter failed validation; `param` names it.\n\n`invalid_request_error`: The link\u2019s amounts, limits, date or currency do not hold together, its currency has no current rate, or the project has the most links switched on it may.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"validation_link":{"summary":"A parameter failed validation; `param` names it.","value":{"error":{"type":"invalid_request_error","message":"The description field is required.","param":"description"}}},"link_invalid":{"summary":"The link\u2019s amounts, limits, date or currency do not hold together, its currency has no current rate, or the project has the most links switched on it may.","value":{"error":{"type":"invalid_request_error","message":"Name the amount, or let the buyer choose it.","param":"amount"}}}}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}}},"webhooks":{"checkout.session.payment_detected":{"post":{"operationId":"webhook_checkout_session_payment_detected","tags":["Webhooks"],"summary":"checkout.session.payment_detected","description":"A transfer is seen on the chain, not final yet. Tell the buyer to wait; do not fulfil.\n\nPOSTed as JSON to every enabled endpoint of the event\u2019s mode that takes its type, with `Webhook-Signature`. Answer any 2xx within 5 seconds; anything else \u2014 a redirect included, which is not followed \u2014 is retried up to 8 times over about 69 hours, then marked failed (send it again from the dashboard or `POST /events/{id}/resend`). The same event can arrive more than once and out of order: keep the `id`s you have handled, and read `status` and `payment_status` from the object. In production ignore events whose `livemode` is false.","security":[],"parameters":[{"$ref":"#/components/parameters/WebhookSignature"},{"name":"User-Agent","in":"header","description":"Who sends it.","schema":{"type":"string","examples":["Orboni-Webhooks/1.0"]}}],"requestBody":{"required":true,"description":"The event. Verify `Webhook-Signature` over the raw body before reading it, and refuse a `t` more than 300 seconds old.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookEvent"},{"type":"object","properties":{"type":{"const":"checkout.session.payment_detected"},"data":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/CheckoutSession"}}}}}]},"example":{"id":"evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz","object":"event","type":"checkout.session.payment_detected","livemode":true,"created":1767225912,"data":{"object":{"id":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","object":"checkout.session","livemode":true,"status":"open","payment_status":"processing","amount_total":2490,"currency":"usd","exchange_rate":null,"amount_received":"0.00","amount_due":"24.90","amount_remaining":"24.90","amount_due_usd":"24.90","amount_received_usd":"0.00","amount_refunded":0,"payment_methods":[],"payment":{"asset":"usdt_tron","chain":"tron","coin":"USDT","amount":"24.9","rate_usd":"1","amount_usd":"24.90","pay_address":"TExampLeAddressDoNotPay1234567890a","memo":null,"quote_expires_at":1767226800},"url":"https://orboni.com/pay/cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","success_url":"https://shop.example/thanks?session=cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","payment_link":null,"customer_email":"buyer@example.com","customer_email_collection":"required","locale":"auto","description":"Pro plan","details":null,"appearance":null,"metadata":{"order_id":"1042"},"paid_late":false,"needs_review":false,"review_reason":null,"transactions":[{"signature":"9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e","asset":"usdt_tron","amount":"24.90","amount_usd":"24.90","amount_coin":"24.9","rate_usd":"1","status":"confirmed","confirmations":1,"dust":false,"delivery":"waiting","from":"TExampLeSenderAddressNotReal12345b","block_time":1767225900,"explorer_url":"https://tronscan.org/#/transaction/9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e"}],"dust_count":0,"created":1767225600,"expires_at":1767227400,"completed_at":null,"closed_at":null}}}}}},"responses":{"2XX":{"description":"Taken. Answer first and do the work after: a slow answer times out and is retried."},"default":{"description":"Anything else, or no answer in time: retried later."}}}},"checkout.session.partially_paid":{"post":{"operationId":"webhook_checkout_session_partially_paid","tags":["Webhooks"],"summary":"checkout.session.partially_paid","description":"Final transfers came, short of the amount. The link stays open for the rest.\n\nPOSTed as JSON to every enabled endpoint of the event\u2019s mode that takes its type, with `Webhook-Signature`. Answer any 2xx within 5 seconds; anything else \u2014 a redirect included, which is not followed \u2014 is retried up to 8 times over about 69 hours, then marked failed (send it again from the dashboard or `POST /events/{id}/resend`). The same event can arrive more than once and out of order: keep the `id`s you have handled, and read `status` and `payment_status` from the object. In production ignore events whose `livemode` is false.","security":[],"parameters":[{"$ref":"#/components/parameters/WebhookSignature"},{"name":"User-Agent","in":"header","description":"Who sends it.","schema":{"type":"string","examples":["Orboni-Webhooks/1.0"]}}],"requestBody":{"required":true,"description":"The event. Verify `Webhook-Signature` over the raw body before reading it, and refuse a `t` more than 300 seconds old.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookEvent"},{"type":"object","properties":{"type":{"const":"checkout.session.partially_paid"},"data":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/CheckoutSession"}}}}}]},"example":{"id":"evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz","object":"event","type":"checkout.session.partially_paid","livemode":true,"created":1767225912,"data":{"object":{"id":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","object":"checkout.session","livemode":true,"status":"open","payment_status":"partially_paid","amount_total":2490,"currency":"usd","exchange_rate":null,"amount_received":"20.00","amount_due":"24.90","amount_remaining":"4.90","amount_due_usd":"24.90","amount_received_usd":"20.00","amount_refunded":0,"payment_methods":[],"payment":{"asset":"usdt_tron","chain":"tron","coin":"USDT","amount":"20","rate_usd":"1","amount_usd":"20.00","pay_address":"TExampLeAddressDoNotPay1234567890a","memo":null,"quote_expires_at":1767226800},"url":"https://orboni.com/pay/cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","success_url":"https://shop.example/thanks?session=cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","payment_link":null,"customer_email":"buyer@example.com","customer_email_collection":"required","locale":"auto","description":"Pro plan","details":null,"appearance":null,"metadata":{"order_id":"1042"},"paid_late":false,"needs_review":false,"review_reason":null,"transactions":[{"signature":"9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e","asset":"usdt_tron","amount":"20.00","amount_usd":"20.00","amount_coin":"20","rate_usd":"1","status":"finalized","confirmations":20,"dust":false,"delivery":"held","from":"TExampLeSenderAddressNotReal12345b","block_time":1767225900,"explorer_url":"https://tronscan.org/#/transaction/9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e"}],"dust_count":0,"created":1767225600,"expires_at":1767227400,"completed_at":null,"closed_at":null}}}}}},"responses":{"2XX":{"description":"Taken. Answer first and do the work after: a slow answer times out and is retried."},"default":{"description":"Anything else, or no answer in time: retried later."}}}},"checkout.session.completed":{"post":{"operationId":"webhook_checkout_session_completed","tags":["Webhooks"],"summary":"checkout.session.completed","description":"Paid. Fulfil the order on this one.\n\nPOSTed as JSON to every enabled endpoint of the event\u2019s mode that takes its type, with `Webhook-Signature`. Answer any 2xx within 5 seconds; anything else \u2014 a redirect included, which is not followed \u2014 is retried up to 8 times over about 69 hours, then marked failed (send it again from the dashboard or `POST /events/{id}/resend`). The same event can arrive more than once and out of order: keep the `id`s you have handled, and read `status` and `payment_status` from the object. In production ignore events whose `livemode` is false.","security":[],"parameters":[{"$ref":"#/components/parameters/WebhookSignature"},{"name":"User-Agent","in":"header","description":"Who sends it.","schema":{"type":"string","examples":["Orboni-Webhooks/1.0"]}}],"requestBody":{"required":true,"description":"The event. Verify `Webhook-Signature` over the raw body before reading it, and refuse a `t` more than 300 seconds old.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookEvent"},{"type":"object","properties":{"type":{"const":"checkout.session.completed"},"data":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/CheckoutSession"}}}}}]},"example":{"id":"evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz","object":"event","type":"checkout.session.completed","livemode":true,"created":1767225912,"data":{"object":{"id":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","object":"checkout.session","livemode":true,"status":"complete","payment_status":"paid","amount_total":2490,"currency":"usd","exchange_rate":null,"amount_received":"24.90","amount_due":"24.90","amount_remaining":"0.00","amount_due_usd":"24.90","amount_received_usd":"24.90","amount_refunded":0,"payment_methods":[],"payment":{"asset":"usdt_tron","chain":"tron","coin":"USDT","amount":"24.9","rate_usd":"1","amount_usd":"24.90","pay_address":"TExampLeAddressDoNotPay1234567890a","memo":null,"quote_expires_at":1767226800},"url":"https://orboni.com/pay/cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","success_url":"https://shop.example/thanks?session=cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","payment_link":null,"customer_email":"buyer@example.com","customer_email_collection":"required","locale":"auto","description":"Pro plan","details":null,"appearance":null,"metadata":{"order_id":"1042"},"paid_late":false,"needs_review":false,"review_reason":null,"transactions":[{"signature":"9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e","asset":"usdt_tron","amount":"24.90","amount_usd":"24.90","amount_coin":"24.9","rate_usd":"1","status":"finalized","confirmations":20,"dust":false,"delivery":"held","from":"TExampLeSenderAddressNotReal12345b","block_time":1767225900,"explorer_url":"https://tronscan.org/#/transaction/9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e"}],"dust_count":0,"created":1767225600,"expires_at":1767227400,"completed_at":1767225912,"closed_at":null}}}}}},"responses":{"2XX":{"description":"Taken. Answer first and do the work after: a slow answer times out and is retried."},"default":{"description":"Anything else, or no answer in time: retried later."}}}},"checkout.session.expired":{"post":{"operationId":"webhook_checkout_session_expired","tags":["Webhooks"],"summary":"checkout.session.expired","description":"The link\u2019s time ran out unpaid. Not sent for a payment link\u2019s payment in which nobody picked a coin.\n\nPOSTed as JSON to every enabled endpoint of the event\u2019s mode that takes its type, with `Webhook-Signature`. Answer any 2xx within 5 seconds; anything else \u2014 a redirect included, which is not followed \u2014 is retried up to 8 times over about 69 hours, then marked failed (send it again from the dashboard or `POST /events/{id}/resend`). The same event can arrive more than once and out of order: keep the `id`s you have handled, and read `status` and `payment_status` from the object. In production ignore events whose `livemode` is false.","security":[],"parameters":[{"$ref":"#/components/parameters/WebhookSignature"},{"name":"User-Agent","in":"header","description":"Who sends it.","schema":{"type":"string","examples":["Orboni-Webhooks/1.0"]}}],"requestBody":{"required":true,"description":"The event. Verify `Webhook-Signature` over the raw body before reading it, and refuse a `t` more than 300 seconds old.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookEvent"},{"type":"object","properties":{"type":{"const":"checkout.session.expired"},"data":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/CheckoutSession"}}}}}]},"example":{"id":"evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz","object":"event","type":"checkout.session.expired","livemode":true,"created":1767225912,"data":{"object":{"id":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","object":"checkout.session","livemode":true,"status":"expired","payment_status":"unpaid","amount_total":2490,"currency":"usd","exchange_rate":null,"amount_received":"0.00","amount_due":"24.90","amount_remaining":"24.90","amount_due_usd":"24.90","amount_received_usd":"0.00","amount_refunded":0,"payment_methods":[],"payment":null,"url":"https://orboni.com/pay/cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","success_url":"https://shop.example/thanks?session=cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","payment_link":null,"customer_email":"buyer@example.com","customer_email_collection":"required","locale":"auto","description":"Pro plan","details":null,"appearance":null,"metadata":{"order_id":"1042"},"paid_late":false,"needs_review":false,"review_reason":null,"transactions":[],"dust_count":0,"created":1767225600,"expires_at":1767227400,"completed_at":null,"closed_at":1767226200}}}}}},"responses":{"2XX":{"description":"Taken. Answer first and do the work after: a slow answer times out and is retried."},"default":{"description":"Anything else, or no answer in time: retried later."}}}},"checkout.session.needs_review":{"post":{"operationId":"webhook_checkout_session_needs_review","tags":["Webhooks"],"summary":"checkout.session.needs_review","description":"Money is held for your review (review_reason; payment_status held): it came after expiry and your project holds late payments for review, far more than asked reached a Bitcoin-style address, it came after a refund or after you closed the link, or in a stablecoin off its dollar. Do not fulfil yet; accept it in the dashboard, and checkout.session.completed follows.\n\nPOSTed as JSON to every enabled endpoint of the event\u2019s mode that takes its type, with `Webhook-Signature`. Answer any 2xx within 5 seconds; anything else \u2014 a redirect included, which is not followed \u2014 is retried up to 8 times over about 69 hours, then marked failed (send it again from the dashboard or `POST /events/{id}/resend`). The same event can arrive more than once and out of order: keep the `id`s you have handled, and read `status` and `payment_status` from the object. In production ignore events whose `livemode` is false.","security":[],"parameters":[{"$ref":"#/components/parameters/WebhookSignature"},{"name":"User-Agent","in":"header","description":"Who sends it.","schema":{"type":"string","examples":["Orboni-Webhooks/1.0"]}}],"requestBody":{"required":true,"description":"The event. Verify `Webhook-Signature` over the raw body before reading it, and refuse a `t` more than 300 seconds old.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookEvent"},{"type":"object","properties":{"type":{"const":"checkout.session.needs_review"},"data":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/CheckoutSession"}}}}}]},"example":{"id":"evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz","object":"event","type":"checkout.session.needs_review","livemode":true,"created":1767225912,"data":{"object":{"id":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","object":"checkout.session","livemode":true,"status":"expired","payment_status":"held","amount_total":2490,"currency":"usd","exchange_rate":null,"amount_received":"24.90","amount_due":"24.90","amount_remaining":"0.00","amount_due_usd":"24.90","amount_received_usd":"24.90","amount_refunded":0,"payment_methods":[],"payment":{"asset":"usdt_tron","chain":"tron","coin":"USDT","amount":"24.9","rate_usd":"1","amount_usd":"24.90","pay_address":"TExampLeAddressDoNotPay1234567890a","memo":null,"quote_expires_at":1767226800},"url":"https://orboni.com/pay/cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","success_url":"https://shop.example/thanks?session=cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","payment_link":null,"customer_email":"buyer@example.com","customer_email_collection":"required","locale":"auto","description":"Pro plan","details":null,"appearance":null,"metadata":{"order_id":"1042"},"paid_late":true,"needs_review":true,"review_reason":"late","transactions":[{"signature":"9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e","asset":"usdt_tron","amount":"24.90","amount_usd":"24.90","amount_coin":"24.9","rate_usd":"1","status":"finalized","confirmations":20,"dust":false,"delivery":"held","from":"TExampLeSenderAddressNotReal12345b","block_time":1767225900,"explorer_url":"https://tronscan.org/#/transaction/9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e"}],"dust_count":0,"created":1767225600,"expires_at":1767227400,"completed_at":null,"closed_at":null}}}}}},"responses":{"2XX":{"description":"Taken. Answer first and do the work after: a slow answer times out and is retried."},"default":{"description":"Anything else, or no answer in time: retried later."}}}},"checkout.session.extra_received":{"post":{"operationId":"webhook_checkout_session_extra_received","tags":["Webhooks"],"summary":"checkout.session.extra_received","description":"More money reached a completed session (a second payment, say): amount_received says how much in all. It is not a second order \u2014 send back what is not owed, then record the refund. Ask the buyer for a refund address on the same network; never send to the address the payment came from (transactions[].from): an exchange\u2019s or a contract\u2019s address does not credit the buyer.\n\nPOSTed as JSON to every enabled endpoint of the event\u2019s mode that takes its type, with `Webhook-Signature`. Answer any 2xx within 5 seconds; anything else \u2014 a redirect included, which is not followed \u2014 is retried up to 8 times over about 69 hours, then marked failed (send it again from the dashboard or `POST /events/{id}/resend`). The same event can arrive more than once and out of order: keep the `id`s you have handled, and read `status` and `payment_status` from the object. In production ignore events whose `livemode` is false.","security":[],"parameters":[{"$ref":"#/components/parameters/WebhookSignature"},{"name":"User-Agent","in":"header","description":"Who sends it.","schema":{"type":"string","examples":["Orboni-Webhooks/1.0"]}}],"requestBody":{"required":true,"description":"The event. Verify `Webhook-Signature` over the raw body before reading it, and refuse a `t` more than 300 seconds old.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookEvent"},{"type":"object","properties":{"type":{"const":"checkout.session.extra_received"},"data":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/CheckoutSession"}}}}}]},"example":{"id":"evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz","object":"event","type":"checkout.session.extra_received","livemode":true,"created":1767225912,"data":{"object":{"id":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","object":"checkout.session","livemode":true,"status":"complete","payment_status":"paid","amount_total":2490,"currency":"usd","exchange_rate":null,"amount_received":"49.80","amount_due":"24.90","amount_remaining":"0.00","amount_due_usd":"24.90","amount_received_usd":"49.80","amount_refunded":0,"payment_methods":[],"payment":{"asset":"usdt_tron","chain":"tron","coin":"USDT","amount":"24.9","rate_usd":"1","amount_usd":"24.90","pay_address":"TExampLeAddressDoNotPay1234567890a","memo":null,"quote_expires_at":1767226800},"url":"https://orboni.com/pay/cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","success_url":"https://shop.example/thanks?session=cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","payment_link":null,"customer_email":"buyer@example.com","customer_email_collection":"required","locale":"auto","description":"Pro plan","details":null,"appearance":null,"metadata":{"order_id":"1042"},"paid_late":false,"needs_review":false,"review_reason":null,"transactions":[{"signature":"9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e","asset":"usdt_tron","amount":"24.90","amount_usd":"24.90","amount_coin":"24.9","rate_usd":"1","status":"finalized","confirmations":20,"dust":false,"delivery":"held","from":"TExampLeSenderAddressNotReal12345b","block_time":1767225900,"explorer_url":"https://tronscan.org/#/transaction/9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e"}],"dust_count":0,"created":1767225600,"expires_at":1767227400,"completed_at":1767225912,"closed_at":null}}}}}},"responses":{"2XX":{"description":"Taken. Answer first and do the work after: a slow answer times out and is retried."},"default":{"description":"Anything else, or no answer in time: retried later."}}}},"checkout.session.payment_reversed":{"post":{"operationId":"webhook_checkout_session_payment_reversed","tags":["Webhooks"],"summary":"checkout.session.payment_reversed","description":"A transfer that had counted as final left the chain (a reorg, or a double-spend on a Bitcoin-style network): its status is reversed and amount_received no longer counts it. If what is left no longer pays the session, it is held for your review (review_reason reversed) and no longer complete: do not fulfil on it, and check an order you already did. It counts again if it is mined again.\n\nPOSTed as JSON to every enabled endpoint of the event\u2019s mode that takes its type, with `Webhook-Signature`. Answer any 2xx within 5 seconds; anything else \u2014 a redirect included, which is not followed \u2014 is retried up to 8 times over about 69 hours, then marked failed (send it again from the dashboard or `POST /events/{id}/resend`). The same event can arrive more than once and out of order: keep the `id`s you have handled, and read `status` and `payment_status` from the object. In production ignore events whose `livemode` is false.","security":[],"parameters":[{"$ref":"#/components/parameters/WebhookSignature"},{"name":"User-Agent","in":"header","description":"Who sends it.","schema":{"type":"string","examples":["Orboni-Webhooks/1.0"]}}],"requestBody":{"required":true,"description":"The event. Verify `Webhook-Signature` over the raw body before reading it, and refuse a `t` more than 300 seconds old.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookEvent"},{"type":"object","properties":{"type":{"const":"checkout.session.payment_reversed"},"data":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/CheckoutSession"}}}}}]},"example":{"id":"evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz","object":"event","type":"checkout.session.payment_reversed","livemode":true,"created":1767225912,"data":{"object":{"id":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","object":"checkout.session","livemode":true,"status":"expired","payment_status":"held","amount_total":2490,"currency":"usd","exchange_rate":null,"amount_received":"0.00","amount_due":"24.90","amount_remaining":"24.90","amount_due_usd":"24.90","amount_received_usd":"0.00","amount_refunded":0,"payment_methods":[],"payment":{"asset":"usdt_tron","chain":"tron","coin":"USDT","amount":"24.9","rate_usd":"1","amount_usd":"24.90","pay_address":"TExampLeAddressDoNotPay1234567890a","memo":null,"quote_expires_at":1767226800},"url":"https://orboni.com/pay/cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","success_url":"https://shop.example/thanks?session=cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","cancel_url":"https://shop.example/cart","client_reference_id":"order_1042","payment_link":null,"customer_email":"buyer@example.com","customer_email_collection":"required","locale":"auto","description":"Pro plan","details":null,"appearance":null,"metadata":{"order_id":"1042"},"paid_late":false,"needs_review":true,"review_reason":"reversed","transactions":[{"signature":"9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e","asset":"usdt_tron","amount":"24.90","amount_usd":"24.90","amount_coin":"24.9","rate_usd":"1","status":"reversed","confirmations":20,"dust":false,"delivery":"held","from":"TExampLeSenderAddressNotReal12345b","block_time":1767225900,"explorer_url":"https://tronscan.org/#/transaction/9f2c4e6a8b0d1f3e5a7c9b1d3f5e7a9c1b3d5f7e9a1c3b5d7f9e1a3c5b7d9f1e"}],"dust_count":0,"created":1767225600,"expires_at":1767227400,"completed_at":null,"closed_at":null}}}}}},"responses":{"2XX":{"description":"Taken. Answer first and do the work after: a slow answer times out and is retried."},"default":{"description":"Anything else, or no answer in time: retried later."}}}},"refund.created":{"post":{"operationId":"webhook_refund_created","tags":["Webhooks"],"summary":"refund.created","description":"You recorded a refund. data.object is the refund, not the session.\n\nPOSTed as JSON to every enabled endpoint of the event\u2019s mode that takes its type, with `Webhook-Signature`. Answer any 2xx within 5 seconds; anything else \u2014 a redirect included, which is not followed \u2014 is retried up to 8 times over about 69 hours, then marked failed (send it again from the dashboard or `POST /events/{id}/resend`). The same event can arrive more than once and out of order: keep the `id`s you have handled, and read `status` and `payment_status` from the object. In production ignore events whose `livemode` is false.","security":[],"parameters":[{"$ref":"#/components/parameters/WebhookSignature"},{"name":"User-Agent","in":"header","description":"Who sends it.","schema":{"type":"string","examples":["Orboni-Webhooks/1.0"]}}],"requestBody":{"required":true,"description":"The event. Verify `Webhook-Signature` over the raw body before reading it, and refuse a `t` more than 300 seconds old.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookEvent"},{"type":"object","properties":{"type":{"const":"refund.created"},"data":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/Refund"}}}}}]},"example":{"id":"evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz","object":"event","type":"refund.created","livemode":true,"created":1767225912,"data":{"object":{"id":"re_7Qd2Hf5Jk8Lm1Np4Rs6Tv9Wx","object":"refund","livemode":true,"amount":990,"currency":"usd","checkout_session":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","reason":"requested_by_customer","transaction":"5h9xExampleRefundTransferHash","note":null,"metadata":{},"source":"api","status":"succeeded","voided_at":null,"created":1767312000}}}}}},"responses":{"2XX":{"description":"Taken. Answer first and do the work after: a slow answer times out and is retried."},"default":{"description":"Anything else, or no answer in time: retried later."}}}},"refund.voided":{"post":{"operationId":"webhook_refund_voided","tags":["Webhooks"],"summary":"refund.voided","description":"A refund recorded by mistake was voided: it no longer counts in amount_refunded. data.object is the refund, with status voided.\n\nPOSTed as JSON to every enabled endpoint of the event\u2019s mode that takes its type, with `Webhook-Signature`. Answer any 2xx within 5 seconds; anything else \u2014 a redirect included, which is not followed \u2014 is retried up to 8 times over about 69 hours, then marked failed (send it again from the dashboard or `POST /events/{id}/resend`). The same event can arrive more than once and out of order: keep the `id`s you have handled, and read `status` and `payment_status` from the object. In production ignore events whose `livemode` is false.","security":[],"parameters":[{"$ref":"#/components/parameters/WebhookSignature"},{"name":"User-Agent","in":"header","description":"Who sends it.","schema":{"type":"string","examples":["Orboni-Webhooks/1.0"]}}],"requestBody":{"required":true,"description":"The event. Verify `Webhook-Signature` over the raw body before reading it, and refuse a `t` more than 300 seconds old.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookEvent"},{"type":"object","properties":{"type":{"const":"refund.voided"},"data":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/Refund"}}}}}]},"example":{"id":"evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz","object":"event","type":"refund.voided","livemode":true,"created":1767225912,"data":{"object":{"id":"re_7Qd2Hf5Jk8Lm1Np4Rs6Tv9Wx","object":"refund","livemode":true,"amount":990,"currency":"usd","checkout_session":"cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6","reason":"requested_by_customer","transaction":"5h9xExampleRefundTransferHash","note":null,"metadata":{},"source":"api","status":"voided","voided_at":1767315600,"created":1767312000}}}}}},"responses":{"2XX":{"description":"Taken. Answer first and do the work after: a slow answer times out and is retried."},"default":{"description":"Anything else, or no answer in time: retried later."}}}}},"components":{"securitySchemes":{"secretKey":{"type":"http","scheme":"bearer","bearerFormat":"sk_live_\u2026 or sk_test_\u2026","description":"Your secret key as a bearer token: `Authorization: Bearer sk_live_\u2026`. A key\u2019s prefix is its mode: `sk_test_\u2026` keys make and see only test objects (`cs_test_\u2026`, test events, test refunds), `sk_live_\u2026` keys only live ones; the two never meet. Keys are per project and per mode, made and revoked in the dashboard under Developers \u2192 API keys, shown once. Keep a secret key on your server, never in a browser or an app. A missing, wrong or revoked key answers `401 authentication_error`; 60 such calls a minute from one address and the next answer `429`. A suspended or closed account, or a live key of an account whose email is not confirmed, answers `403 permission_error`."},"secretKeyBasic":{"type":"http","scheme":"basic","description":"The same secret key as the user of HTTP basic auth with an empty password (`curl -u sk_live_\u2026:`), as Stripe\u2019s client libraries send it. A key\u2019s prefix is its mode: `sk_test_\u2026` keys make and see only test objects (`cs_test_\u2026`, test events, test refunds), `sk_live_\u2026` keys only live ones; the two never meet. Keys are per project and per mode, made and revoked in the dashboard under Developers \u2192 API keys, shown once. Keep a secret key on your server, never in a browser or an app."},"publishableKey":{"type":"apiKey","in":"query","name":"key","description":"The project\u2019s publishable key, `pk_live_\u2026` or `pk_test_\u2026` (Developers \u2192 API keys). Safe on a public page: it is good only for `GET /public/payment_methods` and makes, reads or changes nothing else. Its prefix is its mode."}},"parameters":{"IdempotencyKey":{"name":"Idempotency-Key","in":"header","required":false,"description":"Makes a POST safe to retry \u2014 your order ID is a good one. A successful answer is kept for 24 hours, per project and mode, and a retry with the same key gets it again with `Idempotent-Replayed: true` instead of a second session or refund. The same key with other parameters is refused (`400 idempotency_error`); the same parameters in another order are the same request. While the first request is still running a second one gets `409 idempotency_error`; one that never finishes gives its key up 15 minutes after it was sent. Only a success is kept: after a 4xx or 5xx a retry with the same key runs again. Ignored on GET.","schema":{"type":"string","minLength":1,"maxLength":255,"examples":["order_1042"]}},"Limit":{"name":"limit","in":"query","description":"How many objects a page holds.","schema":{"type":"integer","minimum":1,"maximum":100,"default":10}},"StartingAfter":{"name":"starting_after","in":"query","description":"The last ID of the page you have: answers the next, older page. Not with `ending_before`.","schema":{"type":"string"}},"EndingBefore":{"name":"ending_before","in":"query","description":"The first ID of the page you have: answers the page before it. Not with `starting_after`.","schema":{"type":"string"}},"Created":{"name":"created","in":"query","style":"deepObject","explode":true,"description":"When the object was made, in Unix seconds (not milliseconds; ten digits at most): `created[gte]=1767225600`, also `gt`, `lt` and `lte`, together if you like. A plain `created=1767225600` is that second exactly.","schema":{"type":"object","properties":{"gt":{"type":"integer","minimum":0,"maximum":9999999999},"gte":{"type":"integer","minimum":0,"maximum":9999999999},"lt":{"type":"integer","minimum":0,"maximum":9999999999},"lte":{"type":"integer","minimum":0,"maximum":9999999999}},"additionalProperties":false}},"MethodsAmount":{"name":"amount","in":"query","description":"What a session would ask, in `currency`\u2019s smallest unit: leaves out the methods whose `minimum_amount` is above what it is worth.","schema":{"type":"integer","minimum":1,"maximum":1000000000000000,"examples":[2490]}},"MethodsCurrency":{"name":"currency","in":"query","description":"The currency of `amount`, as on a session; usd by default. One without a current rate answers `503 rate_unavailable`.","schema":{"type":"string","enum":["usd","eur","gbp","chf","pln","czk","huf","ron","dkk","sek","nok","isk","try","jpy","krw","cny","hkd","sgd","inr","idr","myr","php","thb","ils","aud","nzd","cad","mxn","brl","zar","uah","ars","clp","aed","sar","twd","vnd","USD","EUR","GBP","CHF","PLN","CZK","HUF","RON","DKK","SEK","NOK","ISK","TRY","JPY","KRW","CNY","HKD","SGD","INR","IDR","MYR","PHP","THB","ILS","AUD","NZD","CAD","MXN","BRL","ZAR","UAH","ARS","CLP","AED","SAR","TWD","VND"],"default":"usd"}},"WebhookSignature":{"name":"Webhook-Signature","in":"header","required":true,"description":"`t=<unix seconds>,v1=<hex>`: `v1` is the hex HMAC-SHA256 of `{t}.{raw body}` keyed with the endpoint\u2019s signing secret (`whsec_\u2026`, under the endpoint in the dashboard) \u2014 Stripe\u2019s scheme. Compare in constant time over the raw body as received, and refuse a `t` more than 300 seconds old. For 24 hours after the secret is rolled the old one signs too, so the header carries one `v1` per secret (`t=\u2026,v1=\u2026,v1=\u2026`): accept it when any matches.","schema":{"type":"string","pattern":"^t=\\d+(,v1=[0-9a-f]{64})+$","examples":["t=1767225912,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd"]}}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Limit":{"description":"The requests a minute this limit allows.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"The requests left in this minute.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix seconds at which the limit lets requests through again.","schema":{"type":"integer"}},"Idempotent-Replayed":{"description":"`true` when this is the kept answer to an earlier request with the same `Idempotency-Key`.","schema":{"type":"string","enum":["true"]}},"AccessControlAllowOrigin":{"description":"`*`: any site may read it.","schema":{"type":"string","enum":["*"]}}},"responses":{"Unauthorized":{"description":"`authentication_error`: No key, a wrong one or a revoked one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"invalid_key":{"summary":"No key, a wrong one or a revoked one.","value":{"error":{"type":"authentication_error","message":"Invalid API key provided."}}}}}}},"Forbidden":{"description":"`permission_error`: The account is suspended.\n\n`permission_error`: The project\u2019s account was deleted: its keys no longer work.\n\n`permission_error`: A live key of an account whose email address is not confirmed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"suspended":{"summary":"The account is suspended.","value":{"error":{"type":"permission_error","message":"This account is suspended. Write to support."}}},"closed":{"summary":"The project\u2019s account was deleted: its keys no longer work.","value":{"error":{"type":"permission_error","message":"This account is closed."}}},"live_unverified":{"summary":"A live key of an account whose email address is not confirmed.","value":{"error":{"type":"permission_error","message":"Live keys need the account's email address confirmed. Confirm it from the notice in the dashboard; test keys keep working."}}}}}}},"ForbiddenWrite":{"description":"`receiving_frozen`: Live keys only: the owner froze receiving; live keys only read until it is unfrozen.\n\n`permission_error`: The account is suspended.\n\n`permission_error`: The project\u2019s account was deleted: its keys no longer work.\n\n`permission_error`: A live key of an account whose email address is not confirmed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"frozen":{"summary":"Live keys only: the owner froze receiving; live keys only read until it is unfrozen.","value":{"error":{"type":"receiving_frozen","message":"The account owner froze receiving after a wallet or email change: live keys only read until they unfreeze it in the dashboard under Wallets."}}},"suspended":{"summary":"The account is suspended.","value":{"error":{"type":"permission_error","message":"This account is suspended. Write to support."}}},"closed":{"summary":"The project\u2019s account was deleted: its keys no longer work.","value":{"error":{"type":"permission_error","message":"This account is closed."}}},"live_unverified":{"summary":"A live key of an account whose email address is not confirmed.","value":{"error":{"type":"permission_error","message":"Live keys need the account's email address confirmed. Confirm it from the notice in the dashboard; test keys keep working."}}}}}}},"IdempotencyConflict":{"description":"`idempotency_error`: The first request with this `Idempotency-Key` is still running; retry in a moment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"idem_in_progress":{"summary":"The first request with this `Idempotency-Key` is still running; retry in a moment.","value":{"error":{"type":"idempotency_error","message":"A request with this Idempotency-Key is still being processed. Retry in a moment; one that never finishes gives the key up 15 minutes after it was sent."}}}}}}},"PayloadTooLarge":{"description":"`invalid_request_error`: A request body over 64 KB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"body_too_large":{"summary":"A request body over 64 KB.","value":{"error":{"type":"invalid_request_error","message":"The request body is too large: at most 64 KB."}}}}}}},"TooManyRequests":{"description":"`rate_limit_error`: Over the API\u2019s rate limit.\n\n`rate_limit_error`: Over 60 calls a minute with a wrong key from one address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"rate_limited":{"summary":"Over the API\u2019s rate limit.","value":{"error":{"type":"rate_limit_error","message":"Too many requests. Slow down and retry after the Retry-After header\u2019s seconds."}}},"auth_flood":{"summary":"Over 60 calls a minute with a wrong key from one address.","value":{"error":{"type":"rate_limit_error","message":"Too many requests with an invalid API key. Retry after the Retry-After header\u2019s seconds."}}}}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"InternalServerError":{"description":"`api_error`: An error of ours. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"server_error":{"summary":"An error of ours. Retry.","value":{"error":{"type":"api_error","message":"Something went wrong on our side. Retry; with an Idempotency-Key a retry is safe."}}}}}}},"ServiceUnavailable":{"description":"`api_error`: An update in progress; `Retry-After` says when to come back.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"maintenance":{"summary":"An update in progress; `Retry-After` says when to come back.","value":{"error":{"type":"api_error","message":"Orboni is being updated. Retry after the Retry-After header\u2019s seconds; with an Idempotency-Key a retry is safe."}}}}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"}}}},"schemas":{"Error":{"type":"object","description":"Every error, in Stripe\u2019s shape. Branch on `type` (and the status), never on `message`, whose words may change.","required":["error"],"properties":{"error":{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","enum":["invalid_request_error","idempotency_error","authentication_error","permission_error","receiving_frozen","account_past_due","amount_too_small","rate_limit_error","rate_unavailable","api_error"],"description":"`invalid_request_error` (400, 404, 413, 422): a bad parameter \u2014 `param` names it \u2014, no such object or URL, or a body too large. `idempotency_error` (400, 409): an `Idempotency-Key` reused with other parameters, or its first request still running. `authentication_error` (401): no key, a wrong one or a revoked one. `permission_error` (403): a suspended or closed account, or a live key before the account\u2019s email is confirmed. `receiving_frozen` (403): live keys only read while the owner has frozen receiving. `account_past_due` (402): live only, an Orboni invoice is past due. `amount_too_small` (422): under the minimum of every network the session could be paid on. `rate_limit_error` (429): too many requests or open sessions; wait `Retry-After` seconds. `rate_unavailable` (503): no current exchange rate for the price\u2019s currency. `api_error` (500, 503): ours, or an update in progress. Retry; with an `Idempotency-Key` it is safe."},"message":{"type":"string","description":"What went wrong, in English, for a person."},"param":{"type":"string","description":"The parameter at fault, when there is one."}}}}},"Metadata":{"type":"object","description":"Up to 50 string values of your own, returned as given: keys up to 40 characters, values up to 500, 8 KB in all as JSON (a character outside ASCII counts as 6 bytes).","maxProperties":50,"propertyNames":{"maxLength":40},"additionalProperties":{"type":["string","null"],"maxLength":500},"examples":[{"order_id":"1042"}]},"ExchangeRate":{"type":"object","description":"What a price was turned into US dollars at.","required":["usd","date","source"],"properties":{"usd":{"type":"string","pattern":"^\\d+(\\.\\d+)?$","description":"US dollars for one unit of the currency. A decimal string.","examples":["1.1052"]},"date":{"type":["string","null"],"format":"date","description":"The day of that rate."},"source":{"type":"string","enum":["ecb","coingecko"],"description":"`ecb`: the European Central Bank\u2019s reference rate; `coingecko`: the market\u2019s, for a currency the ECB does not publish."}}},"CheckoutSession":{"type":"object","description":"A checkout session: one payment you wait for.","required":["id","object","livemode","status","payment_status","amount_total","currency","exchange_rate","amount_received","amount_due","amount_remaining","amount_due_usd","amount_received_usd","amount_refunded","payment_methods","payment","url","success_url","cancel_url","client_reference_id","payment_link","customer_email","customer_email_collection","locale","description","details","appearance","metadata","paid_late","needs_review","review_reason","transactions","dust_count","created","expires_at","completed_at","closed_at"],"properties":{"id":{"type":"string","pattern":"^cs_(live|test)_[A-Za-z0-9]{32}$","description":"`cs_live_\u2026` or `cs_test_\u2026`: the prefix is the mode.","examples":["cs_live_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6"]},"object":{"const":"checkout.session"},"livemode":{"type":"boolean","description":"false for a test session: never fulfil a real order on it."},"status":{"type":"string","enum":["open","complete","expired"],"description":"`open` \u2014 waiting; `complete` \u2014 paid, final; `expired` \u2014 its time ran out unpaid (still watched for a late payment). An expired session with `payment_status` `held` is not unpaid: the money is there and waits for your review."},"payment_status":{"type":"string","enum":["unpaid","processing","partially_paid","paid","held"],"description":"`unpaid`; `processing` \u2014 a transfer is seen, not final yet; `partially_paid` \u2014 final but short (the rest is `amount_remaining`); `held` \u2014 held for your review (`needs_review`), not to fulfil on yet; `paid` \u2014 only ever with `status` `complete`: fulfil on it."},"amount_total":{"type":"integer","description":"What you asked, in the currency\u2019s smallest unit, as you sent it."},"currency":{"type":"string","enum":["usd","eur","gbp","chf","pln","czk","huf","ron","dkk","sek","nok","isk","try","jpy","krw","cny","hkd","sgd","inr","idr","myr","php","thb","ils","aud","nzd","cad","mxn","brl","zar","uah","ars","clp","aed","sar","twd","vnd"],"description":"The price\u2019s currency, lower case. Every `amount_\u2026` without `_usd` is in it."},"exchange_rate":{"oneOf":[{"$ref":"#/components/schemas/ExchangeRate"},{"type":"null"}],"description":"null for usd; else what the price was turned into US dollars at when the session was made."},"amount_received":{"type":"string","pattern":"^\\d+(\\.\\d+)?$","description":"Received in all coins together, in the session\u2019s currency: each transfer at the rate quoted when it was sent, then at `exchange_rate`. Money after completion still adds to it (`checkout.session.extra_received`); a reversed transfer no longer does. A decimal string.","examples":["24.90"]},"amount_due":{"type":"string","pattern":"^\\d+(\\.\\d+)?$","description":"The total asked, as a decimal in the session\u2019s currency (\"24.90\", \"1500\" for yen). It does not go down as money arrives. A decimal string.","examples":["24.90"]},"amount_remaining":{"type":"string","pattern":"^\\d+(\\.\\d+)?$","description":"Still to send, in the session\u2019s currency; zero once what arrived counts as paid (within the project\u2019s underpayment tolerance). A decimal string.","examples":["0.00"]},"amount_due_usd":{"type":"string","pattern":"^\\d+(\\.\\d+)?$","description":"`amount_due` in US dollars: what every coin is counted against. A decimal string.","examples":["24.90"]},"amount_received_usd":{"type":"string","pattern":"^\\d+(\\.\\d+)?$","description":"`amount_received` in US dollars. A decimal string.","examples":["24.90"]},"amount_refunded":{"type":"integer","minimum":0,"description":"What you have recorded as sent back, in the currency\u2019s smallest unit (see Refunds)."},"payment_methods":{"type":"array","items":{"type":"string","enum":["usdt_tron","usdt_ethereum","usdt_bsc","usdt_solana","usdt_ton","usdt_polygon","usdt_arbitrum","usdt_optimism","usdt_avalanche","usdc_ethereum","usdc_base","usdc_solana","usdc_polygon","usdc_arbitrum","usdc_optimism","usdc_avalanche","usdc_bsc","usdc_stellar","btc","eth","eth_base","eth_arbitrum","eth_optimism","bnb","sol","ton","trx","pol","avax","ltc","doge","bch","xrp","xlm","pyusd_ethereum","pyusd_arbitrum","dai_ethereum","dai_arbitrum","dai_optimism","dai_polygon"]},"description":"The ways to pay the session was made with; empty for every one the project takes."},"payment":{"oneOf":[{"$ref":"#/components/schemas/CheckoutSessionPayment"},{"type":"null"}],"description":"What it is paid with: the coin most of the counted money came in, else the one the buyer picked last; null before any pick."},"url":{"type":"string","format":"uri","description":"The payment page to send the buyer to."},"success_url":{"type":["string","null"],"format":"uri","description":"Where the page sends the buyer once paid, `{CHECKOUT_SESSION_ID}` replaced."},"cancel_url":{"type":["string","null"],"format":"uri","description":"Where the page\u2019s back link goes."},"client_reference_id":{"type":["string","null"],"description":"Your order number."},"payment_link":{"type":["string","null"],"description":"The payment link (`plink_\u2026`) a buyer opened it from, or null for a session your server made."},"customer_email":{"type":["string","null"],"format":"email","description":"The buyer\u2019s email: yours, or the one they gave on the page."},"customer_email_collection":{"type":"string","enum":["required","optional","off"],"description":"Whether the page asks the buyer for an email before where to pay."},"locale":{"type":"string","description":"The page\u2019s language; `auto` is the buyer\u2019s own."},"description":{"type":["string","null"],"description":"What is paid for, shown to the buyer."},"details":{"type":["string","null"],"description":"What the buyer gets, shown under `description` on the payment page only."},"appearance":{"type":["string","null"],"enum":["auto","light","dark",null],"description":"The page\u2019s light or dark; null: the project\u2019s setting."},"metadata":{"$ref":"#/components/schemas/Metadata"},"paid_late":{"type":"boolean","description":"The money came after the link expired."},"needs_review":{"type":"boolean","description":"The payment is held for you to accept in the dashboard; the session then completes."},"review_reason":{"type":["string","null"],"enum":["late","amount","refunded","closed","peg","withdrawn","handed_over","reversed","memo",null],"description":"Why it was held, and stays once accepted; null when never held. `late` \u2014 the money came after expiry and the project reviews late payments; `amount` \u2014 far more came than was asked: it may be somebody else's payment; `refunded` \u2014 the merchant had refunded money of it before it was paid in full; `closed` \u2014 the merchant had closed the link by hand: the order may be cancelled; `peg` \u2014 the stablecoin it came in was trading away from the dollar; `withdrawn` \u2014 money came to an address a freeze withdrew: whoever froze the account may have put that wallet there, so it may not be the merchant's money at all; `handed_over` \u2014 the link was made before its account passed to whoever proved the email: we closed it then, and the money may be the earlier holder's customer's; `reversed` \u2014 money that had counted as final left the chain, and what is left no longer pays it, or it was held already; `memo` \u2014 the money came with a memo one slip off this payment's (a digit wrong, two swapped, one missing or one too many), for exactly its amount: most likely the buyer's, but only the merchant can say so."},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"},"description":"Every transfer seen, oldest first, and the first 20 worth less than a cent (`dust`)."},"dust_count":{"type":"integer","minimum":0,"description":"How many transfers worth less than a cent came, in all: never counted."},"created":{"type":"integer","description":"When it was made. Unix seconds."},"expires_at":{"type":"integer","description":"When the link runs out. Unix seconds."},"completed_at":{"type":["integer","null"],"description":"When it completed. Unix seconds."},"closed_at":{"type":["integer","null"],"description":"When you closed the link (expire); whatever arrives after is held for review. Unix seconds."}}},"CheckoutSessionPayment":{"type":"object","required":["asset","chain","coin","amount","rate_usd","amount_usd","pay_address","memo","quote_expires_at"],"properties":{"asset":{"type":"string","enum":["usdt_tron","usdt_ethereum","usdt_bsc","usdt_solana","usdt_ton","usdt_polygon","usdt_arbitrum","usdt_optimism","usdt_avalanche","usdc_ethereum","usdc_base","usdc_solana","usdc_polygon","usdc_arbitrum","usdc_optimism","usdc_avalanche","usdc_bsc","usdc_stellar","btc","eth","eth_base","eth_arbitrum","eth_optimism","bnb","sol","ton","trx","pol","avax","ltc","doge","bch","xrp","xlm","pyusd_ethereum","pyusd_arbitrum","dai_ethereum","dai_arbitrum","dai_optimism","dai_polygon"],"description":"The coin on its network, as in `payment_methods`."},"chain":{"type":"string","enum":["solana","tron","ethereum","bsc","base","polygon","arbitrum","optimism","avalanche","ton","bitcoin","litecoin","dogecoin","bitcoincash","xrp","stellar"]},"coin":{"type":["string","null"],"description":"Its symbol, as USDT."},"amount":{"type":"string","pattern":"^\\d+(\\.\\d+)?$","description":"In the coin: what arrived, or what is asked while nothing has. A decimal string.","examples":["24.9"]},"rate_usd":{"type":"string","pattern":"^\\d+(\\.\\d+)?$","description":"The coin\u2019s US dollar rate quoted; \"1\" for a stablecoin. A decimal string.","examples":["1"]},"amount_usd":{"type":"string","pattern":"^\\d+(\\.\\d+)?$","description":"What arrived in it, in US dollars. A decimal string.","examples":["24.90"]},"pay_address":{"type":["string","null"],"description":"Where the buyer pays; null for an address a freeze withdrew."},"memo":{"type":["string","null"],"description":"The memo, tag or comment the payment must carry, on networks that use one."},"quote_expires_at":{"type":["integer","null"],"description":"Until when the quoted rate holds. Unix seconds."}}},"Transaction":{"type":"object","description":"One transfer to the payment\u2019s address, as the chain reports it.","required":["signature","asset","amount","amount_usd","amount_coin","rate_usd","status","confirmations","dust","delivery","from","block_time","explorer_url"],"properties":{"signature":{"type":"string","description":"The transaction\u2019s hash (a signature on Solana); `sim_\u2026` for one made by the simulator."},"asset":{"type":["string","null"],"description":"The coin on its network, as in `payment_methods`."},"amount":{"type":"string","pattern":"^\\d+(\\.\\d+)?$","description":"What it counted for, in the session\u2019s currency. A decimal string.","examples":["24.90"]},"amount_usd":{"type":"string","pattern":"^\\d+(\\.\\d+)?$","description":"The same in US dollars. A decimal string.","examples":["24.90"]},"amount_coin":{"type":["string","null"],"pattern":"^\\d+(\\.\\d+)?$","description":"In the coin, with its own decimals."},"rate_usd":{"type":["string","null"],"description":"The coin\u2019s US dollar rate it was counted at."},"status":{"type":"string","enum":["confirmed","finalized","reversed"],"description":"`confirmed` \u2014 seen, not final yet; `finalized` \u2014 final, it counts; `reversed` \u2014 it left the chain after it had counted and no longer counts."},"confirmations":{"type":["integer","null"],"description":"Blocks since it, as last read."},"dust":{"type":"boolean","description":"Worth less than a cent: on record, in no sum."},"delivery":{"type":["string","null"],"enum":["waiting","held","sending","delivered","left",null],"description":"On Ethereum, its relatives and TRON, where the money is: `waiting` \u2014 not final yet; `held` \u2014 final, at the payment\u2019s own address; `sending` \u2014 a withdrawal is on its way; `delivered` \u2014 in your wallet; `left` \u2014 withdrawn to the wallet the payment was quoted for, which is no longer the project\u2019s. null on networks that pay your wallet directly."},"from":{"type":["string","null"],"description":"The address it came from. Never a refund address."},"block_time":{"type":["integer","null"],"description":"The time of its block; null while unconfirmed. Unix seconds."},"explorer_url":{"type":["string","null"],"format":"uri","description":"The transaction on the network\u2019s explorer; null for a simulated one."}}},"Refund":{"type":"object","description":"A refund the merchant sent from its own wallet and recorded.","required":["id","object","livemode","amount","currency","checkout_session","reason","transaction","note","metadata","source","status","voided_at","created"],"properties":{"id":{"type":"string","pattern":"^re_[A-Za-z0-9]{24}$","examples":["re_7Qd2Hf5Jk8Lm1Np4Rs6Tv9Wx"]},"object":{"const":"refund"},"livemode":{"type":"boolean"},"amount":{"type":"integer","minimum":1,"description":"In the smallest unit of the session\u2019s currency."},"currency":{"type":"string","enum":["usd","eur","gbp","chf","pln","czk","huf","ron","dkk","sek","nok","isk","try","jpy","krw","cny","hkd","sgd","inr","idr","myr","php","thb","ils","aud","nzd","cad","mxn","brl","zar","uah","ars","clp","aed","sar","twd","vnd"],"description":"The session\u2019s currency."},"checkout_session":{"type":"string","description":"The session refunded."},"reason":{"type":["string","null"],"enum":["requested_by_customer","duplicate","fraudulent","overpaid","other",null]},"transaction":{"type":["string","null"],"description":"The hash of the refund transfer, or any reference you keep."},"note":{"type":["string","null"]},"metadata":{"$ref":"#/components/schemas/Metadata"},"source":{"type":"string","enum":["api","dashboard"],"description":"Where it was recorded."},"status":{"type":"string","enum":["succeeded","voided"],"description":"`voided` once a refund recorded by mistake was voided: it no longer counts."},"voided_at":{"type":["integer","null"],"description":"When it was voided. Unix seconds."},"created":{"type":"integer","description":"When it was recorded. Unix seconds."}}},"PaymentLink":{"type":"object","description":"A payment link.","required":["id","object","livemode","url","active","status","amount","currency","custom_amount","min_amount","max_amount","max_payments","payments_paid","expires_at","description","details","success_url","created"],"properties":{"id":{"type":"string","pattern":"^plink_[A-Za-z0-9]{24}$","examples":["plink_3Hc9Kd2Lf5Mg8Nh1Pj4Qk7Rm"]},"object":{"const":"payment_link"},"livemode":{"type":"boolean"},"url":{"type":"string","format":"uri","description":"The address to share."},"active":{"type":"boolean","description":"The switch you turn; `status` says whether it takes payments."},"status":{"type":"string","enum":["active","inactive","expired","completed"],"description":"`active`; `inactive` \u2014 switched off; `expired` \u2014 past `expires_at`; `completed` \u2014 `payments_paid` reached `max_payments`."},"amount":{"type":["integer","null"],"description":"In the currency\u2019s smallest unit; with `custom_amount`, the amount suggested to the buyer, or null."},"currency":{"type":"string","enum":["usd","eur","gbp","chf","pln","czk","huf","ron","dkk","sek","nok","isk","try","jpy","krw","cny","hkd","sgd","inr","idr","myr","php","thb","ils","aud","nzd","cad","mxn","brl","zar","uah","ars","clp","aed","sar","twd","vnd"]},"custom_amount":{"type":"boolean","description":"The buyer types the amount."},"min_amount":{"type":["integer","null"],"description":"With `custom_amount`: the least the buyer may pay; null otherwise or for the default."},"max_amount":{"type":["integer","null"],"description":"With `custom_amount`: the most the buyer may pay; null otherwise or for the default."},"max_payments":{"type":["integer","null"],"description":"It takes no new payment once this many are paid."},"payments_paid":{"type":"integer","minimum":0,"description":"Its sessions that completed."},"expires_at":{"type":["integer","null"],"description":"It takes no new payment from then on. Unix seconds."},"description":{"type":"string"},"details":{"type":["string","null"]},"success_url":{"type":["string","null"],"format":"uri"},"created":{"type":"integer","description":"When it was made. Unix seconds."}}},"PaymentMethod":{"type":"object","description":"A way to pay: a coin on a network.","required":["object","key","coin","name","chain","chain_name","stable","from_exchange","minimum_amount","simulated_only"],"properties":{"object":{"const":"payment_method"},"key":{"type":"string","enum":["usdt_tron","usdt_ethereum","usdt_bsc","usdt_solana","usdt_ton","usdt_polygon","usdt_arbitrum","usdt_optimism","usdt_avalanche","usdc_ethereum","usdc_base","usdc_solana","usdc_polygon","usdc_arbitrum","usdc_optimism","usdc_avalanche","usdc_bsc","usdc_stellar","btc","eth","eth_base","eth_arbitrum","eth_optimism","bnb","sol","ton","trx","pol","avax","ltc","doge","bch","xrp","xlm","pyusd_ethereum","pyusd_arbitrum","dai_ethereum","dai_arbitrum","dai_optimism","dai_polygon"],"description":"What `payment_methods` on a session takes."},"coin":{"type":"string","description":"The coin\u2019s symbol, as USDT. One coin on several networks is several methods."},"name":{"type":"string","description":"The coin\u2019s name, as Tether."},"chain":{"type":"string","enum":["solana","tron","ethereum","bsc","base","polygon","arbitrum","optimism","avalanche","ton","bitcoin","litecoin","dogecoin","bitcoincash","xrp","stellar"],"description":"Its network."},"chain_name":{"type":"string","description":"The network\u2019s name, as TRON."},"stable":{"type":"boolean","description":"A dollar stablecoin, priced 1:1."},"from_exchange":{"type":"boolean","description":"It can be sent from an exchange account, not only from a wallet."},"minimum_amount":{"type":["integer","null"],"description":"US cents, whatever the currency asked about: the least a session paid in it may be worth now. It follows the network\u2019s fees, so read it again rather than keep it. null: any amount from $1."},"simulated_only":{"type":"boolean","description":"Test mode: no test network is watched for it, so it is paid only with Simulate payment."}}},"PublicPaymentMethod":{"type":"object","description":"A way to pay, as a buyer\u2019s page may see it.","required":["object","key","coin","name","chain","chain_name","stable","from_exchange","minimum_amount"],"properties":{"object":{"const":"payment_method"},"key":{"type":"string","enum":["usdt_tron","usdt_ethereum","usdt_bsc","usdt_solana","usdt_ton","usdt_polygon","usdt_arbitrum","usdt_optimism","usdt_avalanche","usdc_ethereum","usdc_base","usdc_solana","usdc_polygon","usdc_arbitrum","usdc_optimism","usdc_avalanche","usdc_bsc","usdc_stellar","btc","eth","eth_base","eth_arbitrum","eth_optimism","bnb","sol","ton","trx","pol","avax","ltc","doge","bch","xrp","xlm","pyusd_ethereum","pyusd_arbitrum","dai_ethereum","dai_arbitrum","dai_optimism","dai_polygon"],"description":"What `payment_methods` on a session takes."},"coin":{"type":"string","description":"The coin\u2019s symbol, as USDT. One coin on several networks is several methods."},"name":{"type":"string","description":"The coin\u2019s name, as Tether."},"chain":{"type":"string","enum":["solana","tron","ethereum","bsc","base","polygon","arbitrum","optimism","avalanche","ton","bitcoin","litecoin","dogecoin","bitcoincash","xrp","stellar"],"description":"Its network."},"chain_name":{"type":"string","description":"The network\u2019s name, as TRON."},"stable":{"type":"boolean","description":"A dollar stablecoin, priced 1:1."},"from_exchange":{"type":"boolean","description":"It can be sent from an exchange account, not only from a wallet."},"minimum_amount":{"type":["integer","null"],"description":"US cents, whatever the currency asked about: the least a session paid in it may be worth now. It follows the network\u2019s fees, so read it again rather than keep it. null: any amount from $1."}}},"Currency":{"type":"object","required":["object","code","decimals","available","exchange_rate"],"properties":{"object":{"const":"currency"},"code":{"type":"string","enum":["usd","eur","gbp","chf","pln","czk","huf","ron","dkk","sek","nok","isk","try","jpy","krw","cny","hkd","sgd","inr","idr","myr","php","thb","ils","aud","nzd","cad","mxn","brl","zar","uah","ars","clp","aed","sar","twd","vnd"],"description":"Its ISO code, lower case: what `currency` on a session takes."},"decimals":{"type":"integer","enum":[2,0],"description":"Of its smallest unit, which amounts are in."},"available":{"type":"boolean","description":"A session in it can be made now. False while there is no current rate for it, or the ECB\u2019s and the market\u2019s disagree."},"exchange_rate":{"oneOf":[{"$ref":"#/components/schemas/ExchangeRate"},{"type":"null"}],"description":"null for usd and while not available; else the rate a session made now would be priced at."}}},"WebhookEvent":{"type":"object","description":"An event, as its webhooks carry it.","required":["id","object","type","livemode","created","data"],"properties":{"id":{"type":"string","pattern":"^evt_[A-Za-z0-9]{24}$","description":"Unique: keep the ones you have handled, since an event can arrive more than once.","examples":["evt_3Fh8Kq2Lm9Np4Rs7Tv1Wx6Yz"]},"object":{"const":"event"},"type":{"type":"string","enum":["checkout.session.payment_detected","checkout.session.partially_paid","checkout.session.completed","checkout.session.expired","checkout.session.needs_review","checkout.session.extra_received","checkout.session.payment_reversed","refund.created","refund.voided"]},"livemode":{"type":"boolean"},"created":{"type":"integer","description":"When it happened. Unix seconds."},"data":{"type":"object","required":["object"],"properties":{"object":{"description":"The checkout session as it was then; for `refund.*`, the refund.","oneOf":[{"$ref":"#/components/schemas/CheckoutSession"},{"$ref":"#/components/schemas/Refund"}],"discriminator":{"propertyName":"object","mapping":{"checkout.session":"#/components/schemas/CheckoutSession","refund":"#/components/schemas/Refund"}}}}}}},"Event":{"description":"An event, as `GET /events` shows it: the payload its webhooks carried, and how many endpoints have not taken it yet.","allOf":[{"$ref":"#/components/schemas/WebhookEvent"},{"type":"object","required":["pending_webhooks"],"properties":{"pending_webhooks":{"type":"integer","minimum":0,"description":"Endpoints that have not taken it yet (their delivery is waiting or failed)."}}}]},"CheckoutSessionList":{"type":"object","required":["object","data","has_more","url"],"properties":{"object":{"const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CheckoutSession"}},"has_more":{"type":"boolean","description":"More objects follow: ask again with `starting_after` the last ID."},"url":{"const":"/v1/checkout/sessions"}}},"RefundList":{"type":"object","required":["object","data","has_more","url"],"properties":{"object":{"const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Refund"}},"has_more":{"type":"boolean","description":"More objects follow: ask again with `starting_after` the last ID."},"url":{"const":"/v1/refunds"}}},"PaymentLinkList":{"type":"object","required":["object","data","has_more","url"],"properties":{"object":{"const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentLink"}},"has_more":{"type":"boolean","description":"More objects follow: ask again with `starting_after` the last ID."},"url":{"const":"/v1/payment_links"}}},"EventList":{"type":"object","required":["object","data","has_more","url"],"properties":{"object":{"const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"has_more":{"type":"boolean","description":"More objects follow: ask again with `starting_after` the last ID."},"url":{"const":"/v1/events"}}},"PaymentMethodList":{"type":"object","required":["object","data","has_more","url","livemode"],"properties":{"object":{"const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"has_more":{"type":"boolean","description":"More objects follow: ask again with `starting_after` the last ID."},"url":{"const":"/v1/payment_methods"},"livemode":{"type":"boolean","description":"The key\u2019s mode."}}},"PublicPaymentMethodList":{"type":"object","required":["object","data","has_more","url","livemode"],"properties":{"object":{"const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicPaymentMethod"}},"has_more":{"type":"boolean","description":"More objects follow: ask again with `starting_after` the last ID."},"url":{"const":"/v1/public/payment_methods"},"livemode":{"type":"boolean","description":"The key\u2019s mode."}}},"CurrencyList":{"type":"object","required":["object","data","has_more","url","livemode"],"properties":{"object":{"const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Currency"}},"has_more":{"type":"boolean","description":"More objects follow: ask again with `starting_after` the last ID."},"url":{"const":"/v1/currencies"},"livemode":{"type":"boolean","description":"The key\u2019s mode."}}},"CreateCheckoutSessionRequest":{"type":"object","required":["amount"],"properties":{"amount":{"type":"integer","minimum":1,"maximum":1000000000000000,"description":"In the currency\u2019s smallest unit, as Stripe takes it: cents, pence \u2014 and whole yen, won and kr\u00f3nur, which have none. Worth $1 to $100,000 at the day\u2019s rate: in usd, 100 to 10000000."},"currency":{"type":"string","enum":["usd","eur","gbp","chf","pln","czk","huf","ron","dkk","sek","nok","isk","try","jpy","krw","cny","hkd","sgd","inr","idr","myr","php","thb","ils","aud","nzd","cad","mxn","brl","zar","uah","ars","clp","aed","sar","twd","vnd","USD","EUR","GBP","CHF","PLN","CZK","HUF","RON","DKK","SEK","NOK","ISK","TRY","JPY","KRW","CNY","HKD","SGD","INR","IDR","MYR","PHP","THB","ILS","AUD","NZD","CAD","MXN","BRL","ZAR","UAH","ARS","CLP","AED","SAR","TWD","VND"],"default":"usd","description":"The price\u2019s currency, its ISO code in lower or upper case. See `GET /currencies`."},"payment_methods":{"type":"array","minItems":1,"items":{"type":"string","enum":["usdt_tron","usdt_ethereum","usdt_bsc","usdt_solana","usdt_ton","usdt_polygon","usdt_arbitrum","usdt_optimism","usdt_avalanche","usdc_ethereum","usdc_base","usdc_solana","usdc_polygon","usdc_arbitrum","usdc_optimism","usdc_avalanche","usdc_bsc","usdc_stellar","btc","eth","eth_base","eth_arbitrum","eth_optimism","bnb","sol","ton","trx","pol","avax","ltc","doge","bch","xrp","xlm","pyusd_ethereum","pyusd_arbitrum","dai_ethereum","dai_arbitrum","dai_optimism","dai_polygon"]},"description":"The ways to pay to offer, by key (see `GET /payment_methods`). Default: every one the project has a wallet for."},"network":{"type":"string","enum":["solana","tron","ethereum","bsc","base","polygon","arbitrum","optimism","avalanche","ton","bitcoin","litecoin","dogecoin","bitcoincash","xrp","stellar"],"description":"Narrows the offer to one network."},"success_url":{"type":["string","null"],"format":"uri","maxLength":2048,"description":"Where the payment page sends the buyer once paid: only the browser that opened the page, within 60 minutes of paying. `{CHECKOUT_SESSION_ID}` in it is replaced with the session\u2019s ID. It must carry no secret: look the order up from the session ID."},"cancel_url":{"type":["string","null"],"format":"uri","maxLength":2048,"description":"Where the page\u2019s back link goes. `{CHECKOUT_SESSION_ID}` works here too."},"client_reference_id":{"type":["string","null"],"maxLength":200,"description":"Your order number. Comes back in every event."},"customer_email":{"type":["string","null"],"format":"email","maxLength":255,"description":"The buyer\u2019s email, if you have it: the page then does not ask for one."},"customer_email_collection":{"type":["string","null"],"enum":["required","optional","off",null],"description":"Whether the payment page asks the buyer for an email before it shows where to pay: `required`, `optional` (they may skip it) or `off`. Default: the project\u2019s setting."},"locale":{"type":["string","null"],"maxLength":35,"pattern":"^(auto|[A-Za-z]{2,3}([-_][A-Za-z0-9]{2,8}){0,3})$","description":"The payment page\u2019s language as an IETF tag, the closest of those it speaks: en, ru, uk, pl, es, es-mx, pt, pt-br, fr, de, ja, it, nl, ro, cs, zh-hans, zh-hant, ko, id, ms, vi, th, fil, hi, bn, ur, ta, te, mr, gu, kn, ml, pa, ne, si, my, km, lo, mn, kk, uz, ky, tg, az, ka, hy, ar, he, fa, tr, ps, el, hu, sv, da, nb, fi, sk, sl, hr, sr, bs, bg, mk, sq, lt, lv, et, be, ca, eu, gl, is, sw, am, ha, yo, ig, zu, xh, af, so, rw, mg, ht. `auto` (the default) is the buyer\u2019s own; a language it lacks is the buyer\u2019s own too, never an error."},"description":{"type":["string","null"],"maxLength":250,"description":"What is being paid for, shown to the buyer, in lists and exports. Neither it nor `details` may name an Orboni fee, bill or invoice (422)."},"details":{"type":["string","null"],"maxLength":1000,"description":"What the buyer gets, shown under `description` on the payment page only. Plain text, line breaks kept. Kept to 500 characters: a longer one, up to 1000, is cut there at a word."},"appearance":{"type":["string","null"],"enum":["auto","light","dark",null],"description":"`light` or `dark` draws the payment page so; `auto` is the buyer\u2019s own. Default: the project\u2019s setting."},"metadata":{"$ref":"#/components/schemas/Metadata"},"expires_in":{"type":["integer","null"],"minimum":300,"maximum":86400,"default":1800,"description":"Seconds the link stays open. A test session stays open 7200 seconds at most: a longer one is shortened, not refused."}}},"CreateRefundRequest":{"type":"object","required":["checkout_session"],"properties":{"checkout_session":{"type":"string","maxLength":64,"description":"The session refunded."},"amount":{"type":["integer","null"],"minimum":1,"maximum":1000000000000000,"description":"In the smallest unit of the session\u2019s currency. Default: all that is left. Never more than was received \u2014 in the session\u2019s currency, at its `exchange_rate` \u2014 less what was refunded."},"reason":{"type":["string","null"],"enum":["requested_by_customer","duplicate","fraudulent","overpaid","other",null]},"transaction":{"type":["string","null"],"maxLength":200,"description":"The hash of your refund transfer, or any reference you keep."},"note":{"type":["string","null"],"maxLength":500},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"CreatePaymentLinkRequest":{"type":"object","required":["description"],"properties":{"description":{"type":"string","minLength":1,"maxLength":250,"description":"What is paid for: the buyer sees it on the link\u2019s page and the payment page."},"amount":{"type":["integer","null"],"minimum":1,"maximum":1000000000000000,"description":"In the currency\u2019s smallest unit, worth $1 to $100,000 at the day\u2019s rate. Required unless `custom_amount`; with it, the amount suggested to the buyer."},"currency":{"type":"string","enum":["usd","eur","gbp","chf","pln","czk","huf","ron","dkk","sek","nok","isk","try","jpy","krw","cny","hkd","sgd","inr","idr","myr","php","thb","ils","aud","nzd","cad","mxn","brl","zar","uah","ars","clp","aed","sar","twd","vnd","USD","EUR","GBP","CHF","PLN","CZK","HUF","RON","DKK","SEK","NOK","ISK","TRY","JPY","KRW","CNY","HKD","SGD","INR","IDR","MYR","PHP","THB","ILS","AUD","NZD","CAD","MXN","BRL","ZAR","UAH","ARS","CLP","AED","SAR","TWD","VND"],"default":"usd","description":"The link\u2019s currency, as on a session; its amounts are in it."},"custom_amount":{"type":"boolean","default":false,"description":"The buyer types the amount."},"min_amount":{"type":["integer","null"],"minimum":1,"maximum":1000000000000000,"description":"With `custom_amount`: the least the buyer may pay, in the link\u2019s currency. Default: worth $1."},"max_amount":{"type":["integer","null"],"minimum":1,"maximum":1000000000000000,"description":"With `custom_amount`: the most the buyer may pay. Default: worth $100,000."},"max_payments":{"type":["integer","null"],"minimum":1,"maximum":1000000,"description":"It takes no new payment once this many are paid."},"expires_at":{"type":["integer","null"],"minimum":0,"maximum":4102444800,"description":"Unix seconds: it takes no new payment from then on. In the future, up to a year ahead."},"details":{"type":["string","null"],"maxLength":500,"description":"What the buyer gets, in your words."},"success_url":{"type":["string","null"],"format":"uri","maxLength":2048,"description":"Where the buyer goes once paid."}}},"UpdatePaymentLinkRequest":{"type":"object","description":"Only the fields sent change.","properties":{"description":{"type":"string","minLength":1,"maxLength":250,"description":"What is paid for: the buyer sees it on the link\u2019s page and the payment page."},"amount":{"type":["integer","null"],"minimum":1,"maximum":1000000000000000,"description":"In the currency\u2019s smallest unit, worth $1 to $100,000 at the day\u2019s rate. Required unless `custom_amount`; with it, the amount suggested to the buyer."},"currency":{"type":"string","enum":["usd","eur","gbp","chf","pln","czk","huf","ron","dkk","sek","nok","isk","try","jpy","krw","cny","hkd","sgd","inr","idr","myr","php","thb","ils","aud","nzd","cad","mxn","brl","zar","uah","ars","clp","aed","sar","twd","vnd","USD","EUR","GBP","CHF","PLN","CZK","HUF","RON","DKK","SEK","NOK","ISK","TRY","JPY","KRW","CNY","HKD","SGD","INR","IDR","MYR","PHP","THB","ILS","AUD","NZD","CAD","MXN","BRL","ZAR","UAH","ARS","CLP","AED","SAR","TWD","VND"],"default":"usd","description":"The link\u2019s currency, as on a session; its amounts are in it."},"custom_amount":{"type":"boolean","default":false,"description":"The buyer types the amount."},"min_amount":{"type":["integer","null"],"minimum":1,"maximum":1000000000000000,"description":"With `custom_amount`: the least the buyer may pay, in the link\u2019s currency. Default: worth $1."},"max_amount":{"type":["integer","null"],"minimum":1,"maximum":1000000000000000,"description":"With `custom_amount`: the most the buyer may pay. Default: worth $100,000."},"max_payments":{"type":["integer","null"],"minimum":1,"maximum":1000000,"description":"It takes no new payment once this many are paid."},"expires_at":{"type":["integer","null"],"minimum":0,"maximum":4102444800,"description":"Unix seconds: it takes no new payment from then on. In the future, up to a year ahead."},"details":{"type":["string","null"],"maxLength":500,"description":"What the buyer gets, in your words."},"success_url":{"type":["string","null"],"format":"uri","maxLength":2048,"description":"Where the buyer goes once paid."},"active":{"type":"boolean","description":"`false` switches the link off, `true` on again."}}}}}}