Cancel checkout session

cURL

curl --request POST \
  --url https://us.api.flexprice.io/v1/checkout/sessions/{id}/cancel \
  --header 'x-api-key: <api-key>'

from flexprice import Flexprice


with Flexprice(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:

    res = f_client.checkout.cancel_checkout_session(id="<id>")

    # Handle response
    print(res)

import { Flexprice } from "@flexprice/sdk";

const flexprice = new Flexprice({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await flexprice.checkout.cancelCheckoutSession("<id>");

  console.log(result);
}

run();

package main

import(
	"context"
	flexprice "github.com/flexprice/go-sdk/v2"
	"log"
)

func main() {
    ctx := context.Background()

    s := flexprice.New(
        flexprice.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Checkout.CancelCheckoutSession(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.CheckoutSessionResponse != nil {
        // handle response
    }
}

{
  "action": "create_subscription",
  "cancel_url": "<string>",
  "cancelled_at": "2023-11-07T05:31:56Z",
  "checkout_invoice_id": "<string>",
  "checkout_payment_id": "<string>",
  "checkout_status": "initiated",
  "completed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "customer_id": "<string>",
  "entity_creation_result": {
    "entity_id": "<string>",
    "status": "created"
  },
  "expires_at": "2023-11-07T05:31:56Z",
  "failure_reason": "<string>",
  "failure_url": "<string>",
  "id": "<string>",
  "idempotency_key": "<string>",
  "metadata": {},
  "next_poll_after_ms": 123,
  "payment": {
    "gateway": "<string>",
    "id": "<string>",
    "status": "INITIATED"
  },
  "payment_action": {
    "type": "checkout_url",
    "url": "<string>"
  },
  "payment_provider": "razorpay",
  "stale": true,
  "success_url": "<string>",
  "terminal": true,
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": "http_client_error",
  "http_status_code": 123,
  "message": "<string>"
}

{
  "code": "http_client_error",
  "http_status_code": 123,
  "message": "<string>"
}

{
  "code": "http_client_error",
  "http_status_code": 123,
  "message": "<string>"
}

POST

checkout

sessions

{id}

cancel

cURL

curl --request POST \
  --url https://us.api.flexprice.io/v1/checkout/sessions/{id}/cancel \
  --header 'x-api-key: <api-key>'

from flexprice import Flexprice


with Flexprice(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:

    res = f_client.checkout.cancel_checkout_session(id="<id>")

    # Handle response
    print(res)

import { Flexprice } from "@flexprice/sdk";

const flexprice = new Flexprice({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await flexprice.checkout.cancelCheckoutSession("<id>");

  console.log(result);
}

run();

package main

import(
	"context"
	flexprice "github.com/flexprice/go-sdk/v2"
	"log"
)

func main() {
    ctx := context.Background()

    s := flexprice.New(
        flexprice.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Checkout.CancelCheckoutSession(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.CheckoutSessionResponse != nil {
        // handle response
    }
}

{
  "action": "create_subscription",
  "cancel_url": "<string>",
  "cancelled_at": "2023-11-07T05:31:56Z",
  "checkout_invoice_id": "<string>",
  "checkout_payment_id": "<string>",
  "checkout_status": "initiated",
  "completed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "customer_id": "<string>",
  "entity_creation_result": {
    "entity_id": "<string>",
    "status": "created"
  },
  "expires_at": "2023-11-07T05:31:56Z",
  "failure_reason": "<string>",
  "failure_url": "<string>",
  "id": "<string>",
  "idempotency_key": "<string>",
  "metadata": {},
  "next_poll_after_ms": 123,
  "payment": {
    "gateway": "<string>",
    "id": "<string>",
    "status": "INITIATED"
  },
  "payment_action": {
    "type": "checkout_url",
    "url": "<string>"
  },
  "payment_provider": "razorpay",
  "stale": true,
  "success_url": "<string>",
  "terminal": true,
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": "http_client_error",
  "http_status_code": 123,
  "message": "<string>"
}

{
  "code": "http_client_error",
  "http_status_code": 123,
  "message": "<string>"
}

{
  "code": "http_client_error",
  "http_status_code": 123,
  "message": "<string>"
}

Authorizations

x-api-key

string

header

required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

string

required

Checkout session ID

Response

action

enum<string>

Available options:

create_subscription,

modify_subscription,

wallet_topup,

add_addon,

pay_invoice

cancel_url

string

cancelled_at

string<date-time>

checkout_invoice_id

string

checkout_payment_id

string

checkout_status

enum<string>

Available options:

initiated,

pending,

completed,

failed,

expired

completed_at

string<date-time>

created_at

string<date-time>

customer_id

string

entity_creation_result

object

Show child attributes

expires_at

string<date-time>

failure_reason

string

failure_url

string

idempotency_key

string

metadata

object

Show child attributes

next_poll_after_ms

integer

NextPollAfterMs is how long a client should wait before reading again. Zero means stop — either the session is terminal, or this response did not come from a polling read.

payment

object

Show child attributes

payment_action

object

Show child attributes

payment_provider

enum<string>

Available options:

razorpay,

chargebee,

stripe

stale

boolean

Stale reports that this response is stored state that was not checked against the payment provider on this request — the read was debounced, or the gateway did not answer. A UI should say "still checking" rather than presenting a stale answer as fact.

success_url

string

terminal

boolean

Terminal reports whether the session has finished. Clients poll until this is true rather than hardcoding the status set, which would go stale if a status is ever added.

updated_at

string<date-time>

API Documentation

Resources

Cancel checkout session

Authorizations

Path Parameters

Response