API Overview
curl --request POST \
--url https://api.withflex.com/v1/checkout/sessions/{id}/cancel \
--header 'Authorization: Bearer <token>'{
"checkout_session": {
"allow_promotion_codes": true,
"amount_total": 123,
"amount_subtotal": 123,
"captures": [
{
"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": {}
}
],
"capture_method": "automatic",
"checkout_session_id": "<string>",
"created_at": 123,
"expires_at": 123,
"hsa_fsa_eligible": true,
"letter_of_medical_necessity_required": true,
"mode": "payment",
"redirect_url": "<string>",
"refunds": [
{
"refund_id": "<string>",
"payment_intent_id": "<string>",
"amount": 123,
"created_at": "<string>",
"status": "pending",
"test_mode": true,
"reason": "duplicate",
"metadata": {},
"reference_id": "<string>",
"reference_type": "acquirer_reference_number",
"reference_status": "available"
}
],
"shipping_address_collection": true,
"status": "open",
"success_url": "<string>",
"test_mode": true,
"total_details": {
"amount_discount": 123,
"amount_tax": 123,
"amount_shipping": 123,
"amount_iias": 123,
"amount_vision": 123,
"amount_prescription": 123,
"amount_service": 123,
"amount_fee": 123
},
"setup_future_use": "<unknown>",
"amount_received": 123,
"cancel_url": "<string>",
"client_reference_id": "<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": {}
},
"defaults": {
"customer_id": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>"
},
"invoice": "<string>",
"metadata": {},
"origin": "shopify",
"payment_intent": {
"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": "<unknown>",
"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>"
},
"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": "<unknown>",
"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>"
}
],
"setup_intent": "<string>",
"shipping_options": {
"shipping_rate_id": "<string>",
"shipping_amount": 123
},
"shipping_details": {
"shipping_address_id": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"split_cart": {
"split_cart_id": "<string>",
"eligible_cart": {
"amount_total": 123,
"amount_subtotal": 123,
"amount_tax": 123,
"amount_discount": 123,
"payment_intent": {
"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": "<unknown>",
"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>"
},
"amount_shipping": 123
},
"non_eligible_cart": {
"amount_total": 123,
"amount_subtotal": 123,
"amount_tax": 123,
"amount_discount": 123,
"payment_intent": {
"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": "<unknown>",
"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>"
},
"amount_shipping": 123
},
"checkout_session_id": "<string>"
},
"fees": [],
"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>"
},
"subscription_data": {
"trial_end": "<string>",
"cancel_at": "<string>",
"cancel_at_period_end": true,
"trial_period_days": 123
},
"tax_rate": {
"amount": 123
},
"tax_calculation_mode": "exclusive",
"visit_type": "cbtSleep"
}
}Cancel Auth Checkout Session
Cancel authorization on payment intents for a checkout session
curl --request POST \
--url https://api.withflex.com/v1/checkout/sessions/{id}/cancel \
--header 'Authorization: Bearer <token>'{
"checkout_session": {
"allow_promotion_codes": true,
"amount_total": 123,
"amount_subtotal": 123,
"captures": [
{
"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": {}
}
],
"capture_method": "automatic",
"checkout_session_id": "<string>",
"created_at": 123,
"expires_at": 123,
"hsa_fsa_eligible": true,
"letter_of_medical_necessity_required": true,
"mode": "payment",
"redirect_url": "<string>",
"refunds": [
{
"refund_id": "<string>",
"payment_intent_id": "<string>",
"amount": 123,
"created_at": "<string>",
"status": "pending",
"test_mode": true,
"reason": "duplicate",
"metadata": {},
"reference_id": "<string>",
"reference_type": "acquirer_reference_number",
"reference_status": "available"
}
],
"shipping_address_collection": true,
"status": "open",
"success_url": "<string>",
"test_mode": true,
"total_details": {
"amount_discount": 123,
"amount_tax": 123,
"amount_shipping": 123,
"amount_iias": 123,
"amount_vision": 123,
"amount_prescription": 123,
"amount_service": 123,
"amount_fee": 123
},
"setup_future_use": "<unknown>",
"amount_received": 123,
"cancel_url": "<string>",
"client_reference_id": "<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": {}
},
"defaults": {
"customer_id": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>"
},
"invoice": "<string>",
"metadata": {},
"origin": "shopify",
"payment_intent": {
"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": "<unknown>",
"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>"
},
"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": "<unknown>",
"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>"
}
],
"setup_intent": "<string>",
"shipping_options": {
"shipping_rate_id": "<string>",
"shipping_amount": 123
},
"shipping_details": {
"shipping_address_id": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"split_cart": {
"split_cart_id": "<string>",
"eligible_cart": {
"amount_total": 123,
"amount_subtotal": 123,
"amount_tax": 123,
"amount_discount": 123,
"payment_intent": {
"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": "<unknown>",
"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>"
},
"amount_shipping": 123
},
"non_eligible_cart": {
"amount_total": 123,
"amount_subtotal": 123,
"amount_tax": 123,
"amount_discount": 123,
"payment_intent": {
"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": "<unknown>",
"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>"
},
"amount_shipping": 123
},
"checkout_session_id": "<string>"
},
"fees": [],
"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>"
},
"subscription_data": {
"trial_end": "<string>",
"cancel_at": "<string>",
"cancel_at_period_end": true,
"trial_period_days": 123
},
"tax_rate": {
"amount": 123
},
"tax_calculation_mode": "exclusive",
"visit_type": "cbtSleep"
}
}Authorizations
Use a Bearer token to access this API.
Query Parameters
Response
Show child attributes
Show child attributes
Whether promotion codes can be applied to the checkout session.
The total amount of the checkout session.
The subtotal amount of the checkout session.
A list of captures associated with the checkout session.
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
automatic, automatic_async, manual The ID of the Checkout Session.
The time at which the Checkout Session will expire.
Whether the Checkout Session is HSA/FSA eligible.
Whether a letter of medical necessity is required for this Checkout Session.
The mode of the Checkout Session.
payment, subscription, off_session, setup The URL to redirect to access the checkoout session.
The refunds associated with this Checkout Session.
Show child attributes
Show child attributes
The ID of the refund
The ID of the payment intent that the refund is associated with
The amount of the refund in cents
The time at which the refund was created. ISO 8601 format.
The status of the refund
pending, requires_action, succeeded, failed, canceled Whether the refund was created in test mode
The reason for the refund
duplicate, fraudulent, requested_by_customer, expired_uncaptured_charge https://support.stripe.com/questions/how-to-trace-a-refund-using-reference-numbers ID of the refund in the stripe API
Type of the reference number used for the refund
acquirer_reference_number, system_trace_audit_number, retrieval_reference_number Status of the reference number used for the refund
available, pending, unavailable When set, present options for shipping address collection from a customer.
The status of the checkout session.
open, paid, complete, canceled The URL the customer will be directed to after the payment or subscription creation is successful.
Whether the Checkout Session is in test mode.
Tax and discount details for the computed total amount.
Show child attributes
Show child attributes
This is the sum of all the discount amounts.
This is the sum of all the tax amounts.
This is the sum of all the shipping amounts.
This is the sum of all the iias line items.
This is the sum of all the fee amounts.
The amount actually received from payment intents.
If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems.
The ID of the customer for this Session. This object is expandable if expand_customer is set.
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 customer values to prefill the customer details in the checkout page.
The ID of the invoice this Checkout Session is for. This object is expandable if expand_invoice is set.
Metadata to attach to the Checkout Session.
Origin of where the checkout session was generated
shopify, prepurchase, postpurchase The payment intent that belongs to this Checkout Session. This object is expandable if expand_payment_intent is set.
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.
Show child attributes
Show child attributes
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
The payment intent that belongs to this Checkout Session. This object is expandable if expand_payment_intent is set.
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.
Show child attributes
Show child attributes
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
The ID of the SetupIntent for this Checkout Session. This object is expandable if expand_setup_intent is set.
Shipping information for this Checkout Session.
Show child attributes
Show child attributes
If this checkout session contains both items that are eligible for HSA/FSA and items that are not, This will be the ID of the split cart object. This object is expandable if expand_split_cart is set.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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 data related to the amount being transferred.
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.
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
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 data related to the amount being transferred.
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.
Show child attributes
Show child attributes
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
The fees associated with this Checkout Session.
Show child attributes
Show child attributes
Unique identifier for the fee.
"ffee_1234567890"
The amount of the fee in cents.
The type of the fee.
lmn_consultation The name of the fee.
The ID of the subscription this Checkout Session is for. This object is expandable if expand_subscription is set.
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 The data that will be used to create a subscription. This is only avaiable via expand
If Flex is calculating the tax, this specifies whether it should be calculated inclusive or exclusive. 'None' means that Flex will not calculate the tax, and the merchant must pass it in as a TaxRate if they want it included.
exclusive, inclusive The type of visit this Checkout Session is for.
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