curl --request GET \
--url https://api.withflex.com/v1/payment_intents \
--header 'Authorization: Bearer <token>'{
"payment_intents": [
{
"payment_intent_id": "<string>",
"amount": 123,
"status": "canceled",
"created_at": "<string>",
"capture_method": "automatic",
"test_mode": true,
"amount_capturable": 123,
"amount_received": 123,
"application_fee_amount": 123,
"customer": {
"customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"created_at": "<string>",
"test_mode": true,
"phone": "+15555555555",
"employer": "Flex",
"shipping": {
"shipping_address_id": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"metadata": {}
},
"transfer_data": {
"destination": "<string>",
"amount": 123
},
"latest_charge": "<string>",
"invoice": {
"invoice_id": "<string>",
"total": 123,
"amount_due": 123,
"amount_paid": 123,
"status": "draft",
"collection_method": "charge_automatically",
"test_mode": true,
"payment_intent": {},
"charge": "<string>",
"customer": {
"customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"created_at": "<string>",
"test_mode": true,
"phone": "+15555555555",
"employer": "Flex",
"shipping": {
"shipping_address_id": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"metadata": {}
},
"period_end": "<string>",
"period_start": "<string>",
"subscription": {
"subscription_id": "<string>",
"created_at": "<string>",
"items": [
{
"subscription_item_id": "<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"
},
"quantity": 123,
"created_at": "<string>",
"test_mode": true,
"updated_at": "<string>"
}
],
"status": "incomplete",
"cancel_at_period_end": true,
"test_mode": true,
"latest_invoice": "<unknown>",
"customer": {
"customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"created_at": "<string>",
"test_mode": true,
"phone": "+15555555555",
"employer": "Flex",
"shipping": {
"shipping_address_id": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"metadata": {}
},
"current_period_end": "<string>",
"current_period_start": "<string>",
"metadata": {},
"client_secret": {
"setup_secret": "<string>",
"payment_secret": "<string>"
},
"proration_behavior": "always_invoice",
"trial_start": "<string>",
"trial_end": "<string>",
"cancel_at": "<string>"
},
"metadata": {}
},
"client_secret": "<string>",
"metadata": {},
"payment_method": "<string>",
"transfer_group": "<string>"
}
]
}List Payment Intents
Returns a list of payment intents
curl --request GET \
--url https://api.withflex.com/v1/payment_intents \
--header 'Authorization: Bearer <token>'{
"payment_intents": [
{
"payment_intent_id": "<string>",
"amount": 123,
"status": "canceled",
"created_at": "<string>",
"capture_method": "automatic",
"test_mode": true,
"amount_capturable": 123,
"amount_received": 123,
"application_fee_amount": 123,
"customer": {
"customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"created_at": "<string>",
"test_mode": true,
"phone": "+15555555555",
"employer": "Flex",
"shipping": {
"shipping_address_id": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"metadata": {}
},
"transfer_data": {
"destination": "<string>",
"amount": 123
},
"latest_charge": "<string>",
"invoice": {
"invoice_id": "<string>",
"total": 123,
"amount_due": 123,
"amount_paid": 123,
"status": "draft",
"collection_method": "charge_automatically",
"test_mode": true,
"payment_intent": {},
"charge": "<string>",
"customer": {
"customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"created_at": "<string>",
"test_mode": true,
"phone": "+15555555555",
"employer": "Flex",
"shipping": {
"shipping_address_id": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"metadata": {}
},
"period_end": "<string>",
"period_start": "<string>",
"subscription": {
"subscription_id": "<string>",
"created_at": "<string>",
"items": [
{
"subscription_item_id": "<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"
},
"quantity": 123,
"created_at": "<string>",
"test_mode": true,
"updated_at": "<string>"
}
],
"status": "incomplete",
"cancel_at_period_end": true,
"test_mode": true,
"latest_invoice": "<unknown>",
"customer": {
"customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"created_at": "<string>",
"test_mode": true,
"phone": "+15555555555",
"employer": "Flex",
"shipping": {
"shipping_address_id": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"metadata": {}
},
"current_period_end": "<string>",
"current_period_start": "<string>",
"metadata": {},
"client_secret": {
"setup_secret": "<string>",
"payment_secret": "<string>"
},
"proration_behavior": "always_invoice",
"trial_start": "<string>",
"trial_end": "<string>",
"cancel_at": "<string>"
},
"metadata": {}
},
"client_secret": "<string>",
"metadata": {},
"payment_method": "<string>",
"transfer_group": "<string>"
}
]
}Authorizations
Use a Bearer token to access this API.
Query Parameters
x >= 0Response
Show child attributes
Show child attributes
The unique identifier for the payment intent.
The amount of the payment intent in cents.
The status of the payment intent.
canceled, processing, requires_action, requires_capture, requires_confirmation, requires_payment_method, succeeded The time the payment intent was created.
The capture method of the payment intent.
automatic, automatic_async, manual Whether the payment intent is in test mode.
The amount that can be captured from this PaymentIntent.
The amount that was received in cents.
The amount of the Flex application fee.
The customer associated with the payment intent.
Show child attributes
Show child attributes
The unique identifier for the customer.
"fcus_01HACM7FZ1084XB1GB6053VM0D"
The customer's first name.
"John"
The customer's last name.
"Doe"
The customer's email address.
The time the customer was created.
Whether the customer was created in test mode.
The customer's phone number.
"+15555555555"
The customer's employer.
"Flex"
The customer's shipping address.
Show child attributes
Show child attributes
The latest charge associated with the payment intent.
The invoice associated with the payment intent.
Show child attributes
Show child attributes
The id of the invoice.
The total amount of the invoice in cents.
The amount due in cents.
The amount paid in cents.
The status of the invoice.
draft, open, void, paid, uncollectible Either charge_automatically or send_invoice. When charging automatically, Flex will attempt to pay this invoice using the default payment method attached to the customer. When sending an invoice, Flex will email this invoice to the customer with payment instructions.
charge_automatically, send_invoice Whether or not the invoice was created in test mode.
The payment intent associated with this invoice. The payment intent is created when the invoice is finalized.
The id of the latest charge for this invoice, if any.
The id of the customer this invoice is for.
Show child attributes
Show child attributes
The unique identifier for the customer.
"fcus_01HACM7FZ1084XB1GB6053VM0D"
The customer's first name.
"John"
The customer's last name.
"Doe"
The customer's email address.
The time the customer was created.
Whether the customer was created in test mode.
The customer's phone number.
"+15555555555"
The customer's employer.
"Flex"
The customer's shipping address.
Show child attributes
Show child attributes
End of the usage period.
Start of the usage period.
The subscription that this invoice was prepared for.
Show child attributes
Show child attributes
Unique identifier for the object.
Time at which the object was created. ISO 8601 format.
The items the customer is subscribed to.
Show child attributes
Show child attributes
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 Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, or unpaid.
incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, paused If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
Whether the subscription is in test mode.
The ID of the latest invoice generated for this subscription.
Show child attributes
Show child attributes
The ID of the customer who owns the subscription.
Show child attributes
Show child attributes
The unique identifier for the customer.
"fcus_01HACM7FZ1084XB1GB6053VM0D"
The customer's first name.
"John"
The customer's last name.
"Doe"
The customer's email address.
The time the customer was created.
Whether the customer was created in test mode.
The customer's phone number.
"+15555555555"
The customer's employer.
"Flex"
The customer's shipping address.
Show child attributes
Show child attributes
End of the current period that the subscription has been invoiced for.
Start of the current period that the subscription has been invoiced for.
A set of key/value pairs that you can attach to a subscription object.
The proration behavior for the subscription.
always_invoice, create_prorations, none Metadata associated with the invoice.
The client secret of the payment intent.
The metadata associated with the payment intent.
The payment method associated with the payment intent.
A string that identifies the resulting payment as part of a group