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>",
"unit_amount": 123,
"active": true,
"product": {
"product_id": "<string>",
"name": "<string>",
"created_at": "<string>",
"active": true,
"hsa_fsa_eligibility": "not_eligible",
"test_mode": true,
"description": "<string>",
"visit_type": "cbtSleep",
"upc_code": "<string>",
"gtin": "<string>",
"reference_gtin": "<string>",
"eligibility_rationale": "<string>",
"metadata": {},
"url": "<string>"
},
"created_at": "<string>",
"type": "one_time",
"test_mode": true,
"description": "<string>",
"trial_period_days": 123,
"recurring": {
"interval": "daily",
"interval_count": 1,
"trial_period_days": 1
},
"metadata": {},
"hsa_fsa_eligibility": "not_eligible"
},
"payment_intent": "<string>",
"test_mode": true
}
],
"test_mode": true,
"amount_shipping_captured": 123,
"amount_discount_captured": 123,
"amount_tax_captured": 123,
"metadata": {}
}
}Update Capture
Update a capture by 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>",
"unit_amount": 123,
"active": true,
"product": {
"product_id": "<string>",
"name": "<string>",
"created_at": "<string>",
"active": true,
"hsa_fsa_eligibility": "not_eligible",
"test_mode": true,
"description": "<string>",
"visit_type": "cbtSleep",
"upc_code": "<string>",
"gtin": "<string>",
"reference_gtin": "<string>",
"eligibility_rationale": "<string>",
"metadata": {},
"url": "<string>"
},
"created_at": "<string>",
"type": "one_time",
"test_mode": true,
"description": "<string>",
"trial_period_days": 123,
"recurring": {
"interval": "daily",
"interval_count": 1,
"trial_period_days": 1
},
"metadata": {},
"hsa_fsa_eligibility": "not_eligible"
},
"payment_intent": "<string>",
"test_mode": true
}
],
"test_mode": true,
"amount_shipping_captured": 123,
"amount_discount_captured": 123,
"amount_tax_captured": 123,
"metadata": {}
}
}Authorizations
Use a Bearer token to access this API.
Body
Response
A capture represents a charge that has been captured from a customer's account. You can capture a charge in full or in part.
Show child attributes
Show child attributes
The total amount captured from the capture request
The unique identifier for the capture.
The created at timestamp for the capture
The items associated with the capture
Show child attributes
Show child attributes
The amount captured that is associated with this specific capture item
The unique identifier for the capture item.
The created at timestamp for the capture item
The price id associated with the capture item Prices define the unit cost and (optional) billing cycle for both recurring and one-time purchases of products. Prices belong to a given product. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices.
Show child attributes
Show child attributes
The unique identifier for the price.
The unit amount in cents to be charged, represented as a whole integer.
Whether the price is currently active.
the product this price belongs to. Note that this is not an expandable field. A Product defines what you sell. Flex creates the The product can either be not eligible, elegible via auto-substantiation or elegible via letter of medical necessity.
Show child attributes
Show child attributes
The unique identifier for the product.
The name of the product.
The date the product was created.
Determines if the product is active or not.
The elegibility of the product for HSA/FSA.
not_eligible, auto_substantiation, private_label, letter_of_medical_necessity, prescription, vision, service Whether the product is in test mode or not.
The description of the product.
The visit type of the product if a letter of medical necessity is required.
cbtSleep, notApplicable, metabolomics, tinnitus, gym, exerciseDiet, orthopedic, alcohol, airPurification, vaginalHealth, menstrual, canopy, alopecia, genate, weightBlanket, bedJet, siderAl, sunwinkPowder, wavWatch, bodyComplete, ageRate, nitrousOxide, happyV, groupChat, icalmAnxiety, redBloom, foodom, branchErgonomicFurniture, curalife, eloraInfantWellness, nutriHealth, olipop, goldIntimate, touchStoneEssentials, utiva, sleepGeekz, figBrew, auBabyBlanket, oshWellness, currentBodyRedLight, mito, circularRing, lymaRedLight, goodAirRx, tastermonial, karunaHome, ergoStandingChair, jbaGlucoseControl, bloomNutrition, buoyDrops, luxeWonderWig, saunaMarketplace, amrioreEyewear, pivotOrthoShoe, lumenCynergy, roga, pulsetto, mitoRedLight, gutPersonal, goFlaus, myHixel, calmigo, dotFit, stripesBeauty, mixHers, pmd, positivityWithPurpose, techRing, popVeneers, vertaClean, lumen, coolingBed, posture, supplements, sleep, redLightTherapy, fitness, smartRing, womensVaginalHealth, fertilitySupport, femaleReproduction, pregnancyLiterature, iceBath, orthopedicShoes, sexualHealth, glucose, metabolicTest, skinCare, oralHealth, blueLightGlasses, anxiety, brainHealth, babyMonitor, compressionSocks, waterPurification, medSpa, essentialOils, sleepBuds, latchLight, nutritionist, rairflow, enduranceTraining, hydration, hairGrowth, eD, postureFitness, childDevelopment, adaptiveClothing, sleepConsulting, hairRemoval, menopause, maleFertility, anxietyHealth, bidets, speechHealth The upc code of the product.
The gtin code of the product.
The gtin code of the product.
The rationale for the eligibility determination.
The URL of the product.
The date the price was created.
The type of the price. The type can be one of: one-time (a one-time price for a product) or recurring (a recurring price for a product). /// The shopify product variant id that this price is associated with.
one_time, recurring Whether the price is in test mode.
The description of the price.
The number of days the customer has to pay the invoice generated by this price after the subscription becomes due.
The recurring components of a price such as interval and trial period days.
Show child attributes
Show child attributes
The billing cadence for the price.
daily, weekly, monthly, bimonthly, yearly, every_three_months, every_six_months, day, week, month, year The number of intervals
x >= 0The number of trial period days before the customer is charged for the first time.
x >= 0Metadata information for the price object
The HSA/FSA eligibility for the price.
not_eligible, auto_substantiation, private_label, letter_of_medical_necessity, prescription, vision, service Whether the capture item is in test mode
Whether the capture is in test mode
The shipping amount captured
The discount amount captured
The tax amount captured