Schemas

Account

• object enum
  • account
• id string
• name string
• billing_source enum
  • stripe
  • api
• sandbox boolean
• default_locale enum
  • en
  • de
  • fr
  • it
  • pt
• plan enum

  NoChurn's own plan: details in GET /v1/billing/plan.

  • free
  • paid
  • custom
• external_id_metadata_key string

  Stripe customer metadata key copied into external_id. Default: user_id.

• require_two_factor boolean

  Every member must use two-factor authentication. Owners only, from a 2FA session.

• timezone string

  IANA time zone: "this month" and "today" in the dashboard.

• audience enum | null

  Who your customers are: sets the default send window (GET /v1/account/send_schedule).

  • b2b
  • b2c
• reporting_currency string | null

  Currency the dashboard converts every amount into (ECB rates). null: the connected Stripe account's default currency, else the one most customers pay in.

Used by: The account of the API key, Update account settings

ApiKey

• object enum
  • api_key
• id string
• name string
• kind enum
  • secret
  • publishable
• mode enum
  • live
  • test
• access enum

  full: every resource. restricted: see permissions.

  • full
  • restricted
• permissions object | null

  Level per resource (none, read, write). null for publishable keys.

  Show child attributesHide child attributes

  • account enum
    • none
    • read
    • write
  • api_keys enum
    • none
    • read
    • write
  • team enum
    • none
    • read
    • write
  • events enum
    • none
    • read
    • write
  • customers enum
    • none
    • read
    • write
  • billing enum
    • none
    • read
    • write
  • stripe_connections enum
    • none
    • read
    • write
  • logs enum
    • none
    • read
    • write
  • flows enum
    • none
    • read
    • write
  • email_domains enum
    • none
    • read
    • write
  • messages enum
    • none
    • read
    • write
  • webhooks enum
    • none
    • read
    • write
  • cancel_sessions enum
    • none
    • read
    • write
  • reviews enum
    • none
    • read
    • write
  • dashboard enum
    • none
    • read
    • write
  • insights enum
    • none
    • read
    • write
  • integrations enum
    • none
    • read
    • write
  • queries enum
    • none
    • read
    • write
  • disputes enum
    • none
    • read
    • write
  • sandbox enum
    • none
    • read
    • write
• last4 string
• allowed_origins array of strings | null

  Publishable keys: origins allowed to call the public endpoints (null on secret keys).

• token string | null

  Secret keys: only on creation, store it now. Publishable keys: always.

• first_used_at string | null date-time

  First call made with this key (onboarding: waiting for your first event).

• last_used_at string | null date-time

Used by: List the API keys of the current mode, Create an API key, Rename a key or change its access, Revoke an API key, List live requests, Ask a human to do something in live mode, Retrieve a live request, Approve a live request, Reject a live request

ApiKeyList

• object enum
  • list
• data array of objects (ApiKey)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: List the API keys of the current mode

AttributeDefinition

• object enum
  • attribute_definition
• id string
• key string
• type enum

  Inferred at the first send, then locked.

  • string
  • number
  • boolean
  • date
• sensitive boolean

  Never sent to the AI.

• customers_count integer

  Customers of this mode with a value.

• coverage number | null

  customers_count / customers of this mode; null without customers.

• last_seen_at string | null date-time
• created_at string date-time

Used by: Custom attributes of the account, Declare an attribute before its first send, Mark an attribute sensitive

AttributeDefinitionList

• object enum
  • list
• data array of objects (AttributeDefinition)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: Custom attributes of the account

BillingConnection

• object enum
  • billing_connection
• id string
• provider enum
  • stripe
  • chargebee
  • recurly
  • maxio
  • zuora
  • paddle
  • lemon_squeezy
  • polar
  • braintree
  • mollie
  • gocardless
  • razorpay
  • app_store
  • google_play
  • custom
• livemode boolean
• status enum
  • active
  • revoked
  • error
• external_account_id string | null
• business_name string | null
• capabilities object
  Show child attributesHide child attributes

  • retries enum
    • nochurn
    • provider
    • none
  • card_update enum
    • hosted_page
    • provider_portal
    • none
  • offers array of enums
    • coupon
    • pause
    • downgrade
  • cancel_via_api boolean
  • disputes enum
    • evidence_api
    • provider_handles
    • refund_review
    • none
  • fraud_warnings boolean
  • webhooks boolean
  • backfill boolean
• available boolean

  The provider's adapter is live on this NoChurn version.

• webhook_url string | null

  Paste it in the provider's webhook settings (not for Stripe).

• backfill object
  Show child attributesHide child attributes

  • status enum
    • pending
    • running
    • done
    • failed
  • progress object

    Real counts imported so far, by object (customer, subscription, invoice, payment_method).

  • started_at string | null date-time
  • finished_at string | null date-time
  • error object | null

    Why the import stopped and what to do; null unless it failed.

    Show child attributesHide child attributes

    • code enum
      • import_access_denied
      • import_interrupted
      • import_failed
    • message string
    • fix string
    • docs_url string
• webhook_secret_set boolean

  False until the provider's webhook secret is pasted (Recurly, Paddle, GoCardless, Razorpay): webhooks are refused until then. Always true for Stripe, for providers that sign webhooks with the API keys (Braintree) and for providers without a webhook secret (Mollie).

Used by: Connected billing providers, Connect a provider with API keys, A billing connection, Change capabilities, the Stripe retry mode or where your user id is read, Disconnect, Import again

BillingConnectionList

• object enum
  • list
• data array of objects (BillingConnection)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: Connected billing providers

BillingMapping

• object enum
  • billing_mapping
• billing_connection string
• active boolean
• activated_at string | null date-time
• rules array of objects

  { when: { path, equals | in }, type, event_id?, occurred_at?, fields: { "customer.id": "$.data.customer", "invoice.amount_due_cents": { path, transform } | { value } } }

• types array of strings
• fields object
• transforms array of strings
• sample array of objects
  Show child attributesHide child attributes

  • id string
  • received_at string date-time
  • payload object

    The webhook as received (data, never code).

  • result object
    Show child attributesHide child attributes

    • status enum

      event: recognized; ignored: no rule matched; error: a rule matched but a field failed.

      • event
      • ignored
      • error
    • rule integer | null

      Index of the rule that matched.

    • type string | null
    • event_id string | null
    • data object | null

      The normalized event NoChurn would apply.

    • errors array of strings
• summary object
  Show child attributesHide child attributes

  • total integer
  • events integer
  • errors integer
  • ignored integer

Used by: Mapping of a custom billing connection, tested on its sample, Save the mapping rules, Turn the mapping on, Turn the mapping off

BillingProvider

• object enum
  • billing_provider
• provider enum
  • stripe
  • chargebee
  • recurly
  • maxio
  • zuora
  • paddle
  • lemon_squeezy
  • polar
  • braintree
  • mollie
  • gocardless
  • razorpay
  • app_store
  • google_play
  • custom
• family enum
  • billing
  • merchant_of_record
  • payments
  • stores
  • custom
• available boolean

  Its adapter ships in this version; otherwise "Coming soon".

• connect enum
  • oauth
  • credentials
• credentials array of objects
  Show child attributesHide child attributes

  • name string
  • secret boolean
  • hint string
  • options array of strings
• capabilities object

  Default capabilities (see BillingConnection.capabilities).

• locked array of strings

  Capabilities the provider decides (cannot be changed per connection).

• webhook_secret enum

  generated: NoChurn shows webhook credentials once at creation; pasted: create the endpoint on webhook_url, then PATCH webhook_secret.

  • generated
  • pasted
  • none
• hint string | null

  What the provider needs beyond credentials, for the connection screen (stores: how customers get linked).

• docs_url string

  The tool's integration guide: https://nochurn.sh/docs/integrations/<provider, _ written ->/.

Used by: Billing providers

BillingProviderList

• object enum
  • list
• data array of objects (BillingProvider)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: Billing providers

CampaignStats

• object enum
  • campaign_stats
• group_by string
• period string
• customers integer
• churned integer
• churn_rate number | null
• tracked integer
• best object | null
  Show child attributesHide child attributes

  • value string
  • relative_risk number
• worst object | null
  Show child attributesHide child attributes

  • value string
  • relative_risk number
• min_sample integer
• rows array of objects
  Show child attributesHide child attributes

  • value string
  • customers integer
  • churned integer
  • churn_rate number
  • relative_risk number | null
  • avg_ltv_cents integer
  • avg_score number | null
  • mrr_lost_cents integer
  • sample_ok boolean

Used by: Churn by acquisition campaign

CancelFeedback

• enabled boolean

  The feedback step is shown.

• required boolean

  "Continue" needs a text (400 otherwise). Cancelling never does.

Used by: Sandbox: play the cancel flow, Cancel flow config for the widget or a native app, Cancel sessions, Open the cancel flow for a customer, Read a cancel session, Answer the current step, Cancel now

CancelFlow

• object enum
  • cancel_flow
• id string
• published boolean
• version integer | null
• locale string
• texts object
• reasons array of objects
  Show child attributesHide child attributes

  • key string
  • label string
  • free_text boolean
• feedback_enabled boolean
• feedback object (CancelFeedback)
• theme object (CancelFlowTheme)
• languages array of strings
• cancel_fallback_url string | null

  With a publishable key: the fallback cancel link (POST { token } as a form). Null for a secret key.

Used by: Cancel flow config for the widget or a native app

CancelFlowLogo

• object enum
  • cancel_flow_logo
• id string
• flow string
• url string

  Public and stable: put it in draft.design.logo_url. No account id in it; served without auth.

• content_type enum
  • image/png
  • image/jpeg
  • image/webp
• byte_size integer
• width integer

  px

• height integer

  px

• created_at string date-time

Used by: Upload a logo for the cancel modal, Remove a logo, Retrieve a flow with its draft, Edit the draft, Publish the draft to test or live mode, Discard the unpublished changes, Put an older version back in the draft, Pause a flow, Resume a paused flow

CancelFlowTheme

• object enum
  • cancel_flow_theme
• preset enum
  • light
  • dark
  • playful
  • custom_css
  • headless
• format enum

  modal (centred), panel (side panel) or page (full page).

  • modal
  • panel
  • page
• tokens object

  The --nc-* custom properties (--nc-accent-text for accent_text). Enumerated values are mapped to CSS by the widget.

  Show child attributesHide child attributes

  • bg string
  • surface string
  • text string
  • muted string
  • accent string
  • accent_text string
  • border string
  • danger string
  • font string 200 characters at most

    A font stack. Its first family loads from font_url when it is an allowed Google Font.

  • font_size number 12 to 20

    Base size, px.

  • radius integer 0 to 999

    Modal corners, px.

  • radius_control integer 0 to 999

    Buttons and fields, px.

  • overlay number 0 to 1

    Backdrop opacity.

  • max_width integer 280 to 1200

    Modal width, px.

  • shadow enum
    • none
    • sm
    • md
    • lg
  • spacing enum

    Density.

    • compact
    • regular
    • comfortable
  • border_width integer 0 to 4

    px.

  • border_style enum
    • solid
    • dashed
    • none
  • font_scale number 1 to 2

    Title size = font_size × font_scale.

  • font_weight_title enum
    • 400
    • 500
    • 600
    • 700
• font_url string | null

  Google Fonts stylesheet of the font token's first family (allowed fonts only), else null.

• brand enum

  What the header shows: logo (logo_url, else app_name), name (app_name) or none (nothing). logo_url and app_name already follow it: null when the header must not show them.

  • logo
  • name
  • none
• logo_url string | null

  https URL of the logo (uploaded, or set in the editor) when brand is logo, else null (show app_name).

• app_name string | null

  The account's name: the text shown in place of a logo; null when brand is none.

• end_screen object

  The modal's last step (draft.design.end_screen). A cancelled customer's end screen is always calm, whatever the style.

  Show child attributesHide child attributes

  • style enum

    Saved customer: celebrate (default), glow or quiet.

    • celebrate
    • glow
    • quiet
  • auto_close_seconds integer | null 3 to 30

    Saved screen only: closes by itself after this (default 6); null = never.

• custom_css string

  Cleaned on the server (no @import, url() only to Google Fonts).

• cancel_button_check enum
  • ok
  • fallback_applied
• classes array of enums
  • nc-modal
  • nc-title
  • nc-reason
  • nc-offer
  • nc-btn-primary
  • nc-btn-cancel
  • nc-footer

Used by: Sandbox: play the cancel flow, Cancel flow config for the widget or a native app, Cancel sessions, Open the cancel flow for a customer, Resume the paused subscription, What the customer's app shows: payment banner and wall, Hide the banner for 24 hours, Read a cancel session, Answer the current step, Cancel now, The cancel modal's design

CancelSession

• object enum
  • cancel_session
• id string
• livemode boolean
• step enum
  • choose_subscription
  • reason
  • offer
  • feedback
  • confirm
  • done
• outcome enum | null
  • saved
  • cancelled
  • abandoned
• locale string
• holdout boolean
• published boolean
• customer object | null
• subscription object | null

  The subscription this session targets (offers, saved MRR, cancellation). Null at choose_subscription, for an unknown customer, or without a live subscription.

  Show child attributesHide child attributes

  • id string
  • plan string | null
  • status enum
    • incomplete
    • incomplete_expired
    • trialing
    • active
    • past_due
    • canceled
    • unpaid
    • paused
  • amount_cents integer

    Price per interval (quantity included), minor unit.

  • currency string | null
  • interval string | null
  • interval_count integer
  • current_period_end string | null date-time

    Next renewal.

  • cancel_at_period_end boolean
• subscriptions array of objects

  At choose_subscription only (several live subscriptions, none named by the token's subscription claim): the customer picks one (answer { subscription }) or cancels one (cancel { subscription }). Empty otherwise.

  Show child attributesHide child attributes

  • id string
  • plan string | null
  • status enum
    • incomplete
    • incomplete_expired
    • trialing
    • active
    • past_due
    • canceled
    • unpaid
    • paused
  • amount_cents integer

    Price per interval (quantity included), minor unit.

  • currency string | null
  • interval string | null
  • interval_count integer
  • current_period_end string | null date-time

    Next renewal.

  • cancel_at_period_end boolean
• reasons array of objects
  Show child attributesHide child attributes

  • key string
  • label string
  • free_text boolean

Used by: Sandbox: play the cancel flow, Open the cancel flow for a customer, Read a cancel session, Answer the current step, Cancel now

CancelSessionReplay

• object enum
  • cancel_session_replay
• id string
• steps array of objects

  Timestamped steps.

• reason string | null
• comment string | null
• feedback string | null
• outcome enum | null
  • saved
  • cancelled
  • abandoned
• cancel_status enum | null
  • pending
  • done
  • requested
  • failed

Used by: Replay a cancel session

CancelSessionReport

• object enum
  • cancel_session
• id string
• livemode boolean
• step enum
  • choose_subscription
  • reason
  • offer
  • feedback
  • confirm
  • done
• outcome enum | null
  • saved
  • cancelled
  • abandoned
• locale string
• holdout boolean
• published boolean
• customer object | null
• subscription object | null

  The subscription this session targets (offers, saved MRR, cancellation). Null at choose_subscription, for an unknown customer, or without a live subscription.

  Show child attributesHide child attributes

  • id string
  • plan string | null
  • status enum
    • incomplete
    • incomplete_expired
    • trialing
    • active
    • past_due
    • canceled
    • unpaid
    • paused
  • amount_cents integer

    Price per interval (quantity included), minor unit.

  • currency string | null
  • interval string | null
  • interval_count integer
  • current_period_end string | null date-time

    Next renewal.

  • cancel_at_period_end boolean
• subscriptions array of objects

  At choose_subscription only (several live subscriptions, none named by the token's subscription claim): the customer picks one (answer { subscription }) or cancels one (cancel { subscription }). Empty otherwise.

  Show child attributesHide child attributes

  • id string
  • plan string | null
  • status enum
    • incomplete
    • incomplete_expired
    • trialing
    • active
    • past_due
    • canceled
    • unpaid
    • paused
  • amount_cents integer

    Price per interval (quantity included), minor unit.

  • currency string | null
  • interval string | null
  • interval_count integer
  • current_period_end string | null date-time

    Next renewal.

  • cancel_at_period_end boolean
• reasons array of objects
  Show child attributesHide child attributes

  • key string
  • label string
  • free_text boolean

Used by: Cancel sessions

CancelSessionReportList

• object enum
  • list
• data array of objects (CancelSessionReport)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: Cancel sessions

CancelSessionResult

• kind enum
  • discount
  • pause
  • downgrade
  • talk
• currency string | null
• regular_amount_cents integer | null

  The price per interval before the offer (quantity included). Null for talk.

• next_invoice_at string | null date-time

  discount, downgrade: the next invoice's date (the provider's, else the renewal date).

• next_invoice_amount_cents integer | null

  discount, downgrade: the next invoice's amount from the provider (Stripe: upcoming invoice preview, read once when the offer is applied). Null when the provider cannot tell.

• discounted_until string | null date-time

  discount: when the usual price comes back (acceptance + the offer's months).

• discounted_invoices array of objects 12 items at most

  discount: the invoices due before discounted_until (12 at most), at next_invoice_amount_cents. [] otherwise.

  Show child attributesHide child attributes

  • at string date-time
  • amount_cents integer | null
• resumes_at string | null date-time

  pause: the resume date (null when your billing pauses it, billing by API).

• plan_name string | null

  downgrade: the new plan, when the offer names it.

Used by: Sandbox: play the cancel flow, Cancel sessions, Open the cancel flow for a customer, Read a cancel session, Answer the current step, Cancel now

ChurnScore

• object enum
  • churn_score
• customer string
• score integer | null 0 to 100

  null until computed.

• level enum | null

  Thresholds of the prevention flow (high ≥ 70, medium ≥ 40 by default).

  • low
  • medium
  • high
• model_version string | null
• computed_at string | null date-time
• factors array of objects

  What explains the score, points added (or removed).

  Show child attributesHide child attributes

  • key string
  • label string
  • points integer
• flag object | null (CustomerFlag)

  FLAGGED: a prevention signal before the renewal. Cleared when a new card arrives.

• history array of objects

  Last 30 computations, newest first.

  Show child attributesHide child attributes

  • score integer
  • level enum
    • low
    • medium
    • high
  • trigger enum
    • signup
    • daily
    • signal
    • sync
    • manual
    • attributes
    • cancel_session
    • import
  • computed_at string date-time

Used by: Churn score of a customer

ClientVersions

• object enum
  • client_versions
• livemode boolean
• window_days integer
• data array of objects
  Show child attributesHide child attributes

  • object enum
    • client
  • client string
  • name string | null
  • latest string | null

    null for a client NoChurn does not publish.

  • minimum string | null

    Older versions are unsupported.

  • status enum

    The worst status among the versions seen in the last 7 days, else the last version's.

    • current
    • update_available
    • unsupported
    • unknown
  • versions array of objects

    Newest first.

    Show child attributesHide child attributes

    • id string
    • version string
    • status enum

      current; update_available (below latest); unsupported (below minimum); unknown (a client NoChurn does not publish).

      • current
      • update_available
      • unsupported
      • unknown
    • origin_host string | null

      Widget only: the host of the page's Origin (never a path).

    • api_key object | null
      Show child attributesHide child attributes

      • id string
      • name string | null
      • kind enum
        • secret
        • publishable
      • mode enum
        • test
        • live
      • last4 string
    • oauth_client object | null

      The AI app, for the MCP server through OAuth.

      Show child attributesHide child attributes

      • id string
      • name string
    • first_seen_at string date-time
    • last_seen_at string date-time
    • calls_count integer

      Approximate (a lower bound): written at most once every 5 minutes per row.

Used by: Versions of NoChurn's client code calling the API

Customer

• object enum
  • customer
• id string

  NoChurn id, always present.

• stripe_customer_id string | null

  Stripe customer id, when billed by Stripe.

• external_id string | null

  The id of this customer in your app.

• stripe_account string | null
• livemode boolean
• email string | null
• company_domain string | null

  Domain of the email when it is a company's (not a free, disposable or placeholder address): the customer's logo is GET /v1/logos/{company_domain}.

• name string | null
• locale string | null
• country string | null
• region string | null

  State or province of the address.

Used by: Sandbox: create a test customer, Sandbox: the customer removes their card before the renewal, Customer profile, Pause all flows for a customer, Resume flows for a customer, List customers, Create a customer, Resolve a customer from any of its ids, Retrieve a customer, Update a customer — e.g. link your own id to a Stripe customer, Merge custom attributes

CustomerAccess

• object enum
  • customer_access
• customer string
• livemode boolean
• access enum

  restricted: block your app (keep paying, resuming and cancelling reachable).

  • full
  • restricted
• reason enum | null

  Null when full. paused: every live subscription is paused and the cancel flow's pause.inapp is wall.

  • payment_failed
  • paused
• since string | null date-time

  When the restriction started (the failure + the grace, or the start of the pause; null when unknown). Null when full.

• failing_since string | null date-time

  When the oldest unpaid invoice under recovery started failing.

• restricts_at string | null date-time

  When access will be restricted if still unpaid (full now, wall enabled); else null.

• invoice string | null

  The unpaid invoice (ninv_…) that sets the clock.

• pay_url string | null

  Where the customer pays or updates their card (null when nothing is failing).

• subscription string | null

  The paused subscription (nsub_…) when the cancel flow shows the pause (banner or wall); else null.

• paused_at string | null date-time

  With subscription: when the pause started (null when unknown).

Used by: May this customer use your app?

CustomerDuplicate

• object enum
  • customer_duplicate
• id string
• livemode boolean
• customer string

  The pair is stored with the smaller id first.

• other_customer string
• people array of objects (CustomerDuplicatePerson) 2 items at most

  Name and email of customer then other_customer; null for one that no longer exists (merged away).

• identifier enum

  What they share: an email, or ids one source sent together.

  • stripe
  • provider
  • external
  • email
• reason string
• status enum

  open (a To do), dismissed (not the same person), merged (one customer absorbed into the other).

  • open
  • dismissed
  • merged
• suggested_keep string | null

  Open: the customer to preselect as the one to keep: the one with a live subscription, else the one billed by a tool (Stripe or another), else the oldest. Merged: the kept one. Dismissed: null.

• kept_customer string | null

  Merged: the customer that holds everything now (the other one no longer exists).

• dismissed_at string | null date-time

Used by: List possible duplicate customers, Dismiss a possible duplicate, Merge a possible duplicate

CustomerDuplicateList

• object enum
  • list
• data array of objects (CustomerDuplicate)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: List possible duplicate customers

CustomerDuplicatePerson

• id string
• name string | null
• email string | null

Used by: List possible duplicate customers, Dismiss a possible duplicate, Merge a possible duplicate

CustomerDuplicateRun

• object enum
  • customer_duplicate_run
• id string
• livemode boolean
• kind enum

  scan: looks for duplicates among the customers already in base. merge_all: merges every open proposal into its suggested customer.

  • scan
  • merge_all
• status enum
  • queued
  • running
  • done
  • failed
• total integer

  scan: customers read. merge_all: open proposals at the start.

• processed integer

  How many of total were gone through so far (real progress).

• found integer

  scan: new proposals created (pairs already proposed, dismissed or merged are never proposed again).

• merged integer

  merge_all: pairs merged into their suggested customer.

• skipped integer

  merge_all: pairs decided meanwhile, or folded into another pair by an earlier merge of the run.

• failed integer

  merge_all: pairs that could not be merged (see failures); the others went on.

• failures array of objects

  merge_all: each failed pair and why (the first 100).

  Show child attributesHide child attributes

  • duplicate string
  • customers array of strings
  • reason string

Used by: Scan the customers for possible duplicates, Merge every open possible duplicate

CustomerDuplicateSummary

• object enum
  • customer_duplicate_summary
• livemode boolean
• open_count integer

  Open proposals of this mode.

• last_scanned_at string | null date-time

  End of the last finished scan of this mode (null: never scanned).

• scan object | null

  The latest scan (null: never).

  Show child attributesHide child attributes

  • object enum
    • customer_duplicate_run
  • id string
  • livemode boolean
  • kind enum

    scan: looks for duplicates among the customers already in base. merge_all: merges every open proposal into its suggested customer.

    • scan
    • merge_all
  • status enum
    • queued
    • running
    • done
    • failed
  • total integer

    scan: customers read. merge_all: open proposals at the start.

  • processed integer

    How many of total were gone through so far (real progress).

  • found integer

    scan: new proposals created (pairs already proposed, dismissed or merged are never proposed again).

  • merged integer

    merge_all: pairs merged into their suggested customer.

  • skipped integer

    merge_all: pairs decided meanwhile, or folded into another pair by an earlier merge of the run.

  • failed integer

    merge_all: pairs that could not be merged (see failures); the others went on.

  • failures array of objects

    merge_all: each failed pair and why (the first 100).

    Show child attributesHide child attributes

    • duplicate string
    • customers array of strings
    • reason string
  • error string | null

    failed: why the whole run stopped.

  • started_at string | null date-time
  • finished_at string | null date-time
  • created_at string date-time
• merge_all object | null

  The latest merge all (null: never).

  Show child attributesHide child attributes

  • object enum
    • customer_duplicate_run
  • id string
  • livemode boolean
  • kind enum

    scan: looks for duplicates among the customers already in base. merge_all: merges every open proposal into its suggested customer.

    • scan
    • merge_all
  • status enum
    • queued
    • running
    • done
    • failed
  • total integer

    scan: customers read. merge_all: open proposals at the start.

  • processed integer

    How many of total were gone through so far (real progress).

  • found integer

    scan: new proposals created (pairs already proposed, dismissed or merged are never proposed again).

  • merged integer

    merge_all: pairs merged into their suggested customer.

  • skipped integer

    merge_all: pairs decided meanwhile, or folded into another pair by an earlier merge of the run.

  • failed integer

    merge_all: pairs that could not be merged (see failures); the others went on.

  • failures array of objects

    merge_all: each failed pair and why (the first 100).

    Show child attributesHide child attributes

    • duplicate string
    • customers array of strings
    • reason string
  • error string | null

    failed: why the whole run stopped.

  • started_at string | null date-time
  • finished_at string | null date-time
  • created_at string date-time

Used by: Possible duplicates: count and scans

CustomerFlag

• reason enum
  • card_removed
  • card_expiring
• flagged_at string date-time

Used by: Sandbox: create a test customer, Sandbox: the customer removes their card before the renewal, Customer profile, Pause all flows for a customer, Resume flows for a customer, List customers, Create a customer, Resolve a customer from any of its ids, Retrieve a customer, Update a customer — e.g. link your own id to a Stripe customer, Churn score of a customer, Merge custom attributes

CustomerIdentifier

• kind enum

  stripe (cus_), provider (a billing, store or support tool's id), external (your id, current or previous), email, nochurn (the cst_ id of a customer merged into this one, still accepted).

  • stripe
  • external
  • email
  • provider
  • nochurn
• provider string | null

  The tool for stripe and provider ids (stripe, chargebee, app_store, intercom…).

• connection string | null

  The billing connection (scn_ / bcn_) or support integration (itg_) the id belongs to.

• value string
• source enum

  Who gave it: api, import, stripe, stripe_metadata, provider, support, manual, merge (moved by a merge).

  • api
  • stripe_metadata
  • stripe
  • manual
  • provider
  • support
  • import
  • merge
• created_at string date-time

Used by: Sandbox: create a test customer, Sandbox: the customer removes their card before the renewal, Customer profile, Pause all flows for a customer, Resume flows for a customer, List customers, Create a customer, Resolve a customer from any of its ids, Retrieve a customer, Update a customer — e.g. link your own id to a Stripe customer, Merge custom attributes

CustomerInsight

• object enum
  • customer_insight
• id string
• summary string
• signals array of strings
• next_step string | null
• sources array of enums
  • stripe
  • custom_data
  • support
• computed_at string date-time

Used by: Customer profile, AI analysis of a customer

CustomerPage

• object enum
  • list
• data array of objects (Customer)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

• total_count integer

  With include[]=total_count.

Used by: List customers

CustomerProfile

• object enum
  • customer_profile
• customer object (Customer)
• billing object
  Show child attributesHide child attributes

  • mrr_cents integer
  • currency string | null
  • lifetime_value_cents integer
  • lifetime_value_since string | null date-time

    Start of the history the lifetime value covers.

  • customer_since string date-time
  • payment_method object | null (PaymentMethodSummary)

    Default payment method (null when none).

  • next_renewal object | null
    Show child attributesHide child attributes

    • at string date-time
    • amount_cents integer
    • currency string | null
    • subscription string
  • subscriptions array of objects
    Show child attributesHide child attributes

    • id string
    • plan string | null
    • status string
    • mrr_cents integer
    • currency string | null
    • interval string | null
    • interval_count integer
    • current_period_end string | null date-time
    • cancel_at_period_end boolean
• score object

  Factors are computed with the churn score (M4).

  Show child attributesHide child attributes

  • score integer | null
  • level string | null
  • factors array of objects
    Show child attributesHide child attributes

    • key string
    • label string
    • points integer
  • computed_at string | null date-time
• ai_analysis object | null (CustomerInsight)
• ai_analysis_status enum

  fresh: less than 7 days old and no important event since (POST …/insight returns it without an AI call). stale: older, or an important event came after it (ai_analysis is the old one). missing: never analysed. not_enough_data: too little activity for an analysis (POST …/insight answers 422 insufficient_data).

  • fresh
  • stale
  • missing
  • not_enough_data
• attributes object
• links object
  Show child attributesHide child attributes

  • stripe_dashboard string | null uri

Used by: Customer profile

CustomerSummary

• object enum
  • customer_summary
• livemode boolean
• timezone string
• month_start string date-time
• active object
  Show child attributesHide child attributes

  • count integer
  • new_this_month integer
• high_risk object
  Show child attributesHide child attributes

  • threshold integer
  • count integer
  • mrr array of objects

    One entry per currency, largest first. Never converted.

    Show child attributesHide child attributes

    • currency string
    • cents integer
  • scored_customers integer

    Active customers with a score.

• in_recovery object
  Show child attributesHide child attributes

  • count integer
  • mrr array of objects

    One entry per currency, largest first. Never converted.

    Show child attributesHide child attributes

    • currency string
    • cents integer
• saved_this_month object
  Show child attributesHide child attributes

  • count integer | null
  • unavailable_reason string | null

Used by: The 4 figures of the Customers page

Dispute

• object enum
  • dispute
• id string
• livemode boolean
• provider enum
  • stripe
  • chargebee
  • recurly
  • maxio
  • zuora
  • paddle
  • lemon_squeezy
  • polar
  • braintree
  • mollie
  • gocardless
  • razorpay
  • app_store
  • google_play
  • custom
• billing_connection string
• external_id string
• charge string | null
• customer string | null
• customer_name string | null
• customer_email string | null
• customer_plan string | null

  Plan of the customer's latest subscription in this mode.

• amount_cents integer

Used by: Disputes

DisputeDetail

• object enum
  • dispute
• id string
• livemode boolean
• provider enum
  • stripe
  • chargebee
  • recurly
  • maxio
  • zuora
  • paddle
  • lemon_squeezy
  • polar
  • braintree
  • mollie
  • gocardless
  • razorpay
  • app_store
  • google_play
  • custom
• billing_connection string
• external_id string
• charge string | null
• customer string | null
• customer_name string | null
• customer_email string | null
• customer_plan string | null

  Plan of the customer's latest subscription in this mode.

• amount_cents integer

Used by: A dispute with its evidence and draft, Include, exclude, reorder or add evidence, Attach a file as evidence, Remove an attached file before sending, Draft the reply again, Edit or approve the reply, Send the reply to the provider, Accept the dispute, Set the chance of winning yourself, or give it back to the AI

DisputeDraft

• id string
• object enum
  • dispute_draft
• text string
• cited_item_ids array of strings

  Evidence items the reply relies on (dev_…).

• model string | null

  AI model, or "template" when the AI answer was rejected.

• status enum
  • draft
  • approved
  • sent
• edited_by string | null
• edited_at string | null date-time
• created_at string date-time

Used by: A dispute with its evidence and draft, Include, exclude, reorder or add evidence, Attach a file as evidence, Remove an attached file before sending, Draft the reply again, Edit or approve the reply, Send the reply to the provider, Accept the dispute, Set the chance of winning yourself, or give it back to the AI

DisputeEvidenceItem

• id string
• object enum
  • dispute_evidence_item
• kind enum
  • communication
  • policy
  • usage
  • reminder
  • cancel_history
  • refund_history
  • receipt
  • other
• title string
• content string | null
• source_type string | null
• source_id string | null
• occurred_at string | null date-time
• included boolean
• position integer
• file object | null

  A file attached by a person (source_type file): PDF, JPEG or PNG, 5 MB at most. null for other evidence.

  Show child attributesHide child attributes

  • filename string
  • content_type enum
    • application/pdf
    • image/jpeg
    • image/png
  • byte_size integer
  • sent_to_provider boolean

    The provider has a copy (given when the reply was sent).

Used by: A dispute with its evidence and draft, Include, exclude, reorder or add evidence, Attach a file as evidence, Remove an attached file before sending, Draft the reply again, Edit or approve the reply, Send the reply to the provider, Accept the dispute, Set the chance of winning yourself, or give it back to the AI

DisputeList

• object enum
  • list
• data array of objects (Dispute)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: Disputes

DisputesSummary

• object enum
  • disputes_summary
• livemode boolean
• days integer
• open integer
• due_within_72h integer
• open_amount array of objects
  Show child attributesHide child attributes

  • currency string
  • amount_cents integer
• next_due_at string | null date-time

  Soonest upcoming deadline of an open dispute.

• drafts_ready integer

  Open disputes NoChurn can send whose reply is drafted: they wait for a review.

• won integer
• lost integer

  Lost or accepted.

• decided integer

  Sample size of win_rate.

• win_rate number | null

Used by: Counts of the Disputes tab

EmailPreview

• object enum
  • email_preview
• step string

  email_1…, card_removed, card_expiring, renewal_reminder, d30, d60, d90, review_follow_up

• label string
• language string
• source enum

  Where the text shown comes from.

  • custom
  • ai
  • template
• subject string

  Placeholders filled.

• text string

  Plain-text body, placeholders filled.

• html string

  HTML body as sent (escaped paragraphs and links, no script, no style).

• ai_generated boolean
• review object
  Show child attributesHide child attributes

  • state enum
    • auto_approved
    • needs_review
  • issues array of strings
• warnings array of strings

  What the preview differs on, and problems of your text.

• customer object

  Who the placeholders were filled for: the example customer (fictional data) or a real customer.

  Show child attributesHide child attributes

  • id string | null
  • name string | null
  • example boolean

Used by: Preview an email of a flow

EmailSuppression

• object enum
  • email_suppression
• id string
• livemode boolean
• email string
• reason enum
  • unsubscribed
  • bounced
  • complained
  • gdpr
  • manual
• scope enum
  • all
  • marketing
• message string | null
• created_at string date-time

Used by: Addresses never emailed again, Never email this address again

EmailSuppressionList

• object enum
  • list
• data array of objects (EmailSuppression)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: Addresses never emailed again

Error

• error object
  Show child attributesHide child attributes

  • code enum
    • unauthorized
    • forbidden
    • not_found
    • invalid_request
    • conflict
    • internal_error
    • rate_limited
    • customer_not_found
    • ambiguous_customer
    • stripe_not_configured
    • stripe_error
    • two_factor_required
    • attribute_type_mismatch
    • attribute_limit_reached
    • provider_not_available
    • capability_missing
    • dispute_already_submitted
    • dispute_not_supported_by_provider
    • provider_error
    • evidence_file_unsupported
    • evidence_file_too_large
    • evidence_files_limit
    • logo_unsupported
    • logo_too_large
    • plan_billing_not_configured
    • custom_plan_required
    • test_mode_only
    • live_approval_required
    • live_read_not_granted
    • insufficient_scope
    • publishable_key_required
    • payload_too_large
    • subscription_not_found
    • subscription_required
    • email_domain_provisioning_failed
    • insufficient_data
    • nothing_to_resume
  • message string
  • fix string
  • docs_url string uri
  • retry_after integer

    Seconds to wait (rate_limited only).

Used by: The account of the API key, Update account settings, Sandbox: create a test customer, Sandbox: simulate a failed payment, Integration checklist, Tested code for a platform and a case, List subscriptions, optionally for one customer, Send a subscription, List the API keys of the current mode, Create an API key, Rename a key or change its access, Revoke an API key, Connect a provider with API keys, Save the mapping rules, Turn the mapping on, List invoices, optionally for one customer, List payment methods, optionally for one customer, Upload a logo for the cancel modal, Remove a logo, Open the cancel flow for a customer, Add an offer to the cancel flow's library, Versions of NoChurn's client code calling the API, May this customer use your app?, Customer profile, Scan the customers for possible duplicates, List customers, Create a customer, Resolve a customer from any of its ids, Retrieve a customer, Update a customer — e.g. link your own id to a Stripe customer, List possible duplicate customers, Dismiss a possible duplicate, Merge a possible duplicate, One reply, KPIs, funnel and holdout of a flow, Track a usage event, Recompute now, A dispute with its evidence and draft, Attach a file as evidence, Remove an attached file before sending, Send the reply to the provider, Accept the dispute, Set the chance of winning yourself, or give it back to the AI, Preview an email of a flow, Resume the paused subscription, List events, newest first, Choose the events sent to Slack (and its channel) or added as Intercom notes, Retrieve a flow with its draft, Edit the draft, Pause a flow, What the customer's app shows: payment banner and wall, Connect Crisp (website or plugin token) or Gorgias, OAuth URL of a support tool or Slack, Sync now, Theme again, AI analysis of a customer, Ask a human to do something in live mode, Approve a live request, List the unified log, newest first, Count of today's lines and of the errors of a window, Retrieve a line with its payload, Approve an email waiting for review, Send a test email to yourself, Email a setup step to a colleague, Allow or stop an AI app's live reads, Revoke an AI app's access, Run a query, Schedule a report, Answer the customer, Add a review page, Merge custom attributes, Declare an attribute before its first send, Mark an attribute sensitive, Import a CSV of customers and attributes, Create a segment, Edit a segment, Delete a segment, Draft an A/B test, Start, stop, or pick a winner, Make flows follow Settings › Send schedule, Change the audience or any option, Add your sending domain, Check the DNS records, New random subdomain, Get the Stripe Connect URL to open in the browser, Choose who handles payment retries, or where your user id is read, Disconnect a Stripe account, Re-run the Stripe import, Change a member's role, Invite someone, Cancel a pending invitation, Add a webhook endpoint, Read a cancel session, Answer the current step, Cancel now, The widget had to restore the hidden cancel button, Track usage events from the browser

Event

• object enum
  • event
• id string
• type string
• subject object | null
  Show child attributesHide child attributes

  • type string
  • id string
• reason string | null
• actor object
  Show child attributesHide child attributes

  • type enum
    • api_key
    • user
    • system
    • ai
    • ai_agent
    • customer
  • id string | null

    ai_agent: the OAuth grant (ogr_…) of the AI app.

  • name string | null

    ai_agent: the MCP client's name (as it registered).

• livemode boolean
• data object
• created_at string date-time

Used by: List events, newest first

EventList

• object enum
  • list
• data array of objects (Event)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: List events, newest first

Experiment

• object enum
  • experiment
• id string
• flow string
• segment string | null
• name string
• target enum
  • offer
  • text
  • timing
  • design
  • channel
• goal_metric enum
  • saved
  • card_updated_before_renewal
  • recovered_within_7d
  • won_back
• status enum
  • draft
  • running
  • stopped
  • decided
• auto_pick boolean
• threshold number
• min_sample integer
• started_at string | null date-time

Used by: A/B tests, Draft an A/B test, Start, stop, or pick a winner

ExperimentList

• object enum
  • list
• data array of objects (Experiment)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: A/B tests

Feedback

• object enum
  • feedback
• answers_90d integer
• run object | null
  Show child attributesHide child attributes

  • id string
  • computed_at string date-time
  • summary string | null
  • answers_count integer
  • currency string | null

    Currency of the themes' mrr_lost_cents (the reporting currency when the run was computed).

  • themes array of objects
    Show child attributesHide child attributes

    • id string
    • title string
    • mentions integer

      Counted in code.

    • delta_pct number | null
    • main_reason_key string | null
    • mrr_lost_cents integer
    • unconverted_currencies array of strings

      Currencies of lost MRR without an ECB rate: left out of mrr_lost_cents.

    • quotes array of strings

      Feedback item ids to quote.

• items array of objects
  Show child attributesHide child attributes

  • id string
  • source enum
    • cancel_session
    • winback_reply
    • support
  • text string

    Customer text: show as text.

  • reason_key string | null
  • theme string | null
  • plan string | null
  • country string | null
  • customer string | null
  • occurred_at string date-time

Used by: Feedback themes and latest answers

FeedbackRefresh

• object enum
  • feedback_refresh
• queued boolean

Used by: Theme again

Flow

• object enum
  • flow
• id string
• kind enum
  • prevention
  • recovery
  • cancel
  • winback
• key string
• name string
• status enum

  draft: never published; test: runs in test mode only; live: runs in both modes; paused.

  • draft
  • test
  • live
  • paused
• holdout_percent integer

  Share of customers NoChurn leaves alone, to measure its effect.

• test_version object | null
  Show child attributesHide child attributes

  • id string
  • number integer
  • published_at string date-time
  • published_to enum
    • test
    • live
• live_version object | null
  Show child attributesHide child attributes

  • id string
  • number integer
  • published_at string date-time
  • published_to enum
    • test
    • live
• unpublished_changes array of strings

  Draft sections that differ from the last version.

• mode_status object

  Where the flow stands in the mode of the request (NoChurn-Mode or the key's mode).

  Show child attributesHide child attributes

  • livemode boolean
  • state enum

    published: a version runs in this mode; draft: nothing published in this mode yet; paused: paused (both modes).

    • published
    • draft
    • paused
  • version integer | null

    Number of the version that runs in this mode.

  • published_at string | null date-time
  • unpublished_changes array of strings

    Draft sections not yet published in this mode (a pending draft).

• draft_updated_at string | null date-time

Used by: List the 4 flows

FlowDetail

• object enum
  • flow
• id string
• kind enum
  • prevention
  • recovery
  • cancel
  • winback
• key string
• name string
• status enum

  draft: never published; test: runs in test mode only; live: runs in both modes; paused.

  • draft
  • test
  • live
  • paused
• holdout_percent integer

  Share of customers NoChurn leaves alone, to measure its effect.

• test_version object | null
  Show child attributesHide child attributes

  • id string
  • number integer
  • published_at string date-time
  • published_to enum
    • test
    • live
• live_version object | null
  Show child attributesHide child attributes

  • id string
  • number integer
  • published_at string date-time
  • published_to enum
    • test
    • live
• unpublished_changes array of strings

  Draft sections that differ from the last version.

• mode_status object

  Where the flow stands in the mode of the request (NoChurn-Mode or the key's mode).

  Show child attributesHide child attributes

  • livemode boolean
  • state enum

    published: a version runs in this mode; draft: nothing published in this mode yet; paused: paused (both modes).

    • published
    • draft
    • paused
  • version integer | null

    Number of the version that runs in this mode.

  • published_at string | null date-time
  • unpublished_changes array of strings

    Draft sections not yet published in this mode (a pending draft).

• draft_updated_at string | null date-time

Used by: Remove a logo, Retrieve a flow with its draft, Edit the draft, Publish the draft to test or live mode, Discard the unpublished changes, Put an older version back in the draft, Pause a flow, Resume a paused flow

FlowList

• object enum
  • list
• data array of objects (Flow)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: List the 4 flows

FlowNotifications

• object enum
  • flow_notifications
• livemode boolean
• events array of objects

  The events that can be notified, with the flow that emits them.

  Show child attributesHide child attributes

  • type enum
    • recovery.opened
    • recovery.recovered
    • recovery.lost
    • cancel_session.offer_accepted
    • cancel_session.completed
    • customer.flagged
    • winback.reactivated
  • flow enum
    • prevention
    • recovery
    • cancel
    • winback
• slack object
  Show child attributesHide child attributes

  • kind enum
    • slack
    • intercom_note
  • connected boolean

    The integration (Slack, Intercom) is connected and active.

  • integration_status enum | null

    null: never connected.

    • active
    • error
    • revoked
  • workspace string | null

    The Slack workspace or Intercom app.

  • events array of enums

    Empty: nothing is sent.

    • recovery.opened
    • recovery.recovered
    • recovery.lost
    • cancel_session.offer_accepted
    • cancel_session.completed
    • customer.flagged
    • winback.reactivated
  • channel string | null

    Slack only: where messages go (the channel chosen for Slack alerts until one is saved here).

  • notes_access enum | null

    Intercom only: whether the install may write notes on contacts. reconnect_required: Intercom refused a note, reconnect it.

    • unknown
    • ok
    • reconnect_required
  • last_delivery_at string | null date-time
  • last_error string | null

    Why the last notification failed, with what to do.

• intercom object
  Show child attributesHide child attributes

  • kind enum
    • slack
    • intercom_note
  • connected boolean

    The integration (Slack, Intercom) is connected and active.

  • integration_status enum | null

    null: never connected.

    • active
    • error
    • revoked
  • workspace string | null

    The Slack workspace or Intercom app.

  • events array of enums

    Empty: nothing is sent.

    • recovery.opened
    • recovery.recovered
    • recovery.lost
    • cancel_session.offer_accepted
    • cancel_session.completed
    • customer.flagged
    • winback.reactivated
  • channel string | null

    Slack only: where messages go (the channel chosen for Slack alerts until one is saved here).

  • notes_access enum | null

    Intercom only: whether the install may write notes on contacts. reconnect_required: Intercom refused a note, reconnect it.

    • unknown
    • ok
    • reconnect_required
  • last_delivery_at string | null date-time
  • last_error string | null

    Why the last notification failed, with what to do.

Used by: Slack messages and Intercom notes sent when a flow acts, Choose the events sent to Slack (and its channel) or added as Intercom notes

FlowRun

• object enum
  • flow_run
• id string
• livemode boolean
• flow string
• version integer
• customer object | null
  Show child attributesHide child attributes

  • id string
  • name string | null
  • email string | null
  • mrr_cents integer
  • currency string | null
• subject object | null
  Show child attributesHide child attributes

  • type string | null
  • id string
• holdout boolean

  In the holdout group: NoChurn does nothing, the run is only measured.

• state enum
  • active
  • succeeded
  • failed
  • stopped
• current_step string | null
• outcome enum | null
  • prevented
  • recovered
  • saved
  • won_back
  • lost
  • cancelled
  • abandoned
• outcome_at string | null date-time

Used by: Customers in this flow

FlowRunList

• object enum
  • list
• data array of objects (FlowRun)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: Customers in this flow

FlowStats

• object enum
  • flow_stats
• flow string
• kind enum
  • prevention
  • recovery
  • cancel
  • winback
• livemode boolean
• period object
  Show child attributesHide child attributes

  • key enum
    • month
    • 30d
    • 90d
    • 12m
  • from string date-time
  • to string date-time
• kpis array of objects

  4 KPIs; saved / recovered / won back / prevented count confirmed outcomes.

  Show child attributesHide child attributes

  • key string
  • label string
  • value number | null
  • unit enum
    • count
    • money
    • rate
    • days
  • sample_size integer
  • pending integer

    Outcomes reached but not confirmed yet (30 days).

  • currency string
  • open_rate number | null
  • breakdown array of objects

    Per original currency: the amount and its value in the reporting currency (ECB rate of its day).

    Show child attributesHide child attributes

    • currency string
    • amount_cents integer

      In this currency.

    • converted_cents integer

      Its converted part, in the reporting currency.

    • unconverted_cents integer

      In this currency: amounts of days without an ECB rate, left out of the total.

• funnel array of objects

  5 steps: runs started in the period that reached each step, share of the first.

  Show child attributesHide child attributes

  • key string
  • label string
  • count integer
  • share number | null
• holdout object
  Show child attributesHide child attributes

  • percent integer | null
  • runs integer
  • natural_rate number | null

    What happened without NoChurn (holdout group).

  • treated_rate number | null
  • lift number | null
  • sample_size integer

Used by: KPIs, funnel and holdout of a flow

FlowTestEmail

• object enum
  • flow_test_email
• to string
• subject string
• body string
• ai_generated boolean
• source enum

  custom: your text; ai: written by the AI; template: NoChurn's text.

  • custom
  • ai
  • template
• review object
  Show child attributesHide child attributes

  • state enum
    • auto_approved
    • needs_review
  • issues array of strings

Used by: Send a test email to yourself

FlowVersion

• object enum
  • flow_version
• id string
• flow string
• number integer
• config object
• holdout_percent integer
• published_to enum
  • test
  • live
• published_by string | null
• published_at string date-time

Used by: List published versions, newest first

FlowVersionList

• object enum
  • list
• data array of objects (FlowVersion)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: List published versions, newest first

FraudWarning

• id string
• object enum
  • fraud_warning
• livemode boolean
• provider string
• external_id string
• charge string | null
• customer string | null
• customer_name string | null
• customer_email string | null
• customer_plan string | null
• amount_cents integer | null
• currency string | null

Used by: Early fraud warnings, Refund before the dispute, Keep the payment

FraudWarningList

• object enum
  • list
• data array of objects (FraudWarning)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: Early fraud warnings

Import

• object enum
  • import
• id string
• status enum
  • pending
  • running
  • completed
  • failed
• filename string | null
• mapping object
• rows_total integer
• rows_imported integer
• rows_failed integer
• errors array of objects

  Row by row, 500 at most.

  Show child attributesHide child attributes

  • line integer

    Line in the file (1 = header).

  • code string
  • message string
• livemode boolean
• created_at string date-time
• started_at string | null date-time

Used by: Imports, Import a CSV of customers and attributes, An import and its error report

ImportList

• object enum
  • list
• data array of objects (Import)
• has_more boolean
• next_cursor string | null

  Pass as starting_after to get the next page.

Used by: Imports

ImportPreview

• object enum
  • import_preview
• columns array of objects
  Show child attributesHide child attributes

  • name string
  • target string
• rows_total integer
• rows array of objects

  First 10 rows.

Used by: Import a CSV of customers and attributes

InappPausedDetails

• kind enum
  • paused
• paused_at string | null date-time

  When the pause started (null when NoChurn never saw it start).

• resumes_at string | null date-time

  When it resumes by itself (null: no date set).

• regular_amount_cents integer

  The price per interval once resumed (quantity included).

• currency string | null
• resume_allowed boolean

  POST /v1/inapp/resume can resume it (Stripe, or a provider NoChurn resumes); false for billing by API.

Used by: Resume the paused subscription, What the customer's app shows: payment banner and wall, Hide the banner for 24 hours

InappPaymentDetails

• kind enum
  • payment_failed
• amount_due_cents integer
• currency string | null
• invoice_due_at string | null date-time

  The invoice's due date when the billing set one, else null.

• payment_method object | null

  The method of the failed payment, else the customer's default one; null when unknown.

  Show child attributesHide child attributes

  • brand string | null
  • last4 string | null
  • exp_month integer | null
  • exp_year integer | null
• decline enum

  Mapped from the provider's decline or failure code (expired_card → expired; insufficient_funds; authentication_required; anything else → declined).

  • expired
  • insufficient_funds
  • authentication_required
  • declined

Used by: Resume the paused subscription, What the customer's app shows: payment banner and wall, Hide the banner for 24 hours

InappState

• object enum
  • inapp_state
• customer string
• failing_since string | null date-time
• access enum

  restricted exactly when wall.show is true: the same calculation as GET /v1/customers/{id}/access (DECISIONS 81, 87).

  • full
  • restricted
• access_reason enum | null

  Why access is restricted; null when full. paused: only when the cancel flow's pause.inapp is wall.

  • payment_failed
  • paused
• locale enum

  ?locale=, then the customer's language, then the account's.

  • en
  • fr
  • de
  • it
  • pt
• texts object | null

  Banner and wall texts in this locale (banner_text, banner_cta, dismiss, banner_days_left, banner_last_day, wall_title, wall_text, wall_cta, pay_cta, amount_due, card_expired, decline_expired, decline_insufficient_funds, decline_authentication_required, decline_declined, checking_payment, back_in_title, back_in_text, data_safe, paused_banner_text, paused_title, paused_text, paused_resumes, resume_cta, resuming, resumed_title, resumed_text, cancel_now): the recovery flow's inapp.texts, else NoChurn's. {{amount}} is already filled (the unpaid amount, or the regular price when paused); {{days}}, {{date}} and {{exp}} are for the widget to fill (from details, days_left, in the customer's locale). Null when nothing is shown.

• theme object | null (CancelFlowTheme)

  The cancel flow's design (same tokens as the modal). Null when nothing is shown.

• banner object
  Show child attributesHide child attributes

  • show boolean
  • text string
  • cta_url string | null
  • cta_label string | null
  • kind enum
    • payment_failed
    • paused
  • audience enum
    • admins
    • everyone
  • dismissible_for_hours integer
  • dismiss_label string
  • restricts_at string | null date-time

    payment_failed: when the wall comes up if still unpaid (wall enabled, not up yet); else null.

  • days_left integer | null ≥ 0

    Whole days until restricts_at, in the customer's time zone (0 = last day); null with restricts_at.

  • details object | null

    The facts the banner draws (same as wall.details); null when the banner is not shown.

    payment_failedpaused

    • kind enum
      • payment_failed
    • amount_due_cents integer
    • currency string | null
    • invoice_due_at string | null date-time

      The invoice's due date when the billing set one, else null.

    • payment_method object | null

      The method of the failed payment, else the customer's default one; null when unknown.

      Show child attributesHide child attributes

      • brand string | null
      • last4 string | null
      • exp_month integer | null
      • exp_year integer | null
    • decline enum

      Mapped from the provider's decline or failure code (expired_card → expired; insufficient_funds; authentication_required; anything else → declined).

      • expired
      • insufficient_funds
      • authentication_required
      • declined
• wall object
  Show child attributesHide child attributes

  • show boolean
  • text string
  • cta_url string | null
  • cta_label string | null
  • kind enum
    • payment_failed
    • paused
  • shows_after_days integer | null

    payment_failed: the grace in days; null for paused (at once).

  • cancel object

    Click to cancel on the wall: open the cancel modal (NoChurn.cancel, POST /v1/cancel_sessions); if that fails, POST the customer token as a form field token to fallback_url.

    Show child attributesHide child attributes

    • label string

      The cancel flow's cancel_now text (or the in-app override).

    • fallback_url string | null

      The publishable key's fallback cancel link (null for a secret key).

  • details object | null

    The facts the wall draws; null when the wall is not shown. paused: cta_label is the resume button (POST /v1/inapp/resume), null when resume_allowed is false; cta_url is null.

    payment_failedpaused

    • kind enum
      • payment_failed
    • amount_due_cents integer
    • currency string | null
    • invoice_due_at string | null date-time

      The invoice's due date when the billing set one, else null.

    • payment_method object | null

      The method of the failed payment, else the customer's default one; null when unknown.

      Show child attributesHide child attributes

      • brand string | null
      • last4 string | null
      • exp_month integer | null
      • exp_year integer | null
    • decline enum

      Mapped from the provider's decline or failure code (expired_card → expired; insufficient_funds; authentication_required; anything else → declined).

      • expired
      • insufficient_funds
      • authentication_required
      • declined