/proxy_sessions/{proxy_session_id}/acquisition_attempts/{acquisition_attempt_id}/supersede

POST

/proxy_sessions/{proxy_session_id}/acquisition_attempts/{acquisition_attempt_id}/supersede

curl --request POST \
  --url https://example.com/proxy_sessions/example/acquisition_attempts/example/supersede \
  --header 'Content-Type: application/json' \
  --data '{ "expected_version": 1, "reason": "example", "replacement": "example" }'

Safely supersedes a conclusively terminal acquisition attempt.

Parameters

Path Parameters

acquisition_attempt_id

required

string

/^pspacq_/

proxy_session_id

required

string

/^psess_/

Request Body^required

Media typeapplication/json

object

expected_version

required

integer

>= 1 <= 2147483647

reason

required

string

/^[a-z0-9_]{1,96}$/

replacement

required

object

checkout_ui_mode

string

Allowed values: hosted embedded custom

direct_subscription_source

string

Allowed values: setup_intent saved_payment_method

integration_path

required

string

Allowed values: checkout_session payment_intent direct_subscription

provider_options_fingerprint

required

string

/^[a-f0-9]{64}$/

Responses

200

Default Response

Media typeapplication/json

object

acquisition_attempt

required

object

attempt_number

required

integer

>= 1

checkout_ui_mode

required

null | string

commercial_mode

required

string

Allowed values: one_time subscription

completion_recorded_at

required

null | string

created_at

required

string

direct_fee_basis_source

required

null | string

direct_merchandise_currency

required

null | string

direct_merchandise_subtotal_minor

required

null | integer

id

required

string

/^pspacq_/

integration_path

required

string

Allowed values: checkout_session payment_intent direct_subscription

merchant_psp_config_id

required

string

/^pspcfg_/

pricing_mode

required

string

Allowed values: fixed provider_finalized

provider_confirmed_amount_minor

required

null | integer

provider_confirmed_at

required

null | string

provider_confirmed_cart_version

required

null | integer

provider_confirmed_currency

required

null | string

provider_confirmed_evidence_sha256

required

null | string

provider_confirmed_merchandise_subtotal_minor

required

null | integer

provider_created_at

required

null | string

provider_customer_id

required

null | string

provider_options_fingerprint

required

string

/^[a-f0-9]{64}$/

provider_retry_not_after

required

string

provider_root_object_id

required

null | string

provider_root_object_type

required

null | string

provider_setup_intent_id

required

null | string

proxy_session_id

required

string

/^psess_/

psp

required

string

Allowed values: stripe

status

required

string

status_reason

required

null | string

supersedes_attempt_id

required

null | string

updated_at

required

string

version

required

integer

>= 1

direct_subscription_source

required

Allowed values: setup_intent saved_payment_method

stripe

required

object

idempotency_keys

required

object

root

required

string

<= 255 characters

setup_intent

string

<= 255 characters

metadata

required

object

proxy_acquisition_attempt_id

required

string

/^pspacq_/

proxy_contract_version

required

string

Allowed values: 2

proxy_session_id

required

string

/^psess_/

Example

{
  "acquisition_attempt": {
    "commercial_mode": "one_time",
    "integration_path": "checkout_session",
    "pricing_mode": "fixed",
    "psp": "stripe",
    "direct_subscription_source": "setup_intent"
  },
  "stripe": {
    "metadata": {
      "proxy_contract_version": "2"
    }
  }
}

400

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

401

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

404

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

409

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

500

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}