Returns customers filtered by query string parameters. Atleast one variable must be provided to do the search. All the customers meeting the search criteria will be returned
GET
/
v1
/
c
/
customer
returns customers filtered by query string parameters
curl --request GET \ --url http://127.0.0.1:8080/v1/c/customer \ --header 'wb-key: <api-key>'
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Wingback","colors":{"primary":"#EF3B4D","light":"#FF7886","dark":"#D81D38"},"favicon":"/media/favicon.png","logo":{"light":"https://mintcdn.com/wingback/GadBRdJt85xVxME0/media/logo/light.svg?fit=max\u0026auto=format\u0026n=GadBRdJt85xVxME0\u0026q=85\u0026s=93b61d8945910151ec8df39c2b469c8e","dark":"https://mintcdn.com/wingback/GadBRdJt85xVxME0/media/logo/dark.svg?fit=max\u0026auto=format\u0026n=GadBRdJt85xVxME0\u0026q=85\u0026s=ba6722dedd801b55082f19792ea3b441"},"api":{"mdx":{"server":"https://api.wingback.com"}},"navbar":{"links":[],"primary":{"type":"button","label":"Go to Dashboard","href":"https://app.wingback.com/"}},"footer":{"socials":{"website":"https://wingback.com","twitter":"https://twitter.com/wingbackapp","linkedin":"https://www.linkedin.com/company/wingbackapp/"}},"integrations":{"posthog":{"apiKey":"phc_9zg8YkIBr0SuofRjG6TujIu9Q6I2deAFFat4U3DpbrV","apiHost":"https://i.wingback.com"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wingback","hasAudioNarration":false,"actualSubdomain":"wingback","customDomains":["docs-int.wingback.com"],"gitSource":{"type":"github","owner":"wingbackapp","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"docs","mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c343cf0492c7637e2ac2","collectionId":"df9c82e5-67e0-472b-acfa-7306b676d252","schemaVersion":"v2"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a20c343cf0492c7637e2ac2:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Developer Documentation","count":41},{"language":"default","tag":"API Reference","count":31},{"language":"default","tag":"SGI Fundamentals","count":19},{"language":"default","tag":"Pricing Model Guides","count":16},{"language":"default","tag":"User Guides","count":13},{"language":"default","tag":"User Manuals","count":10},{"language":"default","tag":"Customer","count":8},{"language":"default","tag":"Payment","count":6},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Feature Overview","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"dev/api-reference/customer/get_c_customer","slug":"/dev/api-reference/customer/get_c_customer","pageMetadata":{"title":"Search for Customers","openapi":"GET /v1/c/customer","description":"Returns customers filtered by query string parameters. Atleast one variable must be provided to do the search. All the customers meeting the search criteria will be returned","href":"/dev/api-reference/customer/get_c_customer"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns customers filtered by query string parameters. Atleast one variable must be provided to do the search. All the customers meeting the search criteria will be returned\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const IntRedir=()=>{if(typeof document===`undefined`){return null}else{setTimeout(()=>{const currentUrl=new URL(window.location.href);if(currentUrl.hostname===`docs-int.wingback.com`){currentUrl.hostname=`docs.wingback.com`;window.location.replace(currentUrl.toString())}},1);return _jsx(_Fragment,{})}};function _createMdxContent(props){const{_MdxComponentBoundary}={..._provideComponents(),...props.components};if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsx(_MdxComponentBoundary,{name:`IntRedir`,children:_jsx(IntRedir,{})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{IntRedir,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Search for Customers","openapi":"GET /v1/c/customer","description":"Returns customers filtered by query string parameters. Atleast one variable must be provided to do the search. All the customers meeting the search criteria will be returned","href":"/dev/api-reference/customer/get_c_customer"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[19,38,""],[136,436,"null;function _creat"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/wingback/bbb25f53a15d63f9/int-redir.js"],"openApiReferenceData":{"operation":{"tags":["customer"],"summary":"returns customers filtered by query string parameters","operationId":"all_customers","parameters":["d28a606e-5d01-4118-829c-e5a31aa14322","b1d8fbb8-269d-4267-b76c-553d84f08ddd","9125a328-2570-4a88-a0c7-6d197baef6ee","d3e3043b-f8ac-4e73-9529-6371fd7401eb","ad3d2c90-cd6a-460f-95df-b341aa295407","6f23f789-de18-4978-88f1-90e4047cb111","dca999a9-5d46-490b-9008-ff2d324d3762","1c3df38b-8725-4c0f-9f29-7d64ec2bf2c7","0fabfd62-7fc6-4bce-b90d-b689015ce5b0","e1059056-c0b8-4ade-8968-3984889fc2a7","7e0120b0-fe64-4610-bdde-4d8e3988ab88","4a4495e2-ce0e-4981-b7da-c279dff6ae75","dfe5f780-6c09-4926-a473-8d8f3010263b"],"responses":{"200":"8240d957-c405-4054-90f3-44ebb44a1ab8"},"security":["edffcfc4-3560-4ae2-a410-6ada6c281b6b","d22f7e01-034d-44f1-be18-4d82648683ef"],"method":"get","type":"path","servers":["a4003425-b8cc-41a9-b3c3-854191252b9c","bc411509-c143-4d72-a409-c7938d980f87"],"path":"/v1/c/customer","baseUrlOptions":["http://127.0.0.1:8080","https://api.app.test.wingback.com"],"title":"returns customers filtered by query string parameters","description":"Returns customers filtered by query string parameters. Atleast one variable must be provided to do the search. All the customers meeting the search criteria will be returned","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d28a606e-5d01-4118-829c-e5a31aa14322":{"name":"id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"b1d8fbb8-269d-4267-b76c-553d84f08ddd":{"name":"email","in":"query","required":false,"schema":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"9125a328-2570-4a88-a0c7-6d197baef6ee":{"name":"customer_reference","in":"query","required":false,"schema":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"d3e3043b-f8ac-4e73-9529-6371fd7401eb":{"name":"plan","in":"query","required":false,"schema":{"oneOf":[{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"ad3d2c90-cd6a-460f-95df-b341aa295407":{"name":"status","in":"query","required":false,"schema":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"6f23f789-de18-4978-88f1-90e4047cb111":{"name":"listed","in":"query","required":false,"schema":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"dca999a9-5d46-490b-9008-ff2d324d3762":{"name":"search","in":"query","required":false,"schema":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"1c3df38b-8725-4c0f-9f29-7d64ec2bf2c7":{"name":"contract_plan_name","in":"query","required":false,"schema":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"0fabfd62-7fc6-4bce-b90d-b689015ce5b0":{"name":"payment_status","in":"query","required":false,"schema":{"oneOf":[{"type":"string","description":"Status of the invoice:\n* PendingValidation - Invoice awaits manual review\n* ReadyForPayment - invoice can be paid\n* Paid - invoice was paid","enum":["pending_validation","ready_for_payment","paid"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | null"}},"e1059056-c0b8-4ade-8968-3984889fc2a7":{"name":"metadata","in":"query","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Filter for customer metadata.","uniqueKey":"oneOf.0","typeLabel":"string[]"},{"type":"string","description":"Filter for customer metadata.","uniqueKey":"oneOf.1","typeLabel":"string"},{"type":"object","description":"Filter for customer metadata.","additionalProperties":{"type":"string","uniqueKey":"oneOf.2.additionalProperties","typeLabel":"string"},"uniqueKey":"oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.3","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string[] | string | object | null"}},"7e0120b0-fe64-4610-bdde-4d8e3988ab88":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"isRequired":false,"uniqueKey":"","typeLabel":"integer\u003cint32>"}},"4a4495e2-ce0e-4981-b7da-c279dff6ae75":{"name":"offset","in":"query","required":false,"schema":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"dfe5f780-6c09-4926-a473-8d8f3010263b":{"name":"direction","in":"query","required":false,"schema":{"type":"string","description":"Pagination direction:\n* Forward - from first entry to last\n* Backward - from last entry to first","enum":["forward","backward"],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"8240d957-c405-4054-90f3-44ebb44a1ab8":{"description":"Customers","content":{"application/json":{"schema":{"type":"object","description":"A paginated result of the requested resource\nThis is based on Keyset Pagination\nhttps://vladmihalcea.com/sql-seek-keyset-pagination/","required":["total","total_pages","current_page","hits"],"properties":{"current_page":{"type":"integer","description":"Number of the current page","isRequired":true,"uniqueKey":"current_page","typeLabel":"integer"},"hits":{"type":"array","items":{"type":"object","description":"Customer detailed information","required":["id","status","emails","created","metadata"],"properties":{"created":{"type":"string","description":"Date created","isRequired":true,"uniqueKey":"hits.items.[INDEX].created","typeLabel":"string"},"emails":{"type":"object","description":"Email addresses associated with this customer","additionalProperties":{"type":"string","uniqueKey":"hits.items.[INDEX].emails.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"hits.items.[INDEX].emails","typeLabel":"object"},"id":{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","isRequired":true,"uniqueKey":"hits.items.[INDEX].id","typeLabel":"string"},"metadata":{"type":"object","description":"Key-value customer metadata with string values.","additionalProperties":{"type":"string","uniqueKey":"hits.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"hits.items.[INDEX].metadata","typeLabel":"object"},"status":{"type":"string","description":"Status of the Customer\n* Active - customer is active\n* Inactive - Customer account was deactivated\n* Temporary - Customer was created, but registration process was not completed","enum":["active","inactive","temporary"],"isRequired":true,"uniqueKey":"hits.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"address":{"oneOf":[{"type":"object","description":"Physical address. Used by both Customer and WbCustomer entities.","required":["line_1","zip","city","country"],"properties":{"city":{"type":"string","description":"City name","isRequired":true,"uniqueKey":"hits.items.[INDEX].address.oneOf.0.city","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166 2-letter Country code","isRequired":true,"uniqueKey":"hits.items.[INDEX].address.oneOf.0.country","typeLabel":"string"},"line_1":{"type":"string","description":"First line of address","isRequired":true,"uniqueKey":"hits.items.[INDEX].address.oneOf.0.line_1","typeLabel":"string"},"zip":{"type":"string","description":"Zip or Postal code","isRequired":true,"uniqueKey":"hits.items.[INDEX].address.oneOf.0.zip","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Second line of the address. Optional","uniqueKey":"hits.items.[INDEX].address.oneOf.0.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Second line of the address. Optional","uniqueKey":"hits.items.[INDEX].address.oneOf.0.line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].address.oneOf.0.line_2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"State, or another appropriate administrative region\nEmpty string value will be treated as NULL","uniqueKey":"hits.items.[INDEX].address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, or another appropriate administrative region\nEmpty string value will be treated as NULL","uniqueKey":"hits.items.[INDEX].address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].address.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"hits.items.[INDEX].address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"hits.items.[INDEX].address.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].address","typeLabel":"object | null"},"contracts":{"oneOf":[{"type":"array","items":{"type":"object","description":"Contract Summary","required":["id","plan","plan_internal_name","plan_id","customer","customer_id","status","cycle","cycle_start_offset","strategy","currency","amount","billing_information","configuration","free_cycles","cost_estimates"],"properties":{"amount":{"type":"string","description":"Contract estimated price","deprecated":true,"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].amount","typeLabel":"string"},"billing_information":{"type":"object","description":"Detailed information about the current billing period","properties":{"current_period":{"oneOf":[{"type":"object","description":"Billing period of the contract. For example, for contracts that are paid monthly,\na new billing period would be created each month. For Constant or Once contracts, a single\nperiod would be created with empty \"end\" value","required":["start","end"],"properties":{"end":{"type":"string","format":"date-time","description":"End of the billing period","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].billing_information.current_period.oneOf.0.end","typeLabel":"string\u003cdate-time>"},"start":{"type":"string","format":"date-time","description":"Start of the billing period","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].billing_information.current_period.oneOf.0.start","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].billing_information.current_period.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].billing_information.current_period.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].billing_information.current_period","typeLabel":"object | null"},"current_period_idx":{"oneOf":[{"type":"integer","format":"int32","description":"Current billing period index (starting from 1, ascending)","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].billing_information.current_period_idx.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Current billing period index (starting from 1, ascending)","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].billing_information.current_period_idx.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].billing_information.current_period_idx","typeLabel":"integer\u003cint32> | null"}},"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].billing_information","typeLabel":"object"},"configuration":{"type":"object","description":"Additional Contract-level billing configuration","required":["automatic_payment","due_date_policy","usage_period_closing_policy","invoice_trigger"],"properties":{"automatic_payment":{"type":"boolean","description":"Should invoice amount be charged automatically or not","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].configuration.automatic_payment","typeLabel":"boolean"},"due_date_policy":{"type":"string","description":"Determines when the due_date of the invoices should be set when created:\n* StartOfPeriod - invoices are due at the beginning of the billing period\n* EndOfPeriod - invoices are due at the end of the billing period","enum":["start_of_period","end_of_period"],"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].configuration.due_date_policy","typeLabel":"enum\u003cstring>"},"invoice_trigger":{"oneOf":[{"type":"string","description":"When the invoices should be created\n\nNote: EveryCycle and Periodic aren't yet supported,\nthey will behave as Manual","enum":["immediate"],"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].configuration.invoice_trigger.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"When the invoices should be created\n\nNote: EveryCycle and Periodic aren't yet supported,\nthey will behave as Manual","required":["periodic"],"properties":{"periodic":{"type":"object","description":"How period are generated, independently from a start\nor end","required":["cycle_count","cycle"],"properties":{"cycle":{"type":"string","description":"Enum that lists supported trigger cycles for periodic triggers:\n* Month - every month\n* Quarter - every quarter\n* Year - every year","enum":["day","week","month","quarter","year"],"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].configuration.invoice_trigger.oneOf.1.periodic.cycle","typeLabel":"enum\u003cstring>"},"cycle_count":{"type":"integer","description":"the number of days/week/month etc. in a period","minimum":0,"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].configuration.invoice_trigger.oneOf.1.periodic.cycle_count","typeLabel":"integer"},"cycle_start_offset":{"oneOf":[{"type":"integer","description":"Number of full days between the cycle's natural start and\nthe claims starts. For example if claims are to start on\nthe morning of the 14 each month, the offset will be 13.\nThis value can be null, meaning either that it's not\nspecified at this level (eg in preferences) or that it's\n0 (ie a natural cycle)","minimum":0,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].configuration.invoice_trigger.oneOf.1.periodic.cycle_start_offset.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of full days between the cycle's natural start and\nthe claims starts. For example if claims are to start on\nthe morning of the 14 each month, the offset will be 13.\nThis value can be null, meaning either that it's not\nspecified at this level (eg in preferences) or that it's\n0 (ie a natural cycle)","minimum":0,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].configuration.invoice_trigger.oneOf.1.periodic.cycle_start_offset.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].configuration.invoice_trigger.oneOf.1.periodic.cycle_start_offset","typeLabel":"integer | null"}},"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].configuration.invoice_trigger.oneOf.1.periodic","typeLabel":"object"}},"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].configuration.invoice_trigger.oneOf.1","typeLabel":"object"},{"type":"string","description":"When the invoices should be created\n\nNote: EveryCycle and Periodic aren't yet supported,\nthey will behave as Manual","enum":["manual"],"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].configuration.invoice_trigger.oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].configuration.invoice_trigger","typeLabel":"enum\u003cstring> · object · enum\u003cstring>"},"usage_period_closing_policy":{"type":"string","description":"Determines how usage period should be closed:\n* Automatic - usage period will be closed as soon as claim period ends\n* Manual - usage period will be open until closed manually\n* Delayed - automatic with delay after the claim period ends. Valid delays are 15 minutes, 1 hour, 1 day","enum":["automatic","manual","15 minutes","1 hour","1 day"],"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].configuration.usage_period_closing_policy","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].configuration","typeLabel":"object"},"cost_estimates":{"type":"object","description":"Price estimate","required":["recurring_price","one_time_price","on_demand_price","custom_cycle_charges"],"properties":{"custom_cycle_charges":{"type":"object","description":"Charges for features on a custom cycle","required":["periodic_daily","periodic_weekly","periodic_monthly","periodic_quarterly","periodic_yearly"],"properties":{"periodic_daily":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_daily.cycle_start_charges","typeLabel":"string"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_daily.extra_cycle_end_charges","typeLabel":"string"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_daily.minimum_usage","typeLabel":"string"}},"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_daily","typeLabel":"object"},"periodic_monthly":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_monthly.cycle_start_charges","typeLabel":"string"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_monthly.extra_cycle_end_charges","typeLabel":"string"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_monthly.minimum_usage","typeLabel":"string"}},"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_monthly","typeLabel":"object"},"periodic_quarterly":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_quarterly.cycle_start_charges","typeLabel":"string"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_quarterly.extra_cycle_end_charges","typeLabel":"string"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_quarterly.minimum_usage","typeLabel":"string"}},"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_quarterly","typeLabel":"object"},"periodic_weekly":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_weekly.cycle_start_charges","typeLabel":"string"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_weekly.extra_cycle_end_charges","typeLabel":"string"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_weekly.minimum_usage","typeLabel":"string"}},"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_weekly","typeLabel":"object"},"periodic_yearly":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_yearly.cycle_start_charges","typeLabel":"string"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_yearly.extra_cycle_end_charges","typeLabel":"string"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_yearly.minimum_usage","typeLabel":"string"}},"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges.periodic_yearly","typeLabel":"object"}},"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.custom_cycle_charges","typeLabel":"object"},"on_demand_price":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.on_demand_price.cycle_start_charges","typeLabel":"string"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.on_demand_price.extra_cycle_end_charges","typeLabel":"string"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.on_demand_price.minimum_usage","typeLabel":"string"}},"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.on_demand_price","typeLabel":"object"},"one_time_price":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.one_time_price.cycle_start_charges","typeLabel":"string"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.one_time_price.extra_cycle_end_charges","typeLabel":"string"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.one_time_price.minimum_usage","typeLabel":"string"}},"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.one_time_price","typeLabel":"object"},"recurring_price":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.recurring_price.cycle_start_charges","typeLabel":"string"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.recurring_price.extra_cycle_end_charges","typeLabel":"string"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.recurring_price.minimum_usage","typeLabel":"string"}},"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates.recurring_price","typeLabel":"object"}},"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cost_estimates","typeLabel":"object"},"currency":{"type":"string","description":"A supported currency\n\nThe format for parsing and reading is the lowercased\nISO 4217 currency code (e.g. \"usd\")","enum":["usd","eur","gbp","brl","ars"],"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].currency","typeLabel":"enum\u003cstring>"},"customer":{"type":"string","description":"Customer Name","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].customer","typeLabel":"string"},"customer_id":{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].customer_id","typeLabel":"string"},"cycle":{"type":"string","description":"Enum that lists supported payment cycles for contracts:\n* Once - one-time payment\n* Constant - one-time payment for the duration of the contract\n* Week - contract is paid weekly\n* Month - contract is paid monthly\n* Quarter - contract is paid every quarter\n* Year - contract is paid yearly","enum":["once","hour","day","week","month","quarter","year","constant"],"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cycle","typeLabel":"enum\u003cstring>"},"cycle_start_offset":{"type":"integer","description":"The number of days from the cycle's natural start (i.e. the\nfirst day of the week/month/quarter/year) to the start of the\ncycles","minimum":0,"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].cycle_start_offset","typeLabel":"integer"},"free_cycles":{"type":"integer","description":"The number of free cycles","minimum":0,"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].free_cycles","typeLabel":"integer"},"id":{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].id","typeLabel":"string"},"plan":{"type":"string","description":"Plan Name","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].plan","typeLabel":"string"},"plan_id":{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].plan_id","typeLabel":"string"},"plan_internal_name":{"type":"string","description":"Internal Plan name","isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].plan_internal_name","typeLabel":"string"},"status":{"type":"string","description":"Status of the contract:\n* Active - Contract is active\n* Pending - Contract is not active\n* Scheduled - Contract is scheduled to activate in the future\n* Canceled - Contract has been canceled\n* Moved - User upgraded from this contract to a different one\n* NotReady - Contract was created, but billing engine has not completed contract setup","enum":["active","pending","scheduled","canceled","moved","not_ready"],"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"strategy":{"type":"string","description":"Pricing strategy of the Plan:\n* Plan - Plan itself contains a price, and it will be used.\n* Feature - Each feature in the plan is configured with a price, and final price of the plan\nis the combination of prices of all its features","enum":["plan","group","feature"],"isRequired":true,"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].strategy","typeLabel":"enum\u003cstring>"},"activation":{"oneOf":[{"type":"string","format":"date-time","description":"Contract Activation Date","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].activation.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Contract Activation Date","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].activation.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].activation","typeLabel":"string\u003cdate-time> | null"},"created":{"oneOf":[{"type":"string","format":"date-time","description":"Date os signing","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].created.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date os signing","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].created.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].created","typeLabel":"string\u003cdate-time> | null"},"expiration":{"oneOf":[{"type":"string","format":"date-time","description":"Contract Expiration Date","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].expiration.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Contract Expiration Date","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].expiration.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].expiration","typeLabel":"string\u003cdate-time> | null"},"free_trial_end":{"oneOf":[{"type":"string","format":"date-time","description":"Date of the end of the free trial, if any","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].free_trial_end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date of the end of the free trial, if any","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].free_trial_end.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].free_trial_end","typeLabel":"string\u003cdate-time> | null"},"next_cycle_start":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the current cycle\n(if the contract is active)","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].next_cycle_start.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End date of the current cycle\n(if the contract is active)","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].next_cycle_start.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].next_cycle_start","typeLabel":"string\u003cdate-time> | null"},"plan_external_name":{"oneOf":[{"type":"string","description":"External Plan name","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].plan_external_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"External Plan name","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].plan_external_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].plan_external_name","typeLabel":"string | null"},"pricing_id":{"oneOf":[{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].pricing_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].pricing_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX].pricing_id","typeLabel":"string | null"}},"uniqueKey":"hits.items.[INDEX].contracts.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Contracts signed by this Customer","uniqueKey":"hits.items.[INDEX].contracts.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Contract Summary","required":["id","plan","plan_internal_name","plan_id","customer","customer_id","status","cycle","cycle_start_offset","strategy","currency","amount","billing_information","configuration","free_cycles","cost_estimates"],"properties":{"activation":{"oneOf":[{"type":"string","format":"date-time","description":"Contract Activation Date"},{"type":"null","format":"date-time","description":"Contract Activation Date"}]},"amount":{"type":"string","description":"Contract estimated price","deprecated":true},"billing_information":{"type":"object","description":"Detailed information about the current billing period","properties":{"current_period":{"oneOf":[{"type":"object","description":"Billing period of the contract. For example, for contracts that are paid monthly,\na new billing period would be created each month. For Constant or Once contracts, a single\nperiod would be created with empty \"end\" value","required":["start","end"],"properties":{"end":{"type":"string","format":"date-time","description":"End of the billing period"},"start":{"type":"string","format":"date-time","description":"Start of the billing period"}}},{"type":"null"}]},"current_period_idx":{"oneOf":[{"type":"integer","format":"int32","description":"Current billing period index (starting from 1, ascending)"},{"type":"null","format":"int32","description":"Current billing period index (starting from 1, ascending)"}]}}},"configuration":{"type":"object","description":"Additional Contract-level billing configuration","required":["automatic_payment","due_date_policy","usage_period_closing_policy","invoice_trigger"],"properties":{"automatic_payment":{"type":"boolean","description":"Should invoice amount be charged automatically or not"},"due_date_policy":{"type":"string","description":"Determines when the due_date of the invoices should be set when created:\n* StartOfPeriod - invoices are due at the beginning of the billing period\n* EndOfPeriod - invoices are due at the end of the billing period","enum":["start_of_period","end_of_period"]},"invoice_trigger":{"oneOf":[{"type":"string","description":"When the invoices should be created\n\nNote: EveryCycle and Periodic aren't yet supported,\nthey will behave as Manual","enum":["immediate"]},{"type":"object","description":"When the invoices should be created\n\nNote: EveryCycle and Periodic aren't yet supported,\nthey will behave as Manual","required":["periodic"],"properties":{"periodic":{"type":"object","description":"How period are generated, independently from a start\nor end","required":["cycle_count","cycle"],"properties":{"cycle":{"type":"string","description":"Enum that lists supported trigger cycles for periodic triggers:\n* Month - every month\n* Quarter - every quarter\n* Year - every year","enum":["day","week","month","quarter","year"]},"cycle_count":{"type":"integer","description":"the number of days/week/month etc. in a period","minimum":0},"cycle_start_offset":{"oneOf":[{"type":"integer","description":"Number of full days between the cycle's natural start and\nthe claims starts. For example if claims are to start on\nthe morning of the 14 each month, the offset will be 13.\nThis value can be null, meaning either that it's not\nspecified at this level (eg in preferences) or that it's\n0 (ie a natural cycle)","minimum":0},{"type":"null","description":"Number of full days between the cycle's natural start and\nthe claims starts. For example if claims are to start on\nthe morning of the 14 each month, the offset will be 13.\nThis value can be null, meaning either that it's not\nspecified at this level (eg in preferences) or that it's\n0 (ie a natural cycle)","minimum":0}]}}}}},{"type":"string","description":"When the invoices should be created\n\nNote: EveryCycle and Periodic aren't yet supported,\nthey will behave as Manual","enum":["manual"]}]},"usage_period_closing_policy":{"type":"string","description":"Determines how usage period should be closed:\n* Automatic - usage period will be closed as soon as claim period ends\n* Manual - usage period will be open until closed manually\n* Delayed - automatic with delay after the claim period ends. Valid delays are 15 minutes, 1 hour, 1 day","enum":["automatic","manual","15 minutes","1 hour","1 day"]}}},"cost_estimates":{"type":"object","description":"Price estimate","required":["recurring_price","one_time_price","on_demand_price","custom_cycle_charges"],"properties":{"custom_cycle_charges":{"type":"object","description":"Charges for features on a custom cycle","required":["periodic_daily","periodic_weekly","periodic_monthly","periodic_quarterly","periodic_yearly"],"properties":{"periodic_daily":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged"}}},"periodic_monthly":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged"}}},"periodic_quarterly":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged"}}},"periodic_weekly":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged"}}},"periodic_yearly":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged"}}}}},"on_demand_price":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged"}}},"one_time_price":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged"}}},"recurring_price":{"type":"object","description":"Detailed breakdown of the estimated charges","required":["cycle_start_charges","minimum_usage","extra_cycle_end_charges"],"properties":{"cycle_start_charges":{"type":"string","description":"Amount to be charged at the start of the given cycle"},"extra_cycle_end_charges":{"type":"string","description":"Amount to be charged at the end of the cycle (except usage)"},"minimum_usage":{"type":"string","description":"Minimum amount of usage that will be charged"}}}}},"created":{"oneOf":[{"type":"string","format":"date-time","description":"Date os signing"},{"type":"null","format":"date-time","description":"Date os signing"}]},"currency":{"type":"string","description":"A supported currency\n\nThe format for parsing and reading is the lowercased\nISO 4217 currency code (e.g. \"usd\")","enum":["usd","eur","gbp","brl","ars"]},"customer":{"type":"string","description":"Customer Name"},"customer_id":{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"},"cycle":{"type":"string","description":"Enum that lists supported payment cycles for contracts:\n* Once - one-time payment\n* Constant - one-time payment for the duration of the contract\n* Week - contract is paid weekly\n* Month - contract is paid monthly\n* Quarter - contract is paid every quarter\n* Year - contract is paid yearly","enum":["once","hour","day","week","month","quarter","year","constant"]},"cycle_start_offset":{"type":"integer","description":"The number of days from the cycle's natural start (i.e. the\nfirst day of the week/month/quarter/year) to the start of the\ncycles","minimum":0},"expiration":{"oneOf":[{"type":"string","format":"date-time","description":"Contract Expiration Date"},{"type":"null","format":"date-time","description":"Contract Expiration Date"}]},"free_cycles":{"type":"integer","description":"The number of free cycles","minimum":0},"free_trial_end":{"oneOf":[{"type":"string","format":"date-time","description":"Date of the end of the free trial, if any"},{"type":"null","format":"date-time","description":"Date of the end of the free trial, if any"}]},"id":{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"},"next_cycle_start":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the current cycle\n(if the contract is active)"},{"type":"null","format":"date-time","description":"End date of the current cycle\n(if the contract is active)"}]},"plan":{"type":"string","description":"Plan Name"},"plan_external_name":{"oneOf":[{"type":"string","description":"External Plan name"},{"type":"null","description":"External Plan name"}]},"plan_id":{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"},"plan_internal_name":{"type":"string","description":"Internal Plan name"},"pricing_id":{"oneOf":[{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"},{"type":"null"}]},"status":{"type":"string","description":"Status of the contract:\n* Active - Contract is active\n* Pending - Contract is not active\n* Scheduled - Contract is scheduled to activate in the future\n* Canceled - Contract has been canceled\n* Moved - User upgraded from this contract to a different one\n* NotReady - Contract was created, but billing engine has not completed contract setup","enum":["active","pending","scheduled","canceled","moved","not_ready"]},"strategy":{"type":"string","description":"Pricing strategy of the Plan:\n* Plan - Plan itself contains a price, and it will be used.\n* Feature - Each feature in the plan is configured with a price, and final price of the plan\nis the combination of prices of all its features","enum":["plan","group","feature"]}}},"description":"Contracts signed by this Customer","uniqueKey":"hits.items.[INDEX].contracts.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].contracts","typeLabel":"object[] | null"},"customer_reference":{"oneOf":[{"type":"string","description":"Customer Reference. May contain a reference to an external system","uniqueKey":"hits.items.[INDEX].customer_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer Reference. May contain a reference to an external system","uniqueKey":"hits.items.[INDEX].customer_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].customer_reference","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Customer Name","uniqueKey":"hits.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer Name","uniqueKey":"hits.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].name","typeLabel":"string | null"},"notes":{"oneOf":[{"type":"string","description":"Customer notes","uniqueKey":"hits.items.[INDEX].notes.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer notes","uniqueKey":"hits.items.[INDEX].notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].notes","typeLabel":"string | null"},"tax_details":{"oneOf":[{"type":"object","description":"Extra information that impacts customer's taxation","properties":{"vat_id":{"oneOf":[{"type":"string","description":"Customer's VAT ID","uniqueKey":"hits.items.[INDEX].tax_details.oneOf.0.vat_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer's VAT ID","uniqueKey":"hits.items.[INDEX].tax_details.oneOf.0.vat_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].tax_details.oneOf.0.vat_id","typeLabel":"string | null"}},"uniqueKey":"hits.items.[INDEX].tax_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"hits.items.[INDEX].tax_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"hits.items.[INDEX].tax_details","typeLabel":"object | null"}},"uniqueKey":"hits.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"hits","typeLabel":"object[]"},"total":{"type":"integer","description":"Total number of results","isRequired":true,"uniqueKey":"total","typeLabel":"integer"},"total_pages":{"type":"integer","description":"Number of pages in the result","isRequired":true,"uniqueKey":"total_pages","typeLabel":"integer"},"backward":{"type":"string","description":"Index of the previous page in the result set","uniqueKey":"backward","typeLabel":"string"},"first":{"type":"string","description":"Index of the first element in the result set","uniqueKey":"first","typeLabel":"string"},"forward":{"type":"string","description":"Index of the next page in the result set","uniqueKey":"forward","typeLabel":"string"},"last":{"type":"string","description":"Index of the last element in the result set","uniqueKey":"last","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"current_page":123,"hits":[{"created":"\u003cstring>","emails":{},"id":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","metadata":{},"status":"active","address":{"city":"\u003cstring>","country":"\u003cstring>","line_1":"\u003cstring>","zip":"\u003cstring>","line_2":"\u003cstring>","state":"\u003cstring>"},"contracts":[{"amount":"\u003cstring>","billing_information":{"current_period":{"end":"2023-11-07T05:31:56Z","start":"2023-11-07T05:31:56Z"},"current_period_idx":123},"configuration":{"automatic_payment":true,"due_date_policy":"start_of_period","invoice_trigger":"immediate","usage_period_closing_policy":"automatic"},"cost_estimates":{"custom_cycle_charges":{"periodic_daily":{"cycle_start_charges":"\u003cstring>","extra_cycle_end_charges":"\u003cstring>","minimum_usage":"\u003cstring>"},"periodic_monthly":{"cycle_start_charges":"\u003cstring>","extra_cycle_end_charges":"\u003cstring>","minimum_usage":"\u003cstring>"},"periodic_quarterly":{"cycle_start_charges":"\u003cstring>","extra_cycle_end_charges":"\u003cstring>","minimum_usage":"\u003cstring>"},"periodic_weekly":{"cycle_start_charges":"\u003cstring>","extra_cycle_end_charges":"\u003cstring>","minimum_usage":"\u003cstring>"},"periodic_yearly":{"cycle_start_charges":"\u003cstring>","extra_cycle_end_charges":"\u003cstring>","minimum_usage":"\u003cstring>"}},"on_demand_price":{"cycle_start_charges":"\u003cstring>","extra_cycle_end_charges":"\u003cstring>","minimum_usage":"\u003cstring>"},"one_time_price":{"cycle_start_charges":"\u003cstring>","extra_cycle_end_charges":"\u003cstring>","minimum_usage":"\u003cstring>"},"recurring_price":{"cycle_start_charges":"\u003cstring>","extra_cycle_end_charges":"\u003cstring>","minimum_usage":"\u003cstring>"}},"currency":"usd","customer":"\u003cstring>","customer_id":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","cycle":"once","cycle_start_offset":1,"free_cycles":1,"id":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","plan":"\u003cstring>","plan_id":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","plan_internal_name":"\u003cstring>","status":"active","strategy":"plan","activation":"2023-11-07T05:31:56Z","created":"2023-11-07T05:31:56Z","expiration":"2023-11-07T05:31:56Z","free_trial_end":"2023-11-07T05:31:56Z","next_cycle_start":"2023-11-07T05:31:56Z","plan_external_name":"\u003cstring>","pricing_id":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"}],"customer_reference":"\u003cstring>","name":"\u003cstring>","notes":"\u003cstring>","tax_details":{"vat_id":"\u003cstring>"}}],"total":123,"total_pages":123,"backward":"\u003cstring>","first":"\u003cstring>","forward":"\u003cstring>","last":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"edffcfc4-3560-4ae2-a410-6ada6c281b6b":{"api-key":{"type":"apiKey","in":"header","name":"wb-key","scopes":[]}},"d22f7e01-034d-44f1-be18-4d82648683ef":{"wb_user_cookie":{"type":"apiKey","in":"cookie","name":"app-session","scopes":[]}}},"servers":{"a4003425-b8cc-41a9-b3c3-854191252b9c":{"url":"http://127.0.0.1:8080","description":"Local server"},"bc411509-c143-4d72-a409-c7938d980f87":{"url":"https://api.app.test.wingback.com","description":"Testing server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"wb-key","scopes":[]},"schema":{"title":"wb-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api-key","name":"wb-key"}],"title":"api-key"},{"schemes":[{"scheme":{"type":"apiKey","in":"cookie","name":"app-session","scopes":[]},"schema":{"title":"app-session","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"wb_user_cookie","name":"app-session"}],"title":"wb_user_cookie"}]},"originalFileLocation":"openapi.json"},"subdomain":"wingback","siteName":"Wingback","title":"Search for Customers - Wingback","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T22:42:17.666Z","originalFileLocation":"dev/api-reference/customer/get_c_customer.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns customers filtered by query string parameters. Atleast one variable must be provided to do the search. All the customers meeting the search criteria will be returned\">\u003cmeta data-mint-head name=\"application-name\" content=\"Wingback\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wingback/UnON2ZxPucVjTp_q/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/wingback/UnON2ZxPucVjTp_q/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wingback/UnON2ZxPucVjTp_q/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/wingback/UnON2ZxPucVjTp_q/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/wingback/UnON2ZxPucVjTp_q/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wingback/UnON2ZxPucVjTp_q/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wingback/UnON2ZxPucVjTp_q/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/wingback/UnON2ZxPucVjTp_q/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/wingback/UnON2ZxPucVjTp_q/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Search for Customers - Wingback\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns customers filtered by query string parameters. Atleast one variable must be provided to do the search. All the customers meeting the search criteria will be returned\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Wingback\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs-int.wingback.com/dev/api-reference/customer/get_c_customer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wingback.mintlify.app/_mintlify/api/og/v2?division=Customer\u0026amp;title=Search+for+Customers\u0026amp;description=Returns+customers+filtered+by+query+string+parameters.+Atleast+one+variable+must+be+provided+to+do+the+search.+All+the+customers+meeting+the+search+criteria+wil\u0026amp;theme=b99535fc2fd6236ca0523fc2\u0026amp;signature=c130f01d4e7722e74061e9efec601a10b3cfd0c93d2e581be36ea654cf0dad5e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Search for Customers - Wingback\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns customers filtered by query string parameters. Atleast one variable must be provided to do the search. All the customers meeting the search criteria will be returned\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wingback.mintlify.app/_mintlify/api/og/v2?division=Customer\u0026amp;title=Search+for+Customers\u0026amp;description=Returns+customers+filtered+by+query+string+parameters.+Atleast+one+variable+must+be+provided+to+do+the+search.+All+the+customers+meeting+the+search+criteria+wil\u0026amp;theme=b99535fc2fd6236ca0523fc2\u0026amp;signature=c130f01d4e7722e74061e9efec601a10b3cfd0c93d2e581be36ea654cf0dad5e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/wingback/UnON2ZxPucVjTp_q/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Wingback\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#EF3B4D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs-int.wingback.com/dev/api-reference/customer/get_c_customer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/dev/api-reference/customer/get_c_customer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs-int.wingback.com/#organization\",\"name\":\"Wingback\",\"url\":\"https://docs-int.wingback.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/wingback/GadBRdJt85xVxME0/media/logo/light.svg?fit=max\u0026auto=format\u0026n=GadBRdJt85xVxME0\u0026q=85\u0026s=93b61d8945910151ec8df39c2b469c8e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs-int.wingback.com#website\",\"name\":\"Wingback\",\"url\":\"https://docs-int.wingback.com\",\"publisher\":{\"@id\":\"https://docs-int.wingback.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs-int.wingback.com/dev/api-reference/customer/get_c_customer#webpage\",\"url\":\"https://docs-int.wingback.com/dev/api-reference/customer/get_c_customer\",\"name\":\"Search for Customers\",\"description\":\"Returns customers filtered by query string parameters. Atleast one variable must be provided to do the search. All the customers meeting the search criteria will be returned\",\"dateModified\":\"2026-01-06T22:42:17.666Z\",\"isPartOf\":{\"@id\":\"https://docs-int.wingback.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs-int.wingback.com/dev/api-reference/customer/get_c_customer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs-int.wingback.com/dev/api-reference/customer/get_c_customer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs-int.wingback.com/dev/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customer\",\"item\":\"https://docs-int.wingback.com/dev/api-reference/customer/post_c_customer\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Search for Customers\",\"item\":\"https://docs-int.wingback.com/dev/api-reference/customer/get_c_customer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs-int.wingback.com/dev/api-reference/customer/get_c_customer#apireference\",\"headline\":\"Search for Customers\",\"name\":\"Search for Customers\",\"description\":\"Returns customers filtered by query string parameters. Atleast one variable must be provided to do the search. All the customers meeting the search criteria will be returned\",\"url\":\"https://docs-int.wingback.com/dev/api-reference/customer/get_c_customer\",\"mainEntityOfPage\":{\"@id\":\"https://docs-int.wingback.com/dev/api-reference/customer/get_c_customer#webpage\"},\"dateModified\":\"2026-01-06T22:42:17.666Z\",\"publisher\":{\"@id\":\"https://docs-int.wingback.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs-int.wingback.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Wingback\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Wingback","nav":{"global":null,"tabs":[{"tab":"User Guides","pages":[{"title":"User Guides","href":"/user/welcome"}]},{"tab":"User Manuals","pages":[{"title":"User Manuals","href":"/manual/introduction"}]},{"tab":"SGI Fundamentals","pages":[{"title":"SGI Fundamentals","href":"/fundamentals/vocab/introduction"}]},{"tab":"Developer Documentation","groups":[{"group":"Welcome","pages":[{"title":"Introduction","href":"/dev/welcome"}]},{"group":"Guides","pages":[{"title":"Working with Features and Entitlements","href":"/dev/guides/features-entitlements"},{"title":"Integrating Wingback into your Signup Flow","href":"/dev/guides/integrate-wingback-signup-flow"},{"title":"Billing Portal Integration","href":"/dev/guides/billing-portal"},{"title":"Adding a Dynamic Pricing Page to Your Website","href":"/dev/guides/pricing-page"},{"title":"Metering Usage","href":"/dev/guides/metering"},{"title":"Webhooks","href":"/dev/guides/webhooks"}]},{"group":"Wingback.js","pages":[{"title":"Introduction","href":"/dev/wingback-js/introduction"},{"title":"Pricing Pages","href":"/dev/wingback-js/pricing"}]},{"group":"Advanced","pages":[{"title":"Variable Invoicing Schedules","href":"/dev/advanced/variable-invoicing-schedules"}]},{"group":"API Reference","pages":[{"title":"Introduction","href":"/dev/api-reference/introduction"},{"group":"Customer","pages":[{"title":"Create New Customer","openapi":"POST /v1/c/customer","href":"/dev/api-reference/customer/post_c_customer"},{"title":"Get Customer","openapi":"GET /v1/c/customer/{customer_id}","description":"Retrieve customer by id. The API returns customer and the contract that the customer is currently on","href":"/dev/api-reference/customer/get_c_customer_customerid"},{"title":"Search for Customers","openapi":"GET /v1/c/customer","href":"/dev/api-reference/customer/get_c_customer"},{"title":"Activate Customer","openapi":"POST /v1/c/customer/{customer_id}/activate","description":"The API unpauses the customer. A paused customer will not be charged for his subscriptions and Entitlement API will show that the customer is not active and can't use the assigned features.","href":"/dev/api-reference/customer/post_c_customer_customerid_activate"},{"title":"Freeze/Inactivate Customer","openapi":"POST /v1/c/customer/{customer_id}/inactivate","href":"/dev/api-reference/customer/post_c_customer_customerid_inactivate"},{"title":"Add Address","openapi":"POST /v1/c/customer/{customer_id}/address","href":"/dev/api-reference/customer/post_c_customer_customerid_address"},{"title":"Get Address","openapi":"GET /v1/c/customer/{customer_id}/address","href":"/dev/api-reference/customer/get_c_customer_customerid_address"},{"title":"Delete Address","openapi":"DELETE /v1/c/customer/{customer_id}/address","href":"/dev/api-reference/customer/delete_c_customer_customerid_address"}]},{"group":"Contract","pages":[{"title":"Subscribe Customer to a Plan","openapi":"POST /v1/c/contract","href":"/dev/api-reference/contract/post_c_contract"},{"title":"Retrieve Contract Details","openapi":"GET /v1/c/contract/{contract_id}","href":"/dev/api-reference/contract/get_c_contract_contractid"},{"title":"Upgrade/Change Plan","openapi":"POST /v1/c/contract/{contract_id}/upgrade","href":"/dev/api-reference/contract/post_c_contract_contractid_upgrade"},{"title":"Estimate Upgrade Costss","openapi":"POST /v1/c/contract/{contract_id}/upgrade_estimate","href":"/dev/api-reference/contract/post_c_contract_contractid_upgrade_estimate"}]},{"group":"Billing Portal","pages":[{"title":"Login a Customer to the Self-Serve Portal","openapi":"POST /v1/c/customer/authenticate","href":"/dev/api-reference/billing-portal/post_c_customer_authenticate"}]},{"group":"Entitlements","pages":[{"title":"Get Access Entitlements","openapi":"GET /v1/c/entitlement/{customer_id}/access","href":"/dev/api-reference/entitlement/get_c_entitlement_customerid_access"},{"title":"Get Billing Entitlements","openapi":"GET /v1/c/entitlement/{customer_id}/billing","href":"/dev/api-reference/entitlement/get_c_entitlement_customerid_billing"}]},{"group":"Usage","pages":[{"title":"Report Single Event","openapi":"POST /v1/c/usage","href":"/dev/api-reference/usage/post_c_usage"},{"title":"Bulk Usage Upload","openapi":"POST /v1/c/usage/bulk","href":"/dev/api-reference/usage/post_c_usage_bulk"}]},{"group":"Payment","pages":[{"title":"Create Payment Session","openapi":"POST /v1/c/customer/{customer_id}/payment/session","href":"/dev/api-reference/payment/post_c_customer_customerid_payment_session"},{"title":"Add Payment Method","openapi":"POST /v1/c/customer/{customer_id}/payment/method","href":"/dev/api-reference/payment/post_c_customer_customerid_payment_method"},{"title":"List saved Payment Methods","openapi":"GET /v1/c/customer/{customer_id}/payment/method","href":"/dev/api-reference/payment/get_c_customer_customerid_payment_method"},{"title":"Get Saved Payment Method","openapi":"GET /v1/c/customer/{customer_id}/payment/method/{method_id}","href":"/dev/api-reference/payment/get_c_customer_customerid_payment_method_methodid"},{"title":"List saved Payment Methods","openapi":"GET /v1/c/customer/{customer_id}/payment/method","href":"/dev/api-reference/payment/get_c_customer_customerid_payment_method_selection"},{"title":"Set Default Payment Method","openapi":"POST /v1/c/customer/{customer_id}/payment/method_selection","href":"/dev/api-reference/payment/post_c_customer_customerid_payment_method_selection"}]},{"group":"Balance","pages":[{"title":"Get Current Customer Balance","openapi":"GET /v1/c/customer/{customer_id}/balance","href":"/dev/api-reference/balance/get_c_customer_customerid_balance"}]},{"group":"Virtual Wallets (Credits)","pages":[{"title":"Get Virtual Balances","openapi":"GET /v1/c/customer/{customer_id}/virtual-wallet/","href":"/dev/api-reference/virtual-wallet/get_c_customer_customerid_virtual-wallet"},{"title":"Add Virtual Credits","openapi":"POST /v1/c/virtual-wallet-transaction","href":"/dev/api-reference/virtual-wallet/post_c_virtual-wallet-transaction"}]},{"group":"Invoices","pages":[{"title":"List Invoices","openapi":"GET /v1/c/invoice","href":"/dev/api-reference/invoice/get_c_invoice"},{"title":"Get Invoice","openapi":"GET /v1/c/invoice/{invoice_id}","href":"/dev/api-reference/invoice/get_c_invoice_invoiceid"},{"title":"Configure Global Invoicing Preferences","openapi":"POST /v1/c/preferences/invoicing","href":"/dev/api-reference/invoice/post_c_preferences_invoicing"},{"title":"Manually Trigger Invoice Generation","openapi":"POST /v1/c/invoice","href":"/dev/api-reference/invoice/post_c_invoice"}]}]}]}]},"basePath":"","title":"Search for Customers - Wingback","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}