- API introduction
- Error code
- Checkout
- Payment Intents
- Setup Intents
- Refunds
- Payouts
- Charges
- Webhooks
- Events
- Payment Methods
- Files
- Disputes
- Balance
- Products
- Prices
- Payment Links
- Customers
- Invoices
- Invoice Items
- Invoice Line Item
- Subscriptions
- Subscription Items
- Issuing
- Coupons
- Promotion Code
- Accounts
- Fx Quote
Expire a Session Copy
POST
/v1/checkout/sessions/{id}/expire
After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.
Request
Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:passwordExample:
Authorization: Basic *****************Path Params
Header Params
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://apitest.wooshpay.com/v1/checkout/sessions//expire' \
--header 'Accept;' \
--header 'Authorization: Basic Og=='Responses
🟢200OK
application/json
Body
Example
{
"id": "string",
"object": "string",
"amount_subtotal": 0,
"amount_total": 0,
"billing_address_collection": "required",
"cancel_url": "string",
"client_reference_id": "string",
"created": 0,
"currency": "string",
"customer": "string",
"customer_email": "string",
"expires_at": 0,
"livemode": true,
"metadata": {},
"mode": "string",
"payment_intent": "string",
"payment_link": "string",
"payment_method_options": {
"card": {
"request_three_d_secure": "any",
"setup_future_usage": "on_session",
"capture_method": "string",
"tax_id": "string"
},
"alipayplus": {
"terminal_type": "APP",
"os_type": "IOS"
},
"alipay_hk": {
"terminal_type": "APP",
"os_type": "IOS"
},
"alipay": {
"terminal_type": "APP",
"os_type": "IOS"
},
"wechat_pay": {
"terminal_type": "WEB",
"client_ip": "string",
"os_type": "IOS",
"openid": "string"
},
"sepa_debit": {},
"akulaku": {
"terminal_type": "WEB",
"os_type": "IOS"
},
"truemoney": {
"terminal_type": "WEB",
"os_type": "IOS"
},
"kakaopay": {
"terminal_type": "WEB",
"os_type": "IOS"
},
"shopeepay": {
"terminal_type": "string",
"os_type": "string"
},
"dana": {
"terminal_type": "string",
"os_type": "string"
},
"pix": {
"tax_id": "string"
}
},
"payment_method_types": [
"string"
],
"payment_status": "string",
"phone_number_collection": {
"enabled": true
},
"shipping_address_collection": {
"allowed_countries": [
"string"
]
},
"shipping": {
"address": {
"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postal_code": "string",
"state": "string"
},
"carrier": "string",
"name": "string",
"phone": "string",
"tracking_number": "string"
},
"status": "open",
"success_url": "string",
"url": "string",
"line_items": {
"object": "\"list\"",
"url": "string",
"has_more": true,
"data": [
{
"id": "string",
"object": "string",
"amount_subtotal": "string",
"amount_total": "string",
"currency": "string",
"description": "string",
"price": {
"id": "string",
"object": "string",
"active": true,
"billing_scheme": "per_unit",
"created": 0,
"currency": "string",
"livemode": true,
"lookup_key": "string",
"metadata": {},
"nickname": "string",
"product": "string",
"type": "one_time",
"unit_amount": 0,
"recurring": {
"interval": "day",
"interval_count": 0,
"usage_type": "licensed"
},
"tiers": [
{
"up_to": "string",
"flat_amount": "string",
"unit_amount": "string"
}
]
},
"quantity": "string",
"discounts": [
{
"id": "string",
"object": "string",
"checkout_session": "string",
"coupon": {
"id": "string",
"amount_off": 0,
"currency": "string",
"duration_in_days": "string",
"object": "string",
"created": 0,
"livemode": true,
"metadata": {},
"name": "string",
"percent_off": 0,
"max_redemptions": 0,
"redeem_by": 0,
"times_redeemed": 0,
"valid": true,
"currency_options": {
"<currency>.amount_off": 0
}
},
"customer": "string",
"start": 0,
"end": null,
"promotion_code": null,
"subscription": null
}
],
"amount_discount": 0
}
]
},
"customer_creation": "always",
"customer_details": {
"address": {
"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postal_code": "string",
"state": "string"
},
"email": "string",
"name": "string",
"phone": "string"
}
}Modified at 2025-06-23 08:29:10