List All Checkout Sessions - WooshPay OpenAPI

Returns a list of Checkout Sessions.

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:password

Example:

Authorization: Basic *****************

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

created

object

optional

A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:

string

optional

Return results where the created field is greater than this value.

gte

string

optional

Return results where the created field is greater than or equal to this value.

string

optional

Return results where the created field is less than this value.

lte

string

optional

Return results where the created field is less than or equal to this value.

ending_before

string

optional

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

limit

integer

optional

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

starting_after

string

optional

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

customer

string

optional

Only return the Checkout Sessions for the Customer specified.

customer_details

object

optional

Only return the Checkout Sessions for the Customer details specified.

string

required

Customer’s email address.

payment_intent

string

optional

Only return the Checkout Session for the PaymentIntent specified.

Example

{
    "created": {
        "gt": "string",
        "gte": "string",
        "lt": "string",
        "lte": "string"
    },
    "ending_before": "string",
    "limit": 0,
    "starting_after": "string",
    "customer": "string",
    "customer_details": {
        "email": "string"
    },
    "payment_intent": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

object

string

optional

Default:

"list"

url

string

optional

has_more

boolean

optional

data

array [object {29}]

optional

string

optional

Unique identifier for the object, like "cs_xxx" in live environment and "cs_test_xxx" in test environment.

object

string

optional

value is "checkout.session"

amount_subtotal

integer

optional

Total of all items before discounts or taxes are applied.

amount_total

integer

optional

Total of all items after discounts and taxes are applied.

billing_address_collection

enum<string>

optional

Describes whether Checkout should collect the customer’s billing address.

Allowed values:

requiredauto

cancel_url

string

optional

The URL the customer will be directed to if they decide to cancel payment and return to your website.

client_reference_id

string

optional

A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the Session with your internal systems.

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

currency

string

optional

Three-letter ISO currency code

customer

string

optional

The ID of the customer for this Session.

customer_email

string

optional

If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once the payment flow is complete, use the customer attribute.

expires_at

integer

optional

The timestamp at which the Checkout Session will expire. The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 1 to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata

object

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

mode

string

optional

The mode of the Checkout Session. Only payment is supported now.

payment_intent

string

optional

The ID of the PaymentIntent for Checkout Sessions in payment mode.

payment_link

string

optional

The ID of the Payment Link that created this Session.

payment_method_options

object (Payment Method Options)

optional

Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.

payment_method_types

array[string]

optional

A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept.

payment_status

string

optional

The payment status of the Checkout Session, one of paid, unpaid, or no_payment_required. You can use this value to decide when to fulfill your customer’s order.

phone_number_collection

object

optional

Details on the state of phone number collection for the session. phone_number_collection.enabled boolean Indicates whether phone number collection is enabled for the session

shipping_address_collection

object

optional

When set, provides configuration for Checkout to collect a shipping address from a customer.

shipping

object

optional

Shipping information for this Checkout Session.

status

enum<string>

optional

The status of the Checkout Session, one of open, complete, or expired.

Allowed values:

opencompleteexpired

success_url

string

optional

The URL the customer will be directed to after the payment or subscription creation is successful.

url

string

optional

The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout.

line_items

object

optional

The line items purchased by the customer. This field is not included by default. To include it in the response, expand the line_items field.

customer_creation

enum<string>

optional

Configure whether a Checkout Session creates a Customer when the Checkout Session completes. Can only be set in payment and setup mode.

Allowed values:

alwaysif_required

customer_details

object

optional

Example

{
    "object": "\"list\"",
    "url": "string",
    "has_more": true,
    "data": [
        {
            "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": {},
            "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"
            }
        }
    ]
}