Get CheckoutSession

Responses

🟢200OK

application/vnd.api+json

Success

Body

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

included

array[object (GenericResource) {4}]

optional

string

optional

The primary key for each resource.

Example:

FID001

type

string

optional

Identifies the Resource.

Example:

_User

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"
                }
            }
        }
    },
    "included": [
        {
            "id": "FID001",
            "type": "_User",
            "attributes": {},
            "relationships": {
                "property1": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                },
                "property2": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                }
            }
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

Request

Request samples

Responses