PATCH
/
v1
/
captures
/
{capture_id}
curl --request PATCH \
  --url https://api.withflex.com/v1/captures/{capture_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "capture": {
    "metadata": {}
  }
}'
{
  "capture": {
    "amount_captured": 123,
    "capture_id": "<string>",
    "created_at": "<string>",
    "items": [
      {
        "amount_captured": 123,
        "capture_item_id": "<string>",
        "created_at": "<string>",
        "price": {
          "price_id": "<string>",
          "description": "<string>",
          "trial_period_days": 123,
          "unit_amount": 123,
          "recurring": {
            "interval": "daily",
            "interval_count": 1,
            "trial_period_days": 1
          },
          "active": true,
          "product": {
            "product_id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "created_at": "<string>",
            "visit_type": "cbtSleep",
            "active": true,
            "upc_code": "<string>",
            "gtin": "<string>",
            "reference_gtin": "<string>",
            "hsa_fsa_eligibility": "not_eligible",
            "test_mode": true,
            "metadata": {}
          },
          "created_at": "<string>",
          "type": "one_time",
          "metadata": {},
          "hsa_fsa_eligibility": "not_eligible",
          "test_mode": true
        },
        "payment_intent": "<string>",
        "test_mode": true
      }
    ],
    "metadata": {},
    "test_mode": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
expand
string
default:""
​
checkout_session
string | null

Body

application/json

Response

200
application/json

The response is of type object.