Update CheckoutSession

PATCH

/checkout-sessions/{object_id}

Shop

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

data

object (CheckoutSession)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

CheckoutSession

Example:

CheckoutSession

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "CheckoutSession",
        "attributes": {
            "customerData": {
                "id": "string",
                "email": "string"
            },
            "isCheckoutCompleted": true
        },
        "relationships": {
            "storeOffer": {
                "data": {
                    "id": "FID001",
                    "type": "StoreOffer"
                }
            },
            "product": {
                "data": {
                    "id": "FID001",
                    "type": "Product"
                }
            },
            "subscription": {
                "data": {
                    "id": "FID001",
                    "type": "Subscription"
                }
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.synap.ac/v3/checkout-sessions/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "id": "FID001",
        "type": "CheckoutSession",
        "attributes": {
            "customerData": {
                "id": "string",
                "email": "string"
            },
            "isCheckoutCompleted": true
        },
        "relationships": {
            "storeOffer": {
                "data": {
                    "id": "FID001",
                    "type": "StoreOffer"
                }
            },
            "product": {
                "data": {
                    "id": "FID001",
                    "type": "Product"
                }
            },
            "subscription": {
                "data": {
                    "id": "FID001",
                    "type": "Subscription"
                }
            }
        }
    }
}'

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (CheckoutSession)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

CheckoutSession

Example:

CheckoutSession

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "CheckoutSession",
        "attributes": {
            "productIdentifier": "string",
            "customerData": {
                "id": "string",
                "email": "string"
            },
            "paymentGatewayToken": "string",
            "isCheckoutCompleted": true,
            "isPaymentSuccessful": true,
            "processedAt": "string",
            "processingError": "string"
        },
        "relationships": {
            "storeOffer": {
                "data": {
                    "id": "FID001",
                    "type": "StoreOffer"
                }
            },
            "product": {
                "data": {
                    "id": "FID001",
                    "type": "Product"
                }
            },
            "subscription": {
                "data": {
                    "id": "FID001",
                    "type": "Subscription"
                }
            }
        }
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-07-08 10:51:21

Get CheckoutSession

List LegacyAccessUpgradeOptions