{"items":[{"type":"link","label":"Chaching API","link":"/developer-guide/api","routeSlug":"/developer-guide/api","content":{"contentType":"overview","meta":{"name":"Chaching API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"api.json","url":"/_bundle/Developer Guide/api.json?download"},{"kind":"download","label":"api.yaml","url":"/_bundle/Developer Guide/api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Chaching API (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Chaching is a modern subscription-billing platform designed to simplify product management, customer lifecycle workflows, and recurring payments. It combines a clean dashboard for business users with a powerful API built for developers who need full automation and control."}],"sectionId":"/developer-guide/api"}],"sectionId":"/developer-guide/api"}]}]}},{"type":"group","label":"Customers","link":"/developer-guide/api/customers","routeSlug":"/developer-guide/api/customers","items":[{"label":"Creates a new customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_create","routeSlug":"/developer-guide/api/customers/customerscontroller_create","metadata":{"seo":{"title":"Creates a new customer","description":"Creates a new customer for the authenticated account with the provided details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CustomersController_create","name":"Creates a new customer","isWebhook":false,"pointer":"/paths/~1customers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new customer for the authenticated account with the provided details."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1customers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomersCreatePublicDto"}},"schemaId":"components/schemas/CustomersCreatePublicDto","pointer":"/paths/~1customers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomersCreatePublicDto"}},"responseCodes":["200","201","400","401"],"pointer":"/customers","href":"customers/customerscontroller_create","openApiOperationId":"CustomersController_create","summary":"Creates a new customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CustomersCreatePublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomersCreatePublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created customer details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomersPublicDto"}},"schemaId":"components/schemas/CustomersPublicDto"},{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomersPublicDto"}},"schemaId":"components/schemas/CustomersPublicDto"},{"code":"400","description":"Invalid input data for creating a customer, missing apiKey header, or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomersPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomersPublicDto"}}},{"code":"201","schemaId":"components/schemas/CustomersPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomersPublicDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/customerscontroller_create"}],"panels":[]}]},"httpPath":"/customers"},{"label":"Get paginated list of customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_getallbyaccount","routeSlug":"/developer-guide/api/customers/customerscontroller_getallbyaccount","metadata":{"seo":{"title":"Get paginated list of customers","description":"Retrieves a paginated list of customers associated with the authenticated account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CustomersController_getAllByAccount","name":"Get paginated list of customers","isWebhook":false,"pointer":"/paths/~1customers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get paginated list of customers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a paginated list of customers associated with the authenticated account."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_1"},{"name":"page","in":"query","schemaId":"schema_2"},{"name":"take","in":"query","schemaId":"schema_3"},{"name":"order","in":"query","schemaId":"schema_4"},{"name":"sortingField","in":"query","schemaId":"schema_5"}],"pointer":"/paths/~1customers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1customers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_1"},{"name":"page","in":"query","required":false,"schemaId":"schema_2"},{"name":"take","in":"query","required":false,"schemaId":"schema_3"},{"name":"order","in":"query","required":false,"schemaId":"schema_4"},{"name":"sortingField","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/customers","href":"customers/customerscontroller_getallbyaccount","openApiOperationId":"CustomersController_getAllByAccount","summary":"Get paginated list of customers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of customers","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6"}},"schemaId":"schema_6"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1customers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_6","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/customerscontroller_getallbyaccount"}],"panels":[]}]},"httpPath":"/customers"},{"label":"Search customers by name or email","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_search","routeSlug":"/developer-guide/api/customers/customerscontroller_search","metadata":{"seo":{"title":"Search customers by name or email","description":"Searches for customers associated with the authenticated account based on a search string that matches their name or email."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CustomersController_search","name":"Search customers by name or email","isWebhook":false,"pointer":"/paths/~1customers~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search customers by name or email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for customers associated with the authenticated account based on a search string that matches their name or email."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_0","description":"Search string to filter customers by name or email"}],"pointer":"/paths/~1customers~1search/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1customers~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/search","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_0"}],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/customers/search","href":"customers/customerscontroller_search","openApiOperationId":"CustomersController_search","summary":"Search customers by name or email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Found customers list, or empty array if none found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1customers~1search/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/customerscontroller_search"}],"panels":[]}]},"httpPath":"/customers/search"},{"label":"Get customer details by External Key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_getdetails","routeSlug":"/developer-guide/api/customers/customerscontroller_getdetails","metadata":{"seo":{"title":"Get customer details by External Key","description":"Retrieves detailed information about a specific customer using their External Key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CustomersController_getDetails","name":"Get customer details by External Key","isWebhook":false,"pointer":"/paths/~1customers~1{externalKey}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get customer details by External Key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific customer using their External Key."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalKey","in":"path","schemaId":"schema_8","description":"External Key of the customer to retrieve details for","required":true}],"pointer":"/paths/~1customers~1{externalKey}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1customers~1{externalKey}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{externalKey}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalKey","in":"path","required":true,"example":"cus_c93f7e842b89b9f7cad17918","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404"],"pointer":"/customers/{externalKey}","href":"customers/customerscontroller_getdetails","openApiOperationId":"CustomersController_getDetails","summary":"Get customer details by External Key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomersPublicDto"}},"schemaId":"components/schemas/CustomersPublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Customer details not found"}],"pointer":"/paths/~1customers~1{externalKey}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomersPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomersPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/customerscontroller_getdetails"}],"panels":[]}]},"httpPath":"/customers/{externalKey}"},{"label":"Update customer details by External Key","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_update","routeSlug":"/developer-guide/api/customers/customerscontroller_update","metadata":{"seo":{"title":"Update customer details by External Key","description":"Updates the details of a specific customer using their External Key and the provided update data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CustomersController_update","name":"Update customer details by External Key","isWebhook":false,"pointer":"/paths/~1customers~1{externalKey}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update customer details by External Key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the details of a specific customer using their External Key and the provided update data."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalKey","in":"path","schemaId":"schema_8","description":"External Key of the customer to update","required":true}],"pointer":"/paths/~1customers~1{externalKey}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1customers~1{externalKey}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomerDto"}},"schemaId":"components/schemas/UpdateCustomerDto","pointer":"/paths/~1customers~1{externalKey}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/customers/{externalKey}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalKey","in":"path","required":true,"example":"cus_c93f7e842b89b9f7cad17918","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCustomerDto"}},"responseCodes":["200","400","401"],"pointer":"/customers/{externalKey}","href":"customers/customerscontroller_update","openApiOperationId":"CustomersController_update","summary":"Update customer details by External Key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateCustomerDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomerDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Number of records updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9"}},"schemaId":"schema_9"},{"code":"400","description":"Invalid input data for updating customer, missing apiKey header, or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1customers~1{externalKey}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_9","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/customerscontroller_update"}],"panels":[]}]},"httpPath":"/customers/{externalKey}"},{"label":"Delete a customer by External Key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_remove","routeSlug":"/developer-guide/api/customers/customerscontroller_remove","metadata":{"seo":{"title":"Delete a customer by External Key","description":"Deletes a specific customer associated with the authenticated account using their External Key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CustomersController_remove","name":"Delete a customer by External Key","isWebhook":false,"pointer":"/paths/~1customers~1{externalKey}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a customer by External Key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific customer associated with the authenticated account using their External Key."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalKey","in":"path","schemaId":"schema_8","description":"External Key of the customer to delete","required":true}],"pointer":"/paths/~1customers~1{externalKey}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1customers~1{externalKey}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/customers/{externalKey}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalKey","in":"path","required":true,"example":"cus_c93f7e842b89b9f7cad17918","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/customers/{externalKey}","href":"customers/customerscontroller_remove","openApiOperationId":"CustomersController_remove","summary":"Delete a customer by External Key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Number of records deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9"}},"schemaId":"schema_9"},{"code":"400","description":"Invalid request for deleting customer, missing apiKey header, or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1customers~1{externalKey}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_9","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/customerscontroller_remove"}],"panels":[]}]},"httpPath":"/customers/{externalKey}"},{"label":"List customer payment methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_getpaymentmethods","routeSlug":"/developer-guide/api/customers/customerscontroller_getpaymentmethods","metadata":{"seo":{"title":"List customer payment methods","description":"Retrieves a paginated list of all payment methods associated with a specific customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CustomersController_getPaymentMethods","name":"List customer payment methods","isWebhook":false,"pointer":"/paths/~1customers~1{externalKey}~1payment-methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List customer payment methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a paginated list of all payment methods associated with a specific customer."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalKey","in":"path","schemaId":"schema_8","description":"External Key of the customer whose payment methods are to be listed","required":true}],"pointer":"/paths/~1customers~1{externalKey}~1payment-methods/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_1"},{"name":"page","in":"query","schemaId":"schema_2"},{"name":"take","in":"query","schemaId":"schema_3"}],"pointer":"/paths/~1customers~1{externalKey}~1payment-methods/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1customers~1{externalKey}~1payment-methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{externalKey}/payment-methods","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalKey","in":"path","required":true,"example":"cus_c93f7e842b89b9f7cad17918","schemaId":"schema_8"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_1"},{"name":"page","in":"query","required":false,"schemaId":"schema_2"},{"name":"take","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/customers/{externalKey}/payment-methods","href":"customers/customerscontroller_getpaymentmethods","openApiOperationId":"CustomersController_getPaymentMethods","summary":"List customer payment methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List customer payment methods","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageDto"}},"schemaId":"components/schemas/PageDto"},{"code":"400","description":"Invalid request for listing customer payment methods, missing apiKey header, or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1customers~1{externalKey}~1payment-methods/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/customerscontroller_getpaymentmethods"}],"panels":[]}]},"httpPath":"/customers/{externalKey}/payment-methods"},{"label":"Get customer payment method details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_getpaymentmethod","routeSlug":"/developer-guide/api/customers/customerscontroller_getpaymentmethod","metadata":{"seo":{"title":"Get customer payment method details","description":"Retrieves detailed information about a specific payment method associated with a customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CustomersController_getPaymentMethod","name":"Get customer payment method details","isWebhook":false,"pointer":"/paths/~1customers~1{externalKey}~1payment-methods~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get customer payment method details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific payment method associated with a customer."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"externalKey","in":"path","schemaId":"schema_8","description":"External Key of the customer","required":true},{"name":"id","in":"path","schemaId":"schema_10","description":"ID of the payment method to retrieve details for","required":true}],"pointer":"/paths/~1customers~1{externalKey}~1payment-methods~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1customers~1{externalKey}~1payment-methods~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{externalKey}/payment-methods/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"externalKey","in":"path","required":true,"example":"cus_c93f7e842b89b9f7cad17918","schemaId":"schema_8"},{"name":"id","in":"path","required":true,"example":"pm_1234567890abcdef","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/customers/{externalKey}/payment-methods/{id}","href":"customers/customerscontroller_getpaymentmethod","openApiOperationId":"CustomersController_getPaymentMethod","summary":"Get customer payment method details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer payment method details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodPublicDto"}},"schemaId":"components/schemas/PaymentMethodPublicDto"},{"code":"400","description":"Invalid request for retrieving customer payment method details, missing apiKey header, or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1customers~1{externalKey}~1payment-methods~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentMethodPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodPublicDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/customerscontroller_getpaymentmethod"}],"panels":[]}]},"httpPath":"/customers/{externalKey}/payment-methods/{id}"}],"content":{"contentType":"group","meta":{"name":"Customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true},{"nodeType":"markdoc","content":"This object represents a customer of your business. Use it to create recurring charges, save payment and contact information, and track payments that belong to the same customer."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customers","summary":"Creates a new customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/customerscontroller_create","deprecated":false},{"title":"/customers","summary":"Get paginated list of customers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/customerscontroller_getallbyaccount","deprecated":false},{"title":"/customers/search","summary":"Search customers by name or email","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/customerscontroller_search","deprecated":false},{"title":"/customers/{externalKey}","summary":"Get customer details by External Key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/customerscontroller_getdetails","deprecated":false},{"title":"/customers/{externalKey}","summary":"Update customer details by External Key","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/customers/customerscontroller_update","deprecated":false},{"title":"/customers/{externalKey}","summary":"Delete a customer by External Key","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customers/customerscontroller_remove","deprecated":false},{"title":"/customers/{externalKey}/payment-methods","summary":"List customer payment methods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/customerscontroller_getpaymentmethods","deprecated":false},{"title":"/customers/{externalKey}/payment-methods/{id}","summary":"Get customer payment method details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/customerscontroller_getpaymentmethod","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/developer-guide/api/products","routeSlug":"/developer-guide/api/products","items":[{"label":"Get tax codes with category names","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/products/productscontroller_gettaxescodes","routeSlug":"/developer-guide/api/products/productscontroller_gettaxescodes","metadata":{"seo":{"title":"Get tax codes with category names","description":"Retrieves a list of tax codes with their associated category names. Optionally filter by search term."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProductsController_getTaxesCodes","name":"Get tax codes with category names","isWebhook":false,"pointer":"/paths/~1products~1taxCodes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tax codes with category names","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of tax codes with their associated category names. Optionally filter by search term."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_0","description":"Search by tax codes or category names"}],"pointer":"/paths/~1products~1taxCodes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1products~1taxCodes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products/taxCodes","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_0"}],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/products/taxCodes","href":"products/productscontroller_gettaxescodes","openApiOperationId":"ProductsController_getTaxesCodes","summary":"Get tax codes with category names"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved tax codes with category names","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}},"schemaId":"schema_11"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1products~1taxCodes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_11","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/productscontroller_gettaxescodes"}],"panels":[]}]},"httpPath":"/products/taxCodes"},{"label":"List all products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/products/productscontroller_listallproducts","routeSlug":"/developer-guide/api/products/productscontroller_listallproducts","metadata":{"seo":{"title":"List all products","description":"Retrieves a paginated list of all products for the authenticated account. Supports pagination and search functionality."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProductsController_listAllProducts","name":"List all products","isWebhook":false,"pointer":"/paths/~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a paginated list of all products for the authenticated account. Supports pagination and search functionality."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{\"active\":true,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"tax_code\":\"txcd_10000000\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"ids\":\"prod_299eea6f29146d93aaa4bceb,prod_cc5b3aa61adca9f52747dd40\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"created[gt|gte|lt|lte]\":1766066322}"},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_2"},{"name":"take","in":"query","schemaId":"schema_3"}],"pointer":"/paths/~1products/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_1"},{"name":"page","in":"query","required":false,"schemaId":"schema_2"},{"name":"take","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/products","href":"products/productscontroller_listallproducts","openApiOperationId":"ProductsController_listAllProducts","summary":"List all products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved paginated list of products","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1products/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/productscontroller_listallproducts"}],"panels":[]}]},"httpPath":"/products"},{"label":"Create a product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/products/productscontroller_createproduct","routeSlug":"/developer-guide/api/products/productscontroller_createproduct","metadata":{"seo":{"title":"Create a product","description":"Creates a new product with the specified details. The product name must be unique and follow specific naming conventions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProductsController_createProduct","name":"Create a product","isWebhook":false,"pointer":"/paths/~1products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new product with the specified details. The product name must be unique and follow specific naming conventions."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1products/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateProductPublicDto"}},"schemaId":"components/schemas/CreateProductPublicDto","pointer":"/paths/~1products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateProductPublicDto"}},"responseCodes":["201","400","401"],"pointer":"/products","href":"products/productscontroller_createproduct","openApiOperationId":"ProductsController_createProduct","summary":"Create a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateProductPublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateProductPublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Product successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductPublicDto"}},"schemaId":"components/schemas/ProductPublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1products/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ProductPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductPublicDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/productscontroller_createproduct"}],"panels":[]}]},"httpPath":"/products"},{"label":"Retrieve a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/products/productscontroller_retrieveproduct","routeSlug":"/developer-guide/api/products/productscontroller_retrieveproduct","metadata":{"seo":{"title":"Retrieve a product","description":"Retrieves details of a specific product by its unique identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProductsController_retrieveProduct","name":"Retrieve a product","isWebhook":false,"pointer":"/paths/~1products~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves details of a specific product by its unique identifier."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_13","description":"Unique identifier of the product","required":true}],"pointer":"/paths/~1products~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1products~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"prod_xT4LfvxLMQb4s9uFNIbXf9pm","schemaId":"schema_13"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/products/{id}","href":"products/productscontroller_retrieveproduct","openApiOperationId":"ProductsController_retrieveProduct","summary":"Retrieve a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved product","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductPublicDto"}},"schemaId":"components/schemas/ProductPublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1products~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductPublicDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/productscontroller_retrieveproduct"}],"panels":[]}]},"httpPath":"/products/{id}"},{"label":"Update a product","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/products/productscontroller_updateproduct","routeSlug":"/developer-guide/api/products/productscontroller_updateproduct","metadata":{"seo":{"title":"Update a product","description":"Updates an existing product with the specified details. Only provided fields will be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProductsController_updateProduct","name":"Update a product","isWebhook":false,"pointer":"/paths/~1products~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing product with the specified details. Only provided fields will be updated."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_13","description":"Unique identifier of the product to update","required":true}],"pointer":"/paths/~1products~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1products~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateProductPublicDto","exampleIds":["paths/~1products~1{id}/patch/requestBody/content/application~1json/examples/Update Product"]}},"schemaId":"components/schemas/UpdateProductPublicDto","exampleIds":["paths/~1products~1{id}/patch/requestBody/content/application~1json/examples/Update Product"],"pointer":"/paths/~1products~1{id}/patch/requestBody","description":"Product update data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/products/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"prod_xT4LfvxLMQb4s9uFNIbXf9pm","schemaId":"schema_13"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateProductPublicDto","exampleIds":["paths/~1products~1{id}/patch/requestBody/content/application~1json/examples/Update Product"]}},"responseCodes":["200","400","401","404"],"pointer":"/products/{id}","href":"products/productscontroller_updateproduct","openApiOperationId":"ProductsController_updateProduct","summary":"Update a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateProductPublicDto","exampleIds":["paths/~1products~1{id}/patch/requestBody/content/application~1json/examples/Update Product"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateProductPublicDto","exampleIds":["paths/~1products~1{id}/patch/requestBody/content/application~1json/examples/Update Product"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductPublicDto"}},"schemaId":"components/schemas/ProductPublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Product not found"}],"pointer":"/paths/~1products~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/productscontroller_updateproduct"}],"panels":[]}]},"httpPath":"/products/{id}"},{"label":"Delete a product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/products/productscontroller_deleteproduct","routeSlug":"/developer-guide/api/products/productscontroller_deleteproduct","metadata":{"seo":{"title":"Delete a product","description":"Permanently deletes a product. This action cannot be undone."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProductsController_deleteProduct","name":"Delete a product","isWebhook":false,"pointer":"/paths/~1products~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently deletes a product. This action cannot be undone."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_13","description":"Unique identifier of the product to delete","required":true}],"pointer":"/paths/~1products~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1products~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/products/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"prod_xT4LfvxLMQb4s9uFNIbXf9pm","schemaId":"schema_13"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404"],"pointer":"/products/{id}","href":"products/productscontroller_deleteproduct","openApiOperationId":"ProductsController_deleteProduct","summary":"Delete a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product successfully deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14"}},"schemaId":"schema_14"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Product not found"}],"pointer":"/paths/~1products~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_14","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/productscontroller_deleteproduct"}],"panels":[]}]},"httpPath":"/products/{id}"}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true},{"nodeType":"markdoc","content":"Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/products/taxCodes","summary":"Get tax codes with category names","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/productscontroller_gettaxescodes","deprecated":false},{"title":"/products","summary":"List all products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/productscontroller_listallproducts","deprecated":false},{"title":"/products","summary":"Create a product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products/productscontroller_createproduct","deprecated":false},{"title":"/products/{id}","summary":"Retrieve a product","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/productscontroller_retrieveproduct","deprecated":false},{"title":"/products/{id}","summary":"Update a product","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/products/productscontroller_updateproduct","deprecated":false},{"title":"/products/{id}","summary":"Delete a product","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/productscontroller_deleteproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Transactions","link":"/developer-guide/api/transactions","routeSlug":"/developer-guide/api/transactions","items":[{"label":"List all transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/transactions/transactionscontroller_gettransactions","routeSlug":"/developer-guide/api/transactions/transactionscontroller_gettransactions","metadata":{"seo":{"title":"List all transactions","description":"Retrieves a list of transactions for the current account, based on the authentication that was used to make the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TransactionsController_getTransactions","name":"List all transactions","isWebhook":false,"pointer":"/paths/~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of transactions for the current account, based on the authentication that was used to make the request."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_15"},{"name":"page","in":"query","schemaId":"schema_2"},{"name":"take","in":"query","schemaId":"schema_3"}],"pointer":"/paths/~1transactions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_15"},{"name":"page","in":"query","required":false,"schemaId":"schema_2"},{"name":"take","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/transactions","href":"transactions/transactionscontroller_gettransactions","openApiOperationId":"TransactionsController_getTransactions","summary":"List all transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of transactions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageDto"}},"schemaId":"components/schemas/PageDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transactionscontroller_gettransactions"}],"panels":[]}]},"httpPath":"/transactions"},{"label":"Retrieve a transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/transactions/transactionscontroller_gettransaction","routeSlug":"/developer-guide/api/transactions/transactionscontroller_gettransaction","metadata":{"seo":{"title":"Retrieve a transaction","description":"Retrieves detailed information about a specific transaction for the current account, based on the authentication that was used to make the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TransactionsController_getTransaction","name":"Retrieve a transaction","isWebhook":false,"pointer":"/paths/~1transactions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific transaction for the current account, based on the authentication that was used to make the request."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":"Transaction ID","required":true}],"pointer":"/paths/~1transactions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1transactions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/transactions/{id}","href":"transactions/transactionscontroller_gettransaction","openApiOperationId":"TransactionsController_getTransaction","summary":"Retrieve a transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionPublicDto"}},"schemaId":"components/schemas/TransactionPublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1transactions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransactionPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionPublicDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transactionscontroller_gettransaction"}],"panels":[]}]},"httpPath":"/transactions/{id}"}],"content":{"contentType":"group","meta":{"name":"Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true},{"nodeType":"markdoc","content":"Transactions represent the payments and charges made by your customers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transactions","summary":"List all transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/transactionscontroller_gettransactions","deprecated":false},{"title":"/transactions/{id}","summary":"Retrieve a transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/transactionscontroller_gettransaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Invoices","link":"/developer-guide/api/invoices","routeSlug":"/developer-guide/api/invoices","items":[{"label":"List all invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/invoices/invoicescontroller_listinvoices","routeSlug":"/developer-guide/api/invoices/invoicescontroller_listinvoices","metadata":{"seo":{"title":"List all invoices","description":"Retrieves a paginated list of all invoices for the authenticated account. Supports pagination and filtering."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"InvoicesController_listInvoices","name":"List all invoices","isWebhook":false,"pointer":"/paths/~1invoices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all invoices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a paginated list of all invoices for the authenticated account. Supports pagination and filtering."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{\"status\":\"open,draft,paid,void\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"customer\":\"cus_fa66daabf0b474b167e1d46c\"}"},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_2"},{"name":"take","in":"query","schemaId":"schema_3"}],"pointer":"/paths/~1invoices/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1invoices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_1"},{"name":"page","in":"query","required":false,"schemaId":"schema_2"},{"name":"take","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/invoices","href":"invoices/invoicescontroller_listinvoices","openApiOperationId":"InvoicesController_listInvoices","summary":"List all invoices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved paginated list of invoices","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageDto"}},"schemaId":"components/schemas/PageDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1invoices/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoicescontroller_listinvoices"}],"panels":[]}]},"httpPath":"/invoices"},{"label":"Create an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/invoices/invoicescontroller_createinvoice","routeSlug":"/developer-guide/api/invoices/invoicescontroller_createinvoice","metadata":{"seo":{"title":"Create an invoice","description":"Creates a new invoice for a customer. The invoice will include line items, pricing, taxes, and other billing information. The invoice will be in draft status until paid or committed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"InvoicesController_createInvoice","name":"Create an invoice","isWebhook":false,"pointer":"/paths/~1invoices/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new invoice for a customer. The invoice will include line items, pricing, taxes, and other billing information. The invoice will be in draft status until paid or committed."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1invoices/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateInvoicePublicDto"}},"schemaId":"components/schemas/CreateInvoicePublicDto","pointer":"/paths/~1invoices/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateInvoicePublicDto"}},"responseCodes":["201","400","401","404"],"pointer":"/invoices","href":"invoices/invoicescontroller_createinvoice","openApiOperationId":"InvoicesController_createInvoice","summary":"Create an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateInvoicePublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateInvoicePublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Invoice successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoicesPublicDto"}},"schemaId":"components/schemas/InvoicesPublicDto"},{"code":"400","description":"Invalid input data, missing apiKey header, or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Customer or price not found"}],"pointer":"/paths/~1invoices/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/InvoicesPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoicesPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoicescontroller_createinvoice"}],"panels":[]}]},"httpPath":"/invoices"},{"label":"Retrieve an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/invoices/invoicescontroller_retrieveinvoice","routeSlug":"/developer-guide/api/invoices/invoicescontroller_retrieveinvoice","metadata":{"seo":{"title":"Retrieve an invoice","description":"Retrieves a specific invoice by its unique identifier, including all invoice details, line items, and payment information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"InvoicesController_retrieveInvoice","name":"Retrieve an invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specific invoice by its unique identifier, including all invoice details, line items, and payment information."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","description":"Unique identifier of the invoice","required":true}],"pointer":"/paths/~1invoices~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1invoices~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"84c413b1-cda9-4637-a75d-352e36274bf2","schemaId":"schema_16"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/invoices/{id}","href":"invoices/invoicescontroller_retrieveinvoice","openApiOperationId":"InvoicesController_retrieveInvoice","summary":"Retrieve an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved the invoice","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoicesPublicDto"}},"schemaId":"components/schemas/InvoicesPublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1invoices~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoicesPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoicesPublicDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoicescontroller_retrieveinvoice"}],"panels":[]}]},"httpPath":"/invoices/{id}"},{"label":"Pay an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/invoices/invoicescontroller_payinvoice","routeSlug":"/developer-guide/api/invoices/invoicescontroller_payinvoice","metadata":{"seo":{"title":"Pay an invoice","description":"Pays an invoice. This action will attempt to charge the customer using the payment method on file and finalize the invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"InvoicesController_payInvoice","name":"Pay an invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pay an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Pays an invoice. This action will attempt to charge the customer using the payment method on file and finalize the invoice."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","description":"Unique identifier of the invoice to pay","required":true}],"pointer":"/paths/~1invoices~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1invoices~1{id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/invoices/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"84c413b1-cda9-4637-a75d-352e36274bf2","schemaId":"schema_16"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","402","404","409"],"pointer":"/invoices/{id}","href":"invoices/invoicescontroller_payinvoice","openApiOperationId":"InvoicesController_payInvoice","summary":"Pay an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice successfully paid"},{"code":"400","description":"Invoice cannot be paid, missing apiKey header, or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"402","description":"Payment declined by the gateway. The invoice stays open and can be retried."},{"code":"404","description":"Invoice not found"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice pays an open payment plan installment and the customer's default payment method is not a card of the payment gateway the plan was created on (PAYMENT_PLAN_PAYMENT_METHOD_NOT_SUPPORTED). Nothing was charged."},"children":[]}]}]}]}],"pointer":"/paths/~1invoices~1{id}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoicescontroller_payinvoice"}],"panels":[]}]},"httpPath":"/invoices/{id}"},{"label":"Void an invoice","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/invoices/invoicescontroller_voidinvoice","routeSlug":"/developer-guide/api/invoices/invoicescontroller_voidinvoice","metadata":{"seo":{"title":"Void an invoice","description":"Voids a draft or open invoice. A voided invoice cannot be paid and is marked as cancelled. This action is irreversible."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"InvoicesController_voidInvoice","name":"Void an invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Void an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Voids a draft or open invoice. A voided invoice cannot be paid and is marked as cancelled. This action is irreversible."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","description":"Unique identifier of the invoice to void","required":true}],"pointer":"/paths/~1invoices~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1invoices~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/invoices/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"84c413b1-cda9-4637-a75d-352e36274bf2","schemaId":"schema_16"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404"],"pointer":"/invoices/{id}","href":"invoices/invoicescontroller_voidinvoice","openApiOperationId":"InvoicesController_voidInvoice","summary":"Void an invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice successfully voided"},{"code":"400","description":"Invoice cannot be voided, missing apiKey header, or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Invoice not found"}],"pointer":"/paths/~1invoices~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoicescontroller_voidinvoice"}],"panels":[]}]},"httpPath":"/invoices/{id}"},{"label":"List invoice transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/invoices/invoicescontroller_gettransactions","routeSlug":"/developer-guide/api/invoices/invoicescontroller_gettransactions","metadata":{"seo":{"title":"List invoice transactions","description":"Retrieves a paginated list of all transactions associated with a specific invoice, including payment attempts, refunds, and adjustments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"InvoicesController_getTransactions","name":"List invoice transactions","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List invoice transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a paginated list of all transactions associated with a specific invoice, including payment attempts, refunds, and adjustments."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1invoices~1{id}~1transactions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_1"},{"name":"page","in":"query","schemaId":"schema_2"},{"name":"take","in":"query","schemaId":"schema_3"}],"pointer":"/paths/~1invoices~1{id}~1transactions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1invoices~1{id}~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{id}/transactions","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_1"},{"name":"page","in":"query","required":false,"schemaId":"schema_2"},{"name":"take","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404"],"pointer":"/invoices/{id}/transactions","href":"invoices/invoicescontroller_gettransactions","openApiOperationId":"InvoicesController_getTransactions","summary":"List invoice transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved paginated list of invoice transactions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageDto"}},"schemaId":"components/schemas/PageDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Invoice not found"}],"pointer":"/paths/~1invoices~1{id}~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageDto"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoicescontroller_gettransactions"}],"panels":[]}]},"httpPath":"/invoices/{id}/transactions"},{"label":"Retrieve invoice transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/invoices/invoicescontroller_gettransaction","routeSlug":"/developer-guide/api/invoices/invoicescontroller_gettransaction","metadata":{"seo":{"title":"Retrieve invoice transaction","description":"Retrieves detailed information about a specific transaction associated with an invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"InvoicesController_getTransaction","name":"Retrieve invoice transaction","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1transactions~1{transactionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve invoice transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific transaction associated with an invoice."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","description":"Unique identifier of the invoice","required":true},{"name":"transactionId","in":"path","schemaId":"schema_17","description":"Unique identifier of the transaction","required":true}],"pointer":"/paths/~1invoices~1{id}~1transactions~1{transactionId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1invoices~1{id}~1transactions~1{transactionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{id}/transactions/{transactionId}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"84c413b1-cda9-4637-a75d-352e36274bf2","schemaId":"schema_16"},{"name":"transactionId","in":"path","required":true,"example":"1ac67144-c4eb-4977-a185-674278685a5f","schemaId":"schema_17"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404"],"pointer":"/invoices/{id}/transactions/{transactionId}","href":"invoices/invoicescontroller_gettransaction","openApiOperationId":"InvoicesController_getTransaction","summary":"Retrieve invoice transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved transaction details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionPublicDto"}},"schemaId":"components/schemas/TransactionPublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Invoice or transaction not found"}],"pointer":"/paths/~1invoices~1{id}~1transactions~1{transactionId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransactionPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoicescontroller_gettransaction"}],"panels":[]}]},"httpPath":"/invoices/{id}/transactions/{transactionId}"}],"content":{"contentType":"group","meta":{"name":"Invoices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoices","showPageActions":true},{"nodeType":"markdoc","content":"Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/invoices","summary":"List all invoices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/invoicescontroller_listinvoices","deprecated":false},{"title":"/invoices","summary":"Create an invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/invoicescontroller_createinvoice","deprecated":false},{"title":"/invoices/{id}","summary":"Retrieve an invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/invoicescontroller_retrieveinvoice","deprecated":false},{"title":"/invoices/{id}","summary":"Pay an invoice","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/invoicescontroller_payinvoice","deprecated":false},{"title":"/invoices/{id}","summary":"Void an invoice","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/invoices/invoicescontroller_voidinvoice","deprecated":false},{"title":"/invoices/{id}/transactions","summary":"List invoice transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/invoicescontroller_gettransactions","deprecated":false},{"title":"/invoices/{id}/transactions/{transactionId}","summary":"Retrieve invoice transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/invoicescontroller_gettransaction","deprecated":false}]}]}]}]}},{"type":"group","label":"TaxRates","link":"/developer-guide/api/taxrates","routeSlug":"/developer-guide/api/taxrates","items":[{"label":"List all tax rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/taxrates/taxescontroller_findall","routeSlug":"/developer-guide/api/taxrates/taxescontroller_findall","metadata":{"seo":{"title":"List all tax rates","description":"Retrieves a paginated list of all tax rates for the authenticated account. Supports pagination and filtering."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TaxesController_findAll","name":"List all tax rates","isWebhook":false,"pointer":"/paths/~1taxRates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all tax rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a paginated list of all tax rates for the authenticated account. Supports pagination and filtering."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{\"active\":true,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"inclusive\":false,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"created[gt|gte|lt|lte]\":1766066322}"},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_2"},{"name":"take","in":"query","schemaId":"schema_3"}],"pointer":"/paths/~1taxRates/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1taxRates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/taxRates","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_1"},{"name":"page","in":"query","required":false,"schemaId":"schema_2"},{"name":"take","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/taxRates","href":"taxrates/taxescontroller_findall","openApiOperationId":"TaxesController_findAll","summary":"List all tax rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved paginated list of tax rates","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageDto"}},"schemaId":"components/schemas/PageDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1taxRates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxrates/taxescontroller_findall"}],"panels":[]}]},"httpPath":"/taxRates"},{"label":"Create a tax rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/taxrates/taxescontroller_createtaxrate","routeSlug":"/developer-guide/api/taxrates/taxescontroller_createtaxrate","metadata":{"seo":{"title":"Create a tax rate","description":"Creates a new tax rate for the authenticated account. Tax rates define the percentage of tax to be applied to transactions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TaxesController_createTaxRate","name":"Create a tax rate","isWebhook":false,"pointer":"/paths/~1taxRates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a tax rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new tax rate for the authenticated account. Tax rates define the percentage of tax to be applied to transactions."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1taxRates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTaxPublicDto","exampleIds":["paths/~1taxRates/post/requestBody/content/application~1json/examples/example1"]}},"schemaId":"components/schemas/CreateTaxPublicDto","exampleIds":["paths/~1taxRates/post/requestBody/content/application~1json/examples/example1"],"pointer":"/paths/~1taxRates/post/requestBody","description":"Tax rate data to create"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/taxRates","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTaxPublicDto","exampleIds":["paths/~1taxRates/post/requestBody/content/application~1json/examples/example1"]}},"responseCodes":["201","400","401"],"pointer":"/taxRates","href":"taxrates/taxescontroller_createtaxrate","openApiOperationId":"TaxesController_createTaxRate","summary":"Create a tax rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateTaxPublicDto","exampleIds":["paths/~1taxRates/post/requestBody/content/application~1json/examples/example1"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTaxPublicDto","exampleIds":["paths/~1taxRates/post/requestBody/content/application~1json/examples/example1"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Tax rate successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxesPublicDto"}},"schemaId":"components/schemas/TaxesPublicDto"},{"code":"400","description":"Invalid input data, missing apiKey header, or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1taxRates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/TaxesPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxesPublicDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxrates/taxescontroller_createtaxrate"}],"panels":[]}]},"httpPath":"/taxRates"},{"label":"Retrieve a tax rate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/taxrates/taxescontroller_retrievetaxrate","routeSlug":"/developer-guide/api/taxrates/taxescontroller_retrievetaxrate","metadata":{"seo":{"title":"Retrieve a tax rate","description":"Retrieves a specific tax rate by its unique identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TaxesController_retrieveTaxRate","name":"Retrieve a tax rate","isWebhook":false,"pointer":"/paths/~1taxRates~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a tax rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specific tax rate by its unique identifier."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"Unique identifier of the tax rate","required":true}],"pointer":"/paths/~1taxRates~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1taxRates~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/taxRates/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"txr_inQ4hbLZPyljDXFRCEnjtEqK","schemaId":"schema_18"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/taxRates/{id}","href":"taxrates/taxescontroller_retrievetaxrate","openApiOperationId":"TaxesController_retrieveTaxRate","summary":"Retrieve a tax rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved the tax rate","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxesPublicDto"}},"schemaId":"components/schemas/TaxesPublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1taxRates~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxesPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxesPublicDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxrates/taxescontroller_retrievetaxrate"}],"panels":[]}]},"httpPath":"/taxRates/{id}"},{"label":"Update a tax rate","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/taxrates/taxescontroller_updatetaxrate","routeSlug":"/developer-guide/api/taxrates/taxescontroller_updatetaxrate","metadata":{"seo":{"title":"Update a tax rate","description":"Updates an existing tax rate by its unique identifier. Only the provided fields will be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TaxesController_updateTaxRate","name":"Update a tax rate","isWebhook":false,"pointer":"/paths/~1taxRates~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a tax rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing tax rate by its unique identifier. Only the provided fields will be updated."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"Unique identifier of the tax rate to update","required":true}],"pointer":"/paths/~1taxRates~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1taxRates~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTaxPublicDto"}},"schemaId":"components/schemas/UpdateTaxPublicDto","pointer":"/paths/~1taxRates~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/taxRates/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"txr_inQ4hbLZPyljDXFRCEnjtEqK","schemaId":"schema_18"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateTaxPublicDto"}},"responseCodes":["200","400","401"],"pointer":"/taxRates/{id}","href":"taxrates/taxescontroller_updatetaxrate","openApiOperationId":"TaxesController_updateTaxRate","summary":"Update a tax rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateTaxPublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTaxPublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tax rate successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxesPublicDto"}},"schemaId":"components/schemas/TaxesPublicDto"},{"code":"400","description":"Invalid input data, missing apiKey header, or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1taxRates~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxesPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxesPublicDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/taxrates/taxescontroller_updatetaxrate"}],"panels":[]}]},"httpPath":"/taxRates/{id}"}],"content":{"contentType":"group","meta":{"name":"TaxRates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TaxRates","showPageActions":true},{"nodeType":"markdoc","content":"TaxRates allow you to calculate the tax to collect from your customer."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/taxRates","summary":"List all tax rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/taxrates/taxescontroller_findall","deprecated":false},{"title":"/taxRates","summary":"Create a tax rate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/taxrates/taxescontroller_createtaxrate","deprecated":false},{"title":"/taxRates/{id}","summary":"Retrieve a tax rate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/taxrates/taxescontroller_retrievetaxrate","deprecated":false},{"title":"/taxRates/{id}","summary":"Update a tax rate","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/taxrates/taxescontroller_updatetaxrate","deprecated":false}]}]}]}]}},{"type":"group","label":"Prices","link":"/developer-guide/api/prices","routeSlug":"/developer-guide/api/prices","items":[{"label":"List all prices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/prices/pricescontroller_listallprices","routeSlug":"/developer-guide/api/prices/pricescontroller_listallprices","metadata":{"seo":{"title":"List all prices","description":"Retrieves a paginated list of all prices for the authenticated account. Supports pagination and search functionality."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PricesController_listAllPrices","name":"List all prices","isWebhook":false,"pointer":"/paths/~1prices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all prices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a paginated list of all prices for the authenticated account. Supports pagination and search functionality."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{\"active\":true,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"inclusive\":false,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"currency\":\"usd\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"type\":\"recurring|one_time\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"product\":\"prod_5S8Wt9GNRDxZ7Tjy6g9KKBb5\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"created[gt|gte|lt|lte]\":1766066322}"},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_2"},{"name":"take","in":"query","schemaId":"schema_3"}],"pointer":"/paths/~1prices/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1prices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/prices","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_1"},{"name":"page","in":"query","required":false,"schemaId":"schema_2"},{"name":"take","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/prices","href":"prices/pricescontroller_listallprices","openApiOperationId":"PricesController_listAllPrices","summary":"List all prices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved paginated list of prices","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}},"schemaId":"schema_19"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1prices/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prices/pricescontroller_listallprices"}],"panels":[]}]},"httpPath":"/prices"},{"label":"Retrieve a price","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/prices/pricescontroller_retrieveprice","routeSlug":"/developer-guide/api/prices/pricescontroller_retrieveprice","metadata":{"seo":{"title":"Retrieve a price","description":"Retrieves details of a specific price by its unique identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PricesController_retrievePrice","name":"Retrieve a price","isWebhook":false,"pointer":"/paths/~1prices~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a price","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves details of a specific price by its unique identifier."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_20","description":"Unique identifier of the price","required":true}],"pointer":"/paths/~1prices~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1prices~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/prices/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"price_1SGKTmDZYOQH9uHk1vaSxPKa","schemaId":"schema_20"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/prices/{id}","href":"prices/pricescontroller_retrieveprice","openApiOperationId":"PricesController_retrievePrice","summary":"Retrieve a price"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved price","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PricePublicDto"}},"schemaId":"components/schemas/PricePublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1prices~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PricePublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PricePublicDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prices/pricescontroller_retrieveprice"}],"panels":[]}]},"httpPath":"/prices/{id}"},{"label":"Create a price for a product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/prices/pricescontroller_createprice","routeSlug":"/developer-guide/api/prices/pricescontroller_createprice","metadata":{"seo":{"title":"Create a price for a product","description":"Creates a new price for an existing product. The price can be one-time or recurring (subscription-based)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PricesController_createPrice","name":"Create a price for a product","isWebhook":false,"pointer":"/paths/~1prices~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a price for a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new price for an existing product. The price can be one-time or recurring (subscription-based)."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_13","description":"Unique identifier of the product to add the price to","required":true}],"pointer":"/paths/~1prices~1{id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1prices~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePricePublicDto","exampleIds":["paths/~1prices~1{id}/post/requestBody/content/application~1json/examples/Recurring Price","paths/~1prices~1{id}/post/requestBody/content/application~1json/examples/One-time Price"]}},"schemaId":"components/schemas/CreatePricePublicDto","exampleIds":["paths/~1prices~1{id}/post/requestBody/content/application~1json/examples/Recurring Price","paths/~1prices~1{id}/post/requestBody/content/application~1json/examples/One-time Price"],"pointer":"/paths/~1prices~1{id}/post/requestBody","description":"Price creation data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/prices/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"prod_xT4LfvxLMQb4s9uFNIbXf9pm","schemaId":"schema_13"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePricePublicDto","exampleIds":["paths/~1prices~1{id}/post/requestBody/content/application~1json/examples/Recurring Price","paths/~1prices~1{id}/post/requestBody/content/application~1json/examples/One-time Price"]}},"responseCodes":["201","400","401","404"],"pointer":"/prices/{id}","href":"prices/pricescontroller_createprice","openApiOperationId":"PricesController_createPrice","summary":"Create a price for a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreatePricePublicDto","exampleIds":["paths/~1prices~1{id}/post/requestBody/content/application~1json/examples/Recurring Price","paths/~1prices~1{id}/post/requestBody/content/application~1json/examples/One-time Price"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePricePublicDto","exampleIds":["paths/~1prices~1{id}/post/requestBody/content/application~1json/examples/Recurring Price","paths/~1prices~1{id}/post/requestBody/content/application~1json/examples/One-time Price"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Price successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PricePublicDto"}},"schemaId":"components/schemas/PricePublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Product not found"}],"pointer":"/paths/~1prices~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PricePublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PricePublicDto"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prices/pricescontroller_createprice"}],"panels":[]}]},"httpPath":"/prices/{id}"},{"label":"Delete a price","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/prices/pricescontroller_deleteprice","routeSlug":"/developer-guide/api/prices/pricescontroller_deleteprice","metadata":{"seo":{"title":"Delete a price","description":"Permanently deletes a price that has never been billed. This action cannot be undone. A price is activated permanently the first time it is billed, Chaching exposes no endpoint that deactivates it, and an active price can therefore never be deleted: this endpoint answers 400 for it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PricesController_deletePrice","name":"Delete a price","isWebhook":false,"pointer":"/paths/~1prices~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a price","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently deletes a price that has never been billed. This action cannot be undone. A price is activated permanently the first time it is billed, Chaching exposes no endpoint that deactivates it, and an active price can therefore never be deleted: this endpoint answers 400 for it."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_20","description":"Unique identifier of the price to delete","required":true}],"pointer":"/paths/~1prices~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1prices~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/prices/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"price_1SGKTmDZYOQH9uHk1vaSxPKa","schemaId":"schema_20"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404"],"pointer":"/prices/{id}","href":"prices/pricescontroller_deleteprice","openApiOperationId":"PricesController_deletePrice","summary":"Delete a price"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Price successfully deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}},"schemaId":"schema_21"},{"code":"400","description":"Missing apiKey header; invalid apiKey format; the price is active and can never be deleted."},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Price not found"}],"pointer":"/paths/~1prices~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_21","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prices/pricescontroller_deleteprice"}],"panels":[]}]},"httpPath":"/prices/{id}"},{"label":"Update all details of a price","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/prices/pricescontroller_updateinactiveprice","routeSlug":"/developer-guide/api/prices/pricescontroller_updateinactiveprice","metadata":{"seo":{"title":"Update all details of a price","description":"Updates the currency, amount, type, recurring interval, tax behavior, and description of a price. When the price has at least one subscription attached, only the description is applied and every other field is left unchanged. This endpoint never changes the active status of the price, and the route name describes the state a price is normally in when a full update makes sense rather than a precondition this endpoint enforces."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PricesController_updateInactivePrice","name":"Update all details of a price","isWebhook":false,"pointer":"/paths/~1prices~1{id}~1inactive/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update all details of a price","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the currency, amount, type, recurring interval, tax behavior, and description of a price. When the price has at least one subscription attached, only the description is applied and every other field is left unchanged. This endpoint never changes the active status of the price, and the route name describes the state a price is normally in when a full update makes sense rather than a precondition this endpoint enforces."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_20","description":"Unique identifier of the price to update","required":true}],"pointer":"/paths/~1prices~1{id}~1inactive/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1prices~1{id}~1inactive/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePricePublicDto","exampleIds":["paths/~1prices~1{id}~1inactive/patch/requestBody/content/application~1json/examples/Update Recurring Price"]}},"schemaId":"components/schemas/CreatePricePublicDto","exampleIds":["paths/~1prices~1{id}~1inactive/patch/requestBody/content/application~1json/examples/Update Recurring Price"],"pointer":"/paths/~1prices~1{id}~1inactive/patch/requestBody","description":"Price update data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/prices/{id}/inactive","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"price_1SGKTmDZYOQH9uHk1vaSxPKa","schemaId":"schema_20"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePricePublicDto","exampleIds":["paths/~1prices~1{id}~1inactive/patch/requestBody/content/application~1json/examples/Update Recurring Price"]}},"responseCodes":["200","400","401","404"],"pointer":"/prices/{id}/inactive","href":"prices/pricescontroller_updateinactiveprice","openApiOperationId":"PricesController_updateInactivePrice","summary":"Update all details of a price"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreatePricePublicDto","exampleIds":["paths/~1prices~1{id}~1inactive/patch/requestBody/content/application~1json/examples/Update Recurring Price"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePricePublicDto","exampleIds":["paths/~1prices~1{id}~1inactive/patch/requestBody/content/application~1json/examples/Update Recurring Price"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Price successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PricePublicDto"}},"schemaId":"components/schemas/PricePublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Price not found"}],"pointer":"/paths/~1prices~1{id}~1inactive/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PricePublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PricePublicDto"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prices/pricescontroller_updateinactiveprice"}],"panels":[]}]},"httpPath":"/prices/{id}/inactive"},{"label":"Update the description of a price","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/prices/pricescontroller_updateactiveprice","routeSlug":"/developer-guide/api/prices/pricescontroller_updateactiveprice","metadata":{"seo":{"title":"Update the description of a price","description":"Updates only the customer-facing description of a price. No other field is modified, and this endpoint never changes the active status of the price. A price is activated permanently the first time it is billed; Chaching exposes no endpoint that deactivates a price."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PricesController_updateActivePrice","name":"Update the description of a price","isWebhook":false,"pointer":"/paths/~1prices~1{id}~1active/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the description of a price","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates only the customer-facing description of a price. No other field is modified, and this endpoint never changes the active status of the price. A price is activated permanently the first time it is billed; Chaching exposes no endpoint that deactivates a price."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_20","description":"Unique identifier of the price to update","required":true}],"pointer":"/paths/~1prices~1{id}~1active/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1prices~1{id}~1active/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePriceDto","exampleIds":["paths/~1prices~1{id}~1active/patch/requestBody/content/application~1json/examples/Update Description"]}},"schemaId":"components/schemas/UpdatePriceDto","exampleIds":["paths/~1prices~1{id}~1active/patch/requestBody/content/application~1json/examples/Update Description"],"pointer":"/paths/~1prices~1{id}~1active/patch/requestBody","description":"Price metadata update data (only description can be updated for active prices)"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/prices/{id}/active","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"price_1SGKTmDZYOQH9uHk1vaSxPKa","schemaId":"schema_20"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePriceDto","exampleIds":["paths/~1prices~1{id}~1active/patch/requestBody/content/application~1json/examples/Update Description"]}},"responseCodes":["200","400","401","404"],"pointer":"/prices/{id}/active","href":"prices/pricescontroller_updateactiveprice","openApiOperationId":"PricesController_updateActivePrice","summary":"Update the description of a price"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/UpdatePriceDto","exampleIds":["paths/~1prices~1{id}~1active/patch/requestBody/content/application~1json/examples/Update Description"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePriceDto","exampleIds":["paths/~1prices~1{id}~1active/patch/requestBody/content/application~1json/examples/Update Description"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Price metadata successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PricePublicDto"}},"schemaId":"components/schemas/PricePublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Price not found"}],"pointer":"/paths/~1prices~1{id}~1active/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PricePublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PricePublicDto"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prices/pricescontroller_updateactiveprice"}],"panels":[]}]},"httpPath":"/prices/{id}/active"}],"content":{"contentType":"group","meta":{"name":"Prices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Prices","showPageActions":true},{"nodeType":"markdoc","content":"This object represents a price in your Chaching account. Use it to define the cost of your products, configure one-time or recurring billing intervals, specify tax behavior, and manage pricing updates or deactivations for your offerings."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/prices","summary":"List all prices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/prices/pricescontroller_listallprices","deprecated":false},{"title":"/prices/{id}","summary":"Retrieve a price","prefix":{"name":"get","color":"get"},"badges":[],"link":"/prices/pricescontroller_retrieveprice","deprecated":false},{"title":"/prices/{id}","summary":"Create a price for a product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/prices/pricescontroller_createprice","deprecated":false},{"title":"/prices/{id}","summary":"Delete a price","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/prices/pricescontroller_deleteprice","deprecated":false},{"title":"/prices/{id}/inactive","summary":"Update all details of a price","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/prices/pricescontroller_updateinactiveprice","deprecated":false},{"title":"/prices/{id}/active","summary":"Update the description of a price","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/prices/pricescontroller_updateactiveprice","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscriptions","link":"/developer-guide/api/subscriptions","routeSlug":"/developer-guide/api/subscriptions","items":[{"label":"List all subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/subscriptions/subscriptionscontroller_listsubscriptions","routeSlug":"/developer-guide/api/subscriptions/subscriptionscontroller_listsubscriptions","metadata":{"seo":{"title":"List all subscriptions","description":"Retrieves a paginated list of all subscriptions for the authenticated account. Supports pagination and filtering."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SubscriptionsController_listSubscriptions","name":"List all subscriptions","isWebhook":false,"pointer":"/paths/~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a paginated list of all subscriptions for the authenticated account. Supports pagination and filtering."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{\"status\":\"active|cancelled|paused|scheduled|expired|trial\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"customer\":\"cus_fa66daabf0b474b167e1d46c\"}"},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_2"},{"name":"take","in":"query","schemaId":"schema_3"}],"pointer":"/paths/~1subscriptions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_1"},{"name":"page","in":"query","required":false,"schemaId":"schema_2"},{"name":"take","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/subscriptions","href":"subscriptions/subscriptionscontroller_listsubscriptions","openApiOperationId":"SubscriptionsController_listSubscriptions","summary":"List all subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved paginated list of subscriptions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageDto"}},"schemaId":"components/schemas/PageDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/subscriptionscontroller_listsubscriptions"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"Create a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/subscriptions/subscriptionscontroller_createsubscription","routeSlug":"/developer-guide/api/subscriptions/subscriptionscontroller_createsubscription","metadata":{"seo":{"title":"Create a subscription","description":"Creates a new subscription for a customer. The subscription will include product items, pricing, and billing information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SubscriptionsController_createSubscription","name":"Create a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new subscription for a customer. The subscription will include product items, pricing, and billing information."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionPublicDto"}},"schemaId":"components/schemas/CreateSubscriptionPublicDto","pointer":"/paths/~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionPublicDto"}},"responseCodes":["201","400","401","404"],"pointer":"/subscriptions","href":"subscriptions/subscriptionscontroller_createsubscription","openApiOperationId":"SubscriptionsController_createSubscription","summary":"Create a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateSubscriptionPublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionPublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Subscription successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionsPublicDto"}},"schemaId":"components/schemas/SubscriptionsPublicDto"},{"code":"400","description":"Invalid input data, missing apiKey header, or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Customer or price not found"}],"pointer":"/paths/~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/SubscriptionsPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionsPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/subscriptionscontroller_createsubscription"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"Retrieve a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/subscriptions/subscriptionscontroller_retrievesubscription","routeSlug":"/developer-guide/api/subscriptions/subscriptionscontroller_retrievesubscription","metadata":{"seo":{"title":"Retrieve a subscription","description":"Retrieves a specific subscription by its unique identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SubscriptionsController_retrieveSubscription","name":"Retrieve a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specific subscription by its unique identifier."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_22","description":"Unique identifier of the subscription","required":true}],"pointer":"/paths/~1subscriptions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1subscriptions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"sub_2FdhgypnsJQn9mZlY5qGaElL","schemaId":"schema_22"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404"],"pointer":"/subscriptions/{id}","href":"subscriptions/subscriptionscontroller_retrievesubscription","openApiOperationId":"SubscriptionsController_retrieveSubscription","summary":"Retrieve a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved the subscription","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionsPublicDto"}},"schemaId":"components/schemas/SubscriptionsPublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Subscription not found"}],"pointer":"/paths/~1subscriptions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionsPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionsPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/subscriptionscontroller_retrievesubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}"},{"label":"Update a subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/subscriptions/subscriptionscontroller_updatesubscription","routeSlug":"/developer-guide/api/subscriptions/subscriptionscontroller_updatesubscription","metadata":{"seo":{"title":"Update a subscription","description":"Updates an existing subscription by its unique identifier. Can modify items, pricing, billing information, and other subscription details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SubscriptionsController_updateSubscription","name":"Update a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing subscription by its unique identifier. Can modify items, pricing, billing information, and other subscription details."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_22","description":"Unique identifier of the subscription to update","required":true}],"pointer":"/paths/~1subscriptions~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1subscriptions~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionPublicDto"}},"schemaId":"components/schemas/UpdateSubscriptionPublicDto","pointer":"/paths/~1subscriptions~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/subscriptions/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"sub_2FdhgypnsJQn9mZlY5qGaElL","schemaId":"schema_22"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionPublicDto"}},"responseCodes":["200","400","401","404"],"pointer":"/subscriptions/{id}","href":"subscriptions/subscriptionscontroller_updatesubscription","openApiOperationId":"SubscriptionsController_updateSubscription","summary":"Update a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateSubscriptionPublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionPublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionsPublicDto"}},"schemaId":"components/schemas/SubscriptionsPublicDto"},{"code":"400","description":"Invalid input data, missing apiKey header, or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Subscription not found"}],"pointer":"/paths/~1subscriptions~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionsPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionsPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/subscriptionscontroller_updatesubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}"},{"label":"Cancel a subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/subscriptions/subscriptionscontroller_cancelsubscription","routeSlug":"/developer-guide/api/subscriptions/subscriptionscontroller_cancelsubscription","metadata":{"seo":{"title":"Cancel a subscription","description":"Cancels an active subscription. The subscription will be terminated immediately or at the end of the current billing period based on configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SubscriptionsController_cancelSubscription","name":"Cancel a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels an active subscription. The subscription will be terminated immediately or at the end of the current billing period based on configuration."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_22","description":"Unique identifier of the subscription to cancel","required":true}],"pointer":"/paths/~1subscriptions~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1subscriptions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscriptions/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"sub_2FdhgypnsJQn9mZlY5qGaElL","schemaId":"schema_22"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404"],"pointer":"/subscriptions/{id}","href":"subscriptions/subscriptionscontroller_cancelsubscription","openApiOperationId":"SubscriptionsController_cancelSubscription","summary":"Cancel a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription successfully cancelled"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Subscription not found"}],"pointer":"/paths/~1subscriptions~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/subscriptionscontroller_cancelsubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}"},{"label":"Pause a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/subscriptions/subscriptionscontroller_pausesubscription","routeSlug":"/developer-guide/api/subscriptions/subscriptionscontroller_pausesubscription","metadata":{"seo":{"title":"Pause a subscription","description":"Pauses an active subscription. No charges will be made while the subscription is paused. The subscription can be resumed later."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SubscriptionsController_pauseSubscription","name":"Pause a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1pause/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pause a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Pauses an active subscription. No charges will be made while the subscription is paused. The subscription can be resumed later."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_22","description":"Unique identifier of the subscription to pause","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1pause/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1pause/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{id}/pause","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"sub_2FdhgypnsJQn9mZlY5qGaElL","schemaId":"schema_22"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","201","400","401","404"],"pointer":"/subscriptions/{id}/pause","href":"subscriptions/subscriptionscontroller_pausesubscription","openApiOperationId":"SubscriptionsController_pauseSubscription","summary":"Pause a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription successfully paused"},{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0"}},"schemaId":"schema_0"},{"code":"400","description":"Subscription cannot be paused, missing apiKey header, or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Subscription not found"}],"pointer":"/paths/~1subscriptions~1{id}~1pause/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"201","schemaId":"schema_0","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/subscriptionscontroller_pausesubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/pause"},{"label":"Resume a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/subscriptions/subscriptionscontroller_resumesubscription","routeSlug":"/developer-guide/api/subscriptions/subscriptionscontroller_resumesubscription","metadata":{"seo":{"title":"Resume a subscription","description":"Resumes a paused subscription. Billing will continue from where it was paused, and the subscription will be active again."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SubscriptionsController_resumeSubscription","name":"Resume a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1resume/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resume a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resumes a paused subscription. Billing will continue from where it was paused, and the subscription will be active again."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_22","description":"Unique identifier of the subscription to resume","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1resume/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1resume/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{id}/resume","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"sub_2FdhgypnsJQn9mZlY5qGaElL","schemaId":"schema_22"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","201","400","401","404"],"pointer":"/subscriptions/{id}/resume","href":"subscriptions/subscriptionscontroller_resumesubscription","openApiOperationId":"SubscriptionsController_resumeSubscription","summary":"Resume a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription successfully resumed"},{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0"}},"schemaId":"schema_0"},{"code":"400","description":"Subscription is not paused, missing apiKey header, or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Subscription not found"}],"pointer":"/paths/~1subscriptions~1{id}~1resume/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"201","schemaId":"schema_0","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/subscriptionscontroller_resumesubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/resume"}],"content":{"contentType":"group","meta":{"name":"Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","showPageActions":true},{"nodeType":"markdoc","content":"Subscriptions are a way to charge your customers on a recurring basis. They can be used for products or services that are delivered over time, such as memberships or software licenses."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscriptions","summary":"List all subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/subscriptionscontroller_listsubscriptions","deprecated":false},{"title":"/subscriptions","summary":"Create a subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/subscriptionscontroller_createsubscription","deprecated":false},{"title":"/subscriptions/{id}","summary":"Retrieve a subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/subscriptionscontroller_retrievesubscription","deprecated":false},{"title":"/subscriptions/{id}","summary":"Update a subscription","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/subscriptions/subscriptionscontroller_updatesubscription","deprecated":false},{"title":"/subscriptions/{id}","summary":"Cancel a subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscriptions/subscriptionscontroller_cancelsubscription","deprecated":false},{"title":"/subscriptions/{id}/pause","summary":"Pause a subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/subscriptionscontroller_pausesubscription","deprecated":false},{"title":"/subscriptions/{id}/resume","summary":"Resume a subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/subscriptionscontroller_resumesubscription","deprecated":false}]}]}]}]}},{"type":"group","label":"Balance","link":"/developer-guide/api/balance","routeSlug":"/developer-guide/api/balance","items":[{"label":"Retrieve balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/balance/balancecontroller_getbalance","routeSlug":"/developer-guide/api/balance/balancecontroller_getbalance","metadata":{"seo":{"title":"Retrieve balance","description":"Retrieves the current account balance, based on the authentication that was used to make the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BalanceController_getBalance","name":"Retrieve balance","isWebhook":false,"pointer":"/paths/~1balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the current account balance, based on the authentication that was used to make the request."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/balance","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","409"],"pointer":"/balance","href":"balance/balancecontroller_getbalance","openApiOperationId":"BalanceController_getBalance","summary":"Retrieve balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Balance","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BalancePublicDto"}},"schemaId":"components/schemas/BalancePublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"409","description":"This route authenticates with cc-api-key only; remove the Authorization header. Stripe is not connected for this account. Stripe balance requires the account public API key."}],"pointer":"/paths/~1balance/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BalancePublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BalancePublicDto"}}},{"code":"400"},{"code":"401"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/balancecontroller_getbalance"}],"panels":[]}]},"httpPath":"/balance"}],"content":{"contentType":"group","meta":{"name":"Balance"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balance","showPageActions":true},{"nodeType":"markdoc","content":"Balances represent the amount of money in your account. You can use balances to track your income and expenses, and to make payments to your customers or vendors."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/balance","summary":"Retrieve balance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balance/balancecontroller_getbalance","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Methods","link":"/developer-guide/api/payment-methods","routeSlug":"/developer-guide/api/payment-methods","items":[{"label":"List all payment methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-methods/paymentmethodscontroller_getpaymentmethods","routeSlug":"/developer-guide/api/payment-methods/paymentmethodscontroller_getpaymentmethods","metadata":{"seo":{"title":"List all payment methods","description":"Retrieves a list of payment methods for the current account, based on the authentication that was used to make the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentMethodsController_getPaymentMethods","name":"List all payment methods","isWebhook":false,"pointer":"/paths/~1payment-methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all payment methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of payment methods for the current account, based on the authentication that was used to make the request."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_1"},{"name":"page","in":"query","schemaId":"schema_2"},{"name":"take","in":"query","schemaId":"schema_3"}],"pointer":"/paths/~1payment-methods/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1payment-methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-methods","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_1"},{"name":"page","in":"query","required":false,"schemaId":"schema_2"},{"name":"take","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/payment-methods","href":"payment-methods/paymentmethodscontroller_getpaymentmethods","openApiOperationId":"PaymentMethodsController_getPaymentMethods","summary":"List all payment methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of payment methods","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageDto"}},"schemaId":"components/schemas/PageDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1payment-methods/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/paymentmethodscontroller_getpaymentmethods"}],"panels":[]}]},"httpPath":"/payment-methods"},{"label":"Retrieve a payment method","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-methods/paymentmethodscontroller_getpaymentmethod","routeSlug":"/developer-guide/api/payment-methods/paymentmethodscontroller_getpaymentmethod","metadata":{"seo":{"title":"Retrieve a payment method","description":"Retrieves detailed information about a specific payment method for the current account, based on the authentication that was used to make the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentMethodsController_getPaymentMethod","name":"Retrieve a payment method","isWebhook":false,"pointer":"/paths/~1payment-methods~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific payment method for the current account, based on the authentication that was used to make the request."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1payment-methods~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1payment-methods~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-methods/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/payment-methods/{id}","href":"payment-methods/paymentmethodscontroller_getpaymentmethod","openApiOperationId":"PaymentMethodsController_getPaymentMethod","summary":"Retrieve a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment method details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodPublicDto"}},"schemaId":"components/schemas/PaymentMethodPublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1payment-methods~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentMethodPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodPublicDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/paymentmethodscontroller_getpaymentmethod"}],"panels":[]}]},"httpPath":"/payment-methods/{id}"},{"label":"Attach a payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-methods/paymentmethodscontroller_attachpaymentmethod","routeSlug":"/developer-guide/api/payment-methods/paymentmethodscontroller_attachpaymentmethod","metadata":{"seo":{"title":"Attach a payment method","description":"Attaches a payment method to a customer for the current account, based on the authentication that was used to make the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentMethodsController_attachPaymentMethod","name":"Attach a payment method","isWebhook":false,"pointer":"/paths/~1payment-methods~1{id}~1attach/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attach a payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Attaches a payment method to a customer for the current account, based on the authentication that was used to make the request."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1payment-methods~1{id}~1attach/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1payment-methods~1{id}~1attach/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AttachPaymentMethodPublicRequestDto"}},"schemaId":"components/schemas/AttachPaymentMethodPublicRequestDto","pointer":"/paths/~1payment-methods~1{id}~1attach/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-methods/{id}/attach","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/AttachPaymentMethodPublicRequestDto"}},"responseCodes":["200","201","400","401","404","409"],"pointer":"/payment-methods/{id}/attach","href":"payment-methods/paymentmethodscontroller_attachpaymentmethod","openApiOperationId":"PaymentMethodsController_attachPaymentMethod","summary":"Attach a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/AttachPaymentMethodPublicRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AttachPaymentMethodPublicRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment method details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodPublicDto"}},"schemaId":"components/schemas/PaymentMethodPublicDto"},{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodPublicDto"}},"schemaId":"components/schemas/PaymentMethodPublicDto"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing postal code is required for this merchant (BILLING_ZIP_REQUIRED). Returned when the account is on the NMI or Dejavoo gateway, requires a billing ZIP, and the request carries no zipcode. Also returned on missing apiKey header or invalid apiKey format."},"children":[]}]}]}]},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Customer not found. Returned when the customerId does not resolve to a customer owned by the account named by the presented cc-api-key (CHA-131)."},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another change to this customer's payment methods is in progress (PAYMENT_METHOD_CHANGE_IN_PROGRESS): nothing was saved; retry the request. Also returned, without a code, when the customer is not linked with a payment gateway."},"children":[]}]}]}]}],"pointer":"/paths/~1payment-methods~1{id}~1attach/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentMethodPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodPublicDto"}}},{"code":"201","schemaId":"components/schemas/PaymentMethodPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/paymentmethodscontroller_attachpaymentmethod"}],"panels":[]}]},"httpPath":"/payment-methods/{id}/attach"},{"label":"Detach a payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-methods/paymentmethodscontroller_detachpaymentmethod","routeSlug":"/developer-guide/api/payment-methods/paymentmethodscontroller_detachpaymentmethod","metadata":{"seo":{"title":"Detach a payment method","description":"Detaches a payment method from a customer for the current account, based on the authentication that was used to make the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentMethodsController_detachPaymentMethod","name":"Detach a payment method","isWebhook":false,"pointer":"/paths/~1payment-methods~1{id}~1detach/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detach a payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Detaches a payment method from a customer for the current account, based on the authentication that was used to make the request."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1payment-methods~1{id}~1detach/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1payment-methods~1{id}~1detach/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-methods/{id}/detach","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","201","400","401"],"pointer":"/payment-methods/{id}/detach","href":"payment-methods/paymentmethodscontroller_detachpaymentmethod","openApiOperationId":"PaymentMethodsController_detachPaymentMethod","summary":"Detach a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment method details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodPublicDto"}},"schemaId":"components/schemas/PaymentMethodPublicDto"},{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodPublicDto"}},"schemaId":"components/schemas/PaymentMethodPublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1payment-methods~1{id}~1detach/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentMethodPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodPublicDto"}}},{"code":"201","schemaId":"components/schemas/PaymentMethodPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodPublicDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/paymentmethodscontroller_detachpaymentmethod"}],"panels":[]}]},"httpPath":"/payment-methods/{id}/detach"},{"label":"Set a payment method as the customer default","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-methods/paymentmethodscontroller_setdefaultpaymentmethod","routeSlug":"/developer-guide/api/payment-methods/paymentmethodscontroller_setdefaultpaymentmethod","metadata":{"seo":{"title":"Set a payment method as the customer default","description":"Makes a payment method the default for one of the current account's customers, based on the authentication that was used to make the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentMethodsController_setDefaultPaymentMethod","name":"Set a payment method as the customer default","isWebhook":false,"pointer":"/paths/~1payment-methods~1{id}~1set-default/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set a payment method as the customer default","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Makes a payment method the default for one of the current account's customers, based on the authentication that was used to make the request."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1payment-methods~1{id}~1set-default/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1payment-methods~1{id}~1set-default/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SetDefaultPaymentMethodPublicRequestDto"}},"schemaId":"components/schemas/SetDefaultPaymentMethodPublicRequestDto","pointer":"/paths/~1payment-methods~1{id}~1set-default/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-methods/{id}/set-default","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SetDefaultPaymentMethodPublicRequestDto"}},"responseCodes":["201","400","401"],"pointer":"/payment-methods/{id}/set-default","href":"payment-methods/paymentmethodscontroller_setdefaultpaymentmethod","openApiOperationId":"PaymentMethodsController_setDefaultPaymentMethod","summary":"Set a payment method as the customer default"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/SetDefaultPaymentMethodPublicRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SetDefaultPaymentMethodPublicRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Payment method details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodPublicDto"}},"schemaId":"components/schemas/PaymentMethodPublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"}],"pointer":"/paths/~1payment-methods~1{id}~1set-default/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PaymentMethodPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodPublicDto"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/paymentmethodscontroller_setdefaultpaymentmethod"}],"panels":[]}]},"httpPath":"/payment-methods/{id}/set-default"}],"content":{"contentType":"group","meta":{"name":"Payment Methods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Methods","showPageActions":true},{"nodeType":"markdoc","content":"Payment Methods represent a way to collect payment from your customers. They can be attached to customers to make charging easier and more efficient."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payment-methods","summary":"List all payment methods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-methods/paymentmethodscontroller_getpaymentmethods","deprecated":false},{"title":"/payment-methods/{id}","summary":"Retrieve a payment method","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-methods/paymentmethodscontroller_getpaymentmethod","deprecated":false},{"title":"/payment-methods/{id}/attach","summary":"Attach a payment method","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/paymentmethodscontroller_attachpaymentmethod","deprecated":false},{"title":"/payment-methods/{id}/detach","summary":"Detach a payment method","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/paymentmethodscontroller_detachpaymentmethod","deprecated":false},{"title":"/payment-methods/{id}/set-default","summary":"Set a payment method as the customer default","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/paymentmethodscontroller_setdefaultpaymentmethod","deprecated":false}]}]}]}]}},{"type":"group","label":"Revenue Recovery","link":"/developer-guide/api/revenue-recovery","routeSlug":"/developer-guide/api/revenue-recovery","items":[{"label":"Retrieve revenue recovery settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/revenue-recovery/revenuerecoverycontroller_getrevenuerecovery","routeSlug":"/developer-guide/api/revenue-recovery/revenuerecoverycontroller_getrevenuerecovery","metadata":{"seo":{"title":"Retrieve revenue recovery settings","description":"Retrieves the account's revenue recovery settings — the payment-retry schedule and the two failed-payment outcomes. The settings apply to your whole account, every subscription and every payment plan alike, and there are no per-customer settings. Saved settings also apply to customers who already have unpaid invoices."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RevenueRecoveryController_getRevenueRecovery","name":"Retrieve revenue recovery settings","isWebhook":false,"pointer":"/paths/~1revenue-recovery/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve revenue recovery settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the account's revenue recovery settings — the payment-retry schedule and the two failed-payment outcomes. The settings apply to your whole account, every subscription and every payment plan alike, and there are no per-customer settings. Saved settings also apply to customers who already have unpaid invoices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1revenue-recovery/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenue-recovery","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","409"],"pointer":"/revenue-recovery","href":"revenue-recovery/revenuerecoverycontroller_getrevenuerecovery","openApiOperationId":"RevenueRecoveryController_getRevenueRecovery","summary":"Retrieve revenue recovery settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Revenue recovery settings","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueRecoveryPublicDto"}},"schemaId":"components/schemas/RevenueRecoveryPublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"404","description":"Account settings not found"},{"code":"409","description":"This route authenticates with cc-api-key only; remove the Authorization header"}],"pointer":"/paths/~1revenue-recovery/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueRecoveryPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueRecoveryPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recovery/revenuerecoverycontroller_getrevenuerecovery"}],"panels":[]}]},"httpPath":"/revenue-recovery"},{"label":"Update revenue recovery settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/revenue-recovery/revenuerecoverycontroller_updaterevenuerecovery","routeSlug":"/developer-guide/api/revenue-recovery/revenuerecoverycontroller_updaterevenuerecovery","metadata":{"seo":{"title":"Update revenue recovery settings","description":"Replaces the account's revenue recovery settings — the payment-retry schedule and the two failed-payment outcomes. The settings apply to your whole account, every subscription and every payment plan alike, and there are no per-customer settings. Saved settings also apply to customers who already have unpaid invoices."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RevenueRecoveryController_updateRevenueRecovery","name":"Update revenue recovery settings","isWebhook":false,"pointer":"/paths/~1revenue-recovery/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update revenue recovery settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces the account's revenue recovery settings — the payment-retry schedule and the two failed-payment outcomes. The settings apply to your whole account, every subscription and every payment plan alike, and there are no per-customer settings. Saved settings also apply to customers who already have unpaid invoices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":"Chaching API Key","required":true}],"pointer":"/paths/~1revenue-recovery/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRevenueRecoveryPublicDto"}},"schemaId":"components/schemas/UpdateRevenueRecoveryPublicDto","pointer":"/paths/~1revenue-recovery/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/revenue-recovery","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateRevenueRecoveryPublicDto"}},"responseCodes":["200","400","401","409"],"pointer":"/revenue-recovery","href":"revenue-recovery/revenuerecoverycontroller_updaterevenuerecovery","openApiOperationId":"RevenueRecoveryController_updateRevenueRecovery","summary":"Update revenue recovery settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateRevenueRecoveryPublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRevenueRecoveryPublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated revenue recovery settings","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueRecoveryPublicDto"}},"schemaId":"components/schemas/RevenueRecoveryPublicDto"},{"code":"400","description":"Missing apiKey header; invalid apiKey format; invalid request body."},{"code":"401","description":"Invalid API key"},{"code":"409","description":"This route authenticates with cc-api-key only; remove the Authorization header"}],"pointer":"/paths/~1revenue-recovery/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueRecoveryPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueRecoveryPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recovery/revenuerecoverycontroller_updaterevenuerecovery"}],"panels":[]}]},"httpPath":"/revenue-recovery"}],"content":{"contentType":"group","meta":{"name":"Revenue Recovery"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revenue Recovery","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue recovery settings control what happens when a customer's automatic payments fail: the retry schedule, what happens to the customer's subscriptions after the last retry fails, and what happens to their unpaid invoices. The settings apply to your whole account — every subscription and every payment plan — and there are no per-customer settings. Saved settings also apply to customers who already have unpaid invoices."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue-recovery","summary":"Retrieve revenue recovery settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-recovery/revenuerecoverycontroller_getrevenuerecovery","deprecated":false},{"title":"/revenue-recovery","summary":"Update revenue recovery settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/revenue-recovery/revenuerecoverycontroller_updaterevenuerecovery","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Plans","link":"/developer-guide/api/payment-plans","routeSlug":"/developer-guide/api/payment-plans","items":[{"label":"Create a payment plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-plans/paymentplanscontroller_createpaymentplan","routeSlug":"/developer-guide/api/payment-plans/paymentplanscontroller_createpaymentplan","metadata":{"seo":{"title":"Create a payment plan","description":"Create a payment plan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentPlansController_createPaymentPlan","name":"Create a payment plan","isWebhook":false,"pointer":"/paths/~1payment-plans/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payment plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0"}],"pointer":"/paths/~1payment-plans/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePaymentPlanPublicDto"}},"schemaId":"components/schemas/CreatePaymentPlanPublicDto","pointer":"/paths/~1payment-plans/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-plans","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePaymentPlanPublicDto"}},"responseCodes":["201","400","401","402","403","404","409","422","500","502"],"pointer":"/payment-plans","href":"payment-plans/paymentplanscontroller_createpaymentplan","openApiOperationId":"PaymentPlansController_createPaymentPlan","summary":"Create a payment plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreatePaymentPlanPublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePaymentPlanPublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created payment plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPublicDto"}},"schemaId":"components/schemas/PaymentPlanPublicDto"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request (PAYMENT_PLAN_SCHEDULE_INVALID, PAYMENT_PLAN_AMOUNT_INVALID, PAYMENT_PLAN_INTERVAL_INVALID, PAYMENT_PLAN_START_DATE_INVALID, PAYMENT_PLAN_DOWN_PAYMENT_NOT_ALLOWED, PAYMENT_PLAN_GATEWAY_NOT_SUPPORTED, IDEMPOTENCY_KEY_INVALID). A body that fails field validation (a value below its minimum, an unknown field, a description longer than 255 characters or containing a control character) is rejected with 400 and no error code."},"children":[]}]}]}]},{"code":"401","description":"Invalid API key"},{"code":"402","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The down payment was declined (PAYMENT_PLAN_DOWN_PAYMENT_DECLINED). No plan is created."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Plans are not enabled for this account (PAYMENT_PLANS_NOT_ENABLED)"},"children":[]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer or payment method not found (CUSTOMER_NOT_FOUND, PAYMENT_METHOD_NOT_FOUND)"},"children":[]}]}]}]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The plan cannot be created (PAYMENT_PLAN_PAYMENT_METHOD_NOT_SUPPORTED, PAYMENT_PLAN_CREDENTIAL_NOT_ESTABLISHED, PAYMENT_PLAN_UNPAID_OUTCOME_NOT_SUPPORTED, PAYMENT_PLAN_DUNNING_SCHEDULE_TOO_SHORT, PAYMENT_PLAN_CUSTOMER_DELINQUENT, PAYMENT_PLAN_AUTO_PAY_OFF, PAYMENT_PLAN_ACCOUNT_INVOICED_AHEAD, PAYMENT_PLAN_DOWN_PAYMENT_PENDING, IDEMPOTENCY_KEY_IN_PROGRESS)"},"children":[]}]}]}]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Idempotency-Key was already used with a different request (IDEMPOTENCY_KEY_REUSED)"},"children":[]}]}]}]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The registered schedule did not match the expected installment dates (PAYMENT_PLAN_SCHEDULE_MISMATCH). No plan is created."},"children":[]}]}]}]},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The outcome could not be confirmed or the billing engine could not be read (PAYMENT_PLAN_DOWN_PAYMENT_UNCONFIRMED, PAYMENT_PLAN_BILLING_ENGINE_UNAVAILABLE, IDEMPOTENCY_REQUEST_INCOMPLETE)"},"children":[]}]}]}]}],"pointer":"/paths/~1payment-plans/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PaymentPlanPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"402"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"422"},{"code":"500"},{"code":"502"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/paymentplanscontroller_createpaymentplan"}],"panels":[]}]},"httpPath":"/payment-plans"},{"label":"List payment plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-plans/paymentplanscontroller_listpaymentplans","routeSlug":"/developer-guide/api/payment-plans/paymentplanscontroller_listpaymentplans","metadata":{"seo":{"title":"List payment plans","description":"List payment plans"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentPlansController_listPaymentPlans","name":"List payment plans","isWebhook":false,"pointer":"/paths/~1payment-plans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_1"},{"name":"page","in":"query","schemaId":"schema_2"},{"name":"take","in":"query","schemaId":"schema_3"}],"pointer":"/paths/~1payment-plans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-plans","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_1"},{"name":"page","in":"query","required":false,"schemaId":"schema_2"},{"name":"take","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403"],"pointer":"/payment-plans","href":"payment-plans/paymentplanscontroller_listpaymentplans","openApiOperationId":"PaymentPlansController_listPaymentPlans","summary":"List payment plans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A page of payment plans","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}},"schemaId":"schema_23"},{"code":"400","description":"Missing apiKey header, invalid apiKey format, or a malformed search parameter"},{"code":"401","description":"Invalid API key"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Plans are not enabled for this account (PAYMENT_PLANS_NOT_ENABLED)"},"children":[]}]}]}]}],"pointer":"/paths/~1payment-plans/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_23","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}}},{"code":"400"},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/paymentplanscontroller_listpaymentplans"}],"panels":[]}]},"httpPath":"/payment-plans"},{"label":"Pay a payment plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-plans/paymentplanscontroller_createpaymentplanpayment","routeSlug":"/developer-guide/api/payment-plans/paymentplanscontroller_createpaymentplanpayment","metadata":{"seo":{"title":"Pay a payment plan","description":"Charges a stored payment method, records a payment collected elsewhere (external: true), or takes the payment on one of your registered Dejavoo terminals (payment_method: { \"type\": \"terminal\", \"terminal_id\": \"the terminal id\" }, secret key only, Dejavoo plans only). A terminal payment answers 201 with status processing and a terminal object in state in_flight while the customer pays at the terminal; poll GET /payment-plans/{id}/payments/{payment_id} until status is final."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentPlansController_createPaymentPlanPayment","name":"Pay a payment plan","isWebhook":false,"pointer":"/paths/~1payment-plans~1{id}~1payments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pay a payment plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charges a stored payment method, records a payment collected elsewhere (external: true), or takes the payment on one of your registered Dejavoo terminals (payment_method: { \"type\": \"terminal\", \"terminal_id\": \"the terminal id\" }, secret key only, Dejavoo plans only). A terminal payment answers 201 with status processing and a terminal object in state in_flight while the customer pays at the terminal; poll GET /payment-plans/{id}/payments/{payment_id} until status is final."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_24","required":true}],"pointer":"/paths/~1payment-plans~1{id}~1payments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0"}],"pointer":"/paths/~1payment-plans~1{id}~1payments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePaymentPlanPaymentPublicDto"}},"schemaId":"components/schemas/CreatePaymentPlanPaymentPublicDto","pointer":"/paths/~1payment-plans~1{id}~1payments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-plans/{id}/payments","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_24"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePaymentPlanPaymentPublicDto"}},"responseCodes":["201","400","401","402","403","404","409","422","502","503"],"pointer":"/payment-plans/{id}/payments","href":"payment-plans/paymentplanscontroller_createpaymentplanpayment","openApiOperationId":"PaymentPlansController_createPaymentPlanPayment","summary":"Pay a payment plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreatePaymentPlanPaymentPublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePaymentPlanPaymentPublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPaymentPublicDto"}},"schemaId":"components/schemas/PaymentPlanPaymentPublicDto"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request (PAYMENT_PLAN_AMOUNT_INVALID, PAYMENT_PLAN_AMOUNT_EXCEEDS_BALANCE, PAYMENT_METHOD_REQUIRED, PAYMENT_PLAN_TERMINAL_EXTERNAL_NOT_ALLOWED, IDEMPOTENCY_KEY_INVALID). A payment_method that is neither a payment method id nor { \"type\": \"terminal\", \"terminal_id\": \"the terminal id\" } is rejected with 400 and no error code."},"children":[]}]}]}]},{"code":"401","description":"Invalid API key"},{"code":"402","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first charge was declined (PAYMENT_DECLINED). Nothing is applied."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLANS_NOT_ENABLED: Payment Plans are not enabled for this account. SECRET_API_KEY_REQUIRED: a publishable (pk_) key was presented with a terminal payment_method."},"children":[]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment plan, payment method or terminal not found (PAYMENT_PLAN_NOT_FOUND, PAYMENT_METHOD_NOT_FOUND, DEJAVOO_TERMINAL_NOT_FOUND)"},"children":[]}]}]}]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment plan is not payable right now (PAYMENT_PLAN_PAYMENT_METHOD_NOT_SUPPORTED, PAYMENT_PLAN_NOT_PAYABLE, PAYMENT_PLAN_BUSY, PAYMENT_PLAN_INSTALLMENT_BILLING_IN_PROGRESS, PAYMENT_PLAN_PAYMENT_PENDING_CONFIRMATION, PAYMENT_PLAN_REPLAN_PENDING, PAYMENT_PLAN_PAYMENT_NOT_ATTEMPTED, PAYMENT_PLAN_TERMINAL_NOT_SUPPORTED, PAYMENT_PLAN_TERMINAL_ATTEMPTS_EXHAUSTED, DEJAVOO_TERMINAL_DISABLED, DEJAVOO_TERMINAL_BUSY, DEJAVOO_TERMINAL_OFFLINE, SPIN_AUTH_KEY_UNREADABLE, IDEMPOTENCY_KEY_IN_PROGRESS). An Authorization header on a terminal payment answers 409 with no code: that payment authenticates with cc-api-key only."},"children":[]}]}]}]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDEMPOTENCY_KEY_REUSED: the Idempotency-Key was already used with a different request. SPIN_CREDENTIALS_REJECTED: SPIn did not accept the terminal TPN and Auth Key. DEJAVOO_TERMINAL_ISV_ID_INVALID: the terminal isv_id is not 1 to 16 characters as SPIn requires."},"children":[]}]}]}]},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment's outcome could not be confirmed or the billing engine could not be read (PAYMENT_PLAN_PAYMENT_UNCONFIRMED, PAYMENT_PLAN_BILLING_ENGINE_UNAVAILABLE, IDEMPOTENCY_REQUEST_INCOMPLETE)"},"children":[]}]}]}]},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_UNREACHABLE: SPIn could not be reached to verify the terminal"},"children":[]}]}]}]}],"pointer":"/paths/~1payment-plans~1{id}~1payments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PaymentPlanPaymentPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPaymentPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"402"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"422"},{"code":"502"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/paymentplanscontroller_createpaymentplanpayment"}],"panels":[]}]},"httpPath":"/payment-plans/{id}/payments"},{"label":"Retrieve a payment plan payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-plans/paymentplanscontroller_retrievepaymentplanpayment","routeSlug":"/developer-guide/api/payment-plans/paymentplanscontroller_retrievepaymentplanpayment","metadata":{"seo":{"title":"Retrieve a payment plan payment","description":"Retrieve a payment plan payment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentPlansController_retrievePaymentPlanPayment","name":"Retrieve a payment plan payment","isWebhook":false,"pointer":"/paths/~1payment-plans~1{id}~1payments~1{payment_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment plan payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_24","required":true},{"name":"payment_id","in":"path","schemaId":"schema_24","required":true}],"pointer":"/paths/~1payment-plans~1{id}~1payments~1{payment_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-plans/{id}/payments/{payment_id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_24"},{"name":"payment_id","in":"path","required":true,"schemaId":"schema_24"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404"],"pointer":"/payment-plans/{id}/payments/{payment_id}","href":"payment-plans/paymentplanscontroller_retrievepaymentplanpayment","openApiOperationId":"PaymentPlansController_retrievePaymentPlanPayment","summary":"Retrieve a payment plan payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPaymentPublicDto"}},"schemaId":"components/schemas/PaymentPlanPaymentPublicDto"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing apiKey header, invalid apiKey format, or a malformed payment_id"},"children":[]}]}]}]},{"code":"401","description":"Invalid API key"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Plans are not enabled for this account (PAYMENT_PLANS_NOT_ENABLED)"},"children":[]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment plan or payment not found (PAYMENT_PLAN_NOT_FOUND, PAYMENT_PLAN_PAYMENT_NOT_FOUND)"},"children":[]}]}]}]}],"pointer":"/paths/~1payment-plans~1{id}~1payments~1{payment_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentPlanPaymentPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPaymentPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/paymentplanscontroller_retrievepaymentplanpayment"}],"panels":[]}]},"httpPath":"/payment-plans/{id}/payments/{payment_id}"},{"label":"Resolve a terminal payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-plans/paymentplanscontroller_resolveterminalpayment","routeSlug":"/developer-guide/api/payment-plans/paymentplanscontroller_resolveterminalpayment","metadata":{"seo":{"title":"Resolve a terminal payment","description":"Continues a terminal payment whose outcome is not known yet (terminal.state resolving) or whose approval was not recorded yet (approved_no_credential, or a payment still processing), and answers 200 with the payment. Call it again while the payment is processing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentPlansController_resolveTerminalPayment","name":"Resolve a terminal payment","isWebhook":false,"pointer":"/paths/~1payment-plans~1{id}~1payments~1{payment_id}~1resolve/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resolve a terminal payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Continues a terminal payment whose outcome is not known yet (terminal.state resolving) or whose approval was not recorded yet (approved_no_credential, or a payment still processing), and answers 200 with the payment. Call it again while the payment is processing."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_24","required":true},{"name":"payment_id","in":"path","schemaId":"schema_24","required":true}],"pointer":"/paths/~1payment-plans~1{id}~1payments~1{payment_id}~1resolve/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chaching SECRET API key (sk_...)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payment-plans~1{id}~1payments~1{payment_id}~1resolve/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmptyDepositBodyPublicDto"}},"schemaId":"components/schemas/EmptyDepositBodyPublicDto","pointer":"/paths/~1payment-plans~1{id}~1payments~1{payment_id}~1resolve/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-plans/{id}/payments/{payment_id}/resolve","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_24"},{"name":"payment_id","in":"path","required":true,"schemaId":"schema_24"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/EmptyDepositBodyPublicDto"}},"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/payment-plans/{id}/payments/{payment_id}/resolve","href":"payment-plans/paymentplanscontroller_resolveterminalpayment","openApiOperationId":"PaymentPlansController_resolveTerminalPayment","summary":"Resolve a terminal payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/EmptyDepositBodyPublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmptyDepositBodyPublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment after the resolution attempt","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPaymentPublicDto"}},"schemaId":"components/schemas/PaymentPlanPaymentPublicDto"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing apiKey header, invalid apiKey format, a malformed payment_id, or a body with a property"},"children":[]}]}]}]},{"code":"401","description":"Invalid API key"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLANS_NOT_ENABLED: Payment Plans are not enabled for this account. SECRET_API_KEY_REQUIRED: a publishable (pk_) key was presented."},"children":[]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLAN_NOT_FOUND: the plan is not on this account. PAYMENT_PLAN_PAYMENT_NOT_FOUND: the payment is not on this plan."},"children":[]}]}]}]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLAN_PAYMENT_NOT_TERMINAL (the payment was not taken on a terminal), PAYMENT_PLAN_TERMINAL_PAYMENT_IN_FLIGHT (the customer is still at the terminal), PAYMENT_PLAN_BUSY, SPIN_AUTH_KEY_UNREADABLE. An Authorization header answers 409 with no code: this route authenticates with cc-api-key only."},"children":[]}]}]}]},{"code":"500","description":"Unexpected error"}],"pointer":"/paths/~1payment-plans~1{id}~1payments~1{payment_id}~1resolve/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentPlanPaymentPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPaymentPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/paymentplanscontroller_resolveterminalpayment"}],"panels":[]}]},"httpPath":"/payment-plans/{id}/payments/{payment_id}/resolve"},{"label":"Cancel the terminal sale of a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-plans/paymentplanscontroller_cancelterminalpayment","routeSlug":"/developer-guide/api/payment-plans/paymentplanscontroller_cancelterminalpayment","metadata":{"seo":{"title":"Cancel the terminal sale of a payment","description":"Asks the terminal to cancel the sale that is waiting for the customer and answers 202 with the payment. The sale ends cancelled when the terminal reports the cancellation; poll GET /payment-plans/{id}/payments/{payment_id}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentPlansController_cancelTerminalPayment","name":"Cancel the terminal sale of a payment","isWebhook":false,"pointer":"/paths/~1payment-plans~1{id}~1payments~1{payment_id}~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel the terminal sale of a payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asks the terminal to cancel the sale that is waiting for the customer and answers 202 with the payment. The sale ends cancelled when the terminal reports the cancellation; poll GET /payment-plans/{id}/payments/{payment_id}."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_24","required":true},{"name":"payment_id","in":"path","schemaId":"schema_24","required":true}],"pointer":"/paths/~1payment-plans~1{id}~1payments~1{payment_id}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chaching SECRET API key (sk_...)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payment-plans~1{id}~1payments~1{payment_id}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmptyDepositBodyPublicDto"}},"schemaId":"components/schemas/EmptyDepositBodyPublicDto","pointer":"/paths/~1payment-plans~1{id}~1payments~1{payment_id}~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-plans/{id}/payments/{payment_id}/cancel","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_24"},{"name":"payment_id","in":"path","required":true,"schemaId":"schema_24"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/EmptyDepositBodyPublicDto"}},"responseCodes":["202","400","401","403","404","409","500"],"pointer":"/payment-plans/{id}/payments/{payment_id}/cancel","href":"payment-plans/paymentplanscontroller_cancelterminalpayment","openApiOperationId":"PaymentPlansController_cancelTerminalPayment","summary":"Cancel the terminal sale of a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/EmptyDepositBodyPublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmptyDepositBodyPublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The cancellation was requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPaymentPublicDto"}},"schemaId":"components/schemas/PaymentPlanPaymentPublicDto"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing apiKey header, invalid apiKey format, a malformed payment_id, or a body with a property"},"children":[]}]}]}]},{"code":"401","description":"Invalid API key"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLANS_NOT_ENABLED: Payment Plans are not enabled for this account. SECRET_API_KEY_REQUIRED: a publishable (pk_) key was presented."},"children":[]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLAN_NOT_FOUND: the plan is not on this account. PAYMENT_PLAN_PAYMENT_NOT_FOUND: the payment is not on this plan."},"children":[]}]}]}]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLAN_PAYMENT_NOT_TERMINAL (the payment was not taken on a terminal), PAYMENT_PLAN_TERMINAL_PAYMENT_NOT_IN_FLIGHT (no sale of this payment is waiting at the terminal), SPIN_AUTH_KEY_UNREADABLE. An Authorization header answers 409 with no code: this route authenticates with cc-api-key only."},"children":[]}]}]}]},{"code":"500","description":"Unexpected error"}],"pointer":"/paths/~1payment-plans~1{id}~1payments~1{payment_id}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/PaymentPlanPaymentPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPaymentPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/paymentplanscontroller_cancelterminalpayment"}],"panels":[]}]},"httpPath":"/payment-plans/{id}/payments/{payment_id}/cancel"},{"label":"Retrieve a payment plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-plans/paymentplanscontroller_retrievepaymentplan","routeSlug":"/developer-guide/api/payment-plans/paymentplanscontroller_retrievepaymentplan","metadata":{"seo":{"title":"Retrieve a payment plan","description":"Retrieve a payment plan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentPlansController_retrievePaymentPlan","name":"Retrieve a payment plan","isWebhook":false,"pointer":"/paths/~1payment-plans~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_24","required":true}],"pointer":"/paths/~1payment-plans~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-plans/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_24"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404"],"pointer":"/payment-plans/{id}","href":"payment-plans/paymentplanscontroller_retrievepaymentplan","openApiOperationId":"PaymentPlansController_retrievePaymentPlan","summary":"Retrieve a payment plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPublicDto"}},"schemaId":"components/schemas/PaymentPlanPublicDto"},{"code":"401","description":"Invalid API key"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Plans are not enabled for this account (PAYMENT_PLANS_NOT_ENABLED)"},"children":[]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment plan not found (PAYMENT_PLAN_NOT_FOUND)"},"children":[]}]}]}]}],"pointer":"/paths/~1payment-plans~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentPlanPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPublicDto"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/paymentplanscontroller_retrievepaymentplan"}],"panels":[]}]},"httpPath":"/payment-plans/{id}"},{"label":"List a payment plan installments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-plans/paymentplanscontroller_listinstallments","routeSlug":"/developer-guide/api/payment-plans/paymentplanscontroller_listinstallments","metadata":{"seo":{"title":"List a payment plan installments","description":"List a payment plan installments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentPlansController_listInstallments","name":"List a payment plan installments","isWebhook":false,"pointer":"/paths/~1payment-plans~1{id}~1installments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a payment plan installments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_24","required":true}],"pointer":"/paths/~1payment-plans~1{id}~1installments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_1"},{"name":"page","in":"query","schemaId":"schema_2"},{"name":"take","in":"query","schemaId":"schema_3"}],"pointer":"/paths/~1payment-plans~1{id}~1installments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-plans/{id}/installments","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_24"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_1"},{"name":"page","in":"query","required":false,"schemaId":"schema_2"},{"name":"take","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404"],"pointer":"/payment-plans/{id}/installments","href":"payment-plans/paymentplanscontroller_listinstallments","openApiOperationId":"PaymentPlansController_listInstallments","summary":"List a payment plan installments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A page of installments, ascending by sequence","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25"},{"code":"401","description":"Invalid API key"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Plans are not enabled for this account (PAYMENT_PLANS_NOT_ENABLED)"},"children":[]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment plan not found (PAYMENT_PLAN_NOT_FOUND)"},"children":[]}]}]}]}],"pointer":"/paths/~1payment-plans~1{id}~1installments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/paymentplanscontroller_listinstallments"}],"panels":[]}]},"httpPath":"/payment-plans/{id}/installments"},{"label":"Cancel a payment plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-plans/paymentplanscontroller_cancelpaymentplan","routeSlug":"/developer-guide/api/payment-plans/paymentplanscontroller_cancelpaymentplan","metadata":{"seo":{"title":"Cancel a payment plan","description":"Cancel a payment plan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentPlansController_cancelPaymentPlan","name":"Cancel a payment plan","isWebhook":false,"pointer":"/paths/~1payment-plans~1{id}~1cancel/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a payment plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_24","required":true}],"pointer":"/paths/~1payment-plans~1{id}~1cancel/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-plans/{id}/cancel","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_24"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","409","502"],"pointer":"/payment-plans/{id}/cancel","href":"payment-plans/paymentplanscontroller_cancelpaymentplan","openApiOperationId":"PaymentPlansController_cancelPaymentPlan","summary":"Cancel a payment plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The canceled payment plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPublicDto"}},"schemaId":"components/schemas/PaymentPlanPublicDto"},{"code":"401","description":"Invalid API key"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Plans are not enabled for this account (PAYMENT_PLANS_NOT_ENABLED)"},"children":[]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment plan not found (PAYMENT_PLAN_NOT_FOUND)"},"children":[]}]}]}]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment plan cannot be canceled (PAYMENT_PLAN_NOT_CANCELABLE, PAYMENT_PLAN_BUSY, PAYMENT_PLAN_DEPOSIT_IN_FLIGHT while a terminal deposit attempt is unresolved: resolve it with POST /payment-plans/{id}/deposit first; PAYMENT_PLAN_PAYMENT_PENDING_CONFIRMATION while a terminal payment is unresolved: resolve it with POST /payment-plans/{id}/payments/{payment_id}/resolve before canceling the plan)"},"children":[]}]}]}]},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing engine did not complete the cancellation (PAYMENT_PLAN_CANCEL_INCOMPLETE). The plan keeps its status and installments, part of its schedule can already be stopped, and repeating the request completes the rest."},"children":[]}]}]}]}],"pointer":"/paths/~1payment-plans~1{id}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentPlanPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPublicDto"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"502"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/paymentplanscontroller_cancelpaymentplan"}],"panels":[]}]},"httpPath":"/payment-plans/{id}/cancel"},{"label":"Start a terminal deposit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-plans/paymentplanscontroller_startterminaldeposit","routeSlug":"/developer-guide/api/payment-plans/paymentplanscontroller_startterminaldeposit","metadata":{"seo":{"title":"Start a terminal deposit","description":"Sends installment 1 of a payment plan created without a payment method to a registered Dejavoo terminal and answers 202 with the payment plan. The customer pays at the terminal; poll GET /payment-plans/{id} and read deposit.attempt.state until it is final. When the card is approved the plan is activated and the card is saved for the remaining installments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentPlansController_startTerminalDeposit","name":"Start a terminal deposit","isWebhook":false,"pointer":"/paths/~1payment-plans~1{id}~1deposit~1terminal/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start a terminal deposit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends installment 1 of a payment plan created without a payment method to a registered Dejavoo terminal and answers 202 with the payment plan. The customer pays at the terminal; poll GET /payment-plans/{id} and read deposit.attempt.state until it is final. When the card is approved the plan is activated and the card is saved for the remaining installments."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_24","required":true}],"pointer":"/paths/~1payment-plans~1{id}~1deposit~1terminal/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chaching SECRET API key (sk_...)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payment-plans~1{id}~1deposit~1terminal/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StartTerminalDepositPublicDto"}},"schemaId":"components/schemas/StartTerminalDepositPublicDto","pointer":"/paths/~1payment-plans~1{id}~1deposit~1terminal/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-plans/{id}/deposit/terminal","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_24"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/StartTerminalDepositPublicDto"}},"responseCodes":["202","400","401","403","404","409","422","500","503"],"pointer":"/payment-plans/{id}/deposit/terminal","href":"payment-plans/paymentplanscontroller_startterminaldeposit","openApiOperationId":"PaymentPlansController_startTerminalDeposit","summary":"Start a terminal deposit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/StartTerminalDepositPublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StartTerminalDepositPublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deposit attempt was started; deposit.attempt.state is in_flight"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPublicDto"}},"schemaId":"components/schemas/PaymentPlanPublicDto"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing apiKey header, invalid apiKey format, or a body that is not exactly { terminal_id } with a UUID v4 value"},"children":[]}]}]}]},{"code":"401","description":"Invalid API key"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLANS_NOT_ENABLED: Payment Plans are not enabled for this account. SECRET_API_KEY_REQUIRED: a publishable (pk_) key was presented."},"children":[]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLAN_NOT_FOUND: the plan is not on this account. DEJAVOO_TERMINAL_NOT_FOUND: the terminal is not on this account."},"children":[]}]}]}]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deposit cannot start: PAYMENT_PLAN_NOT_AWAITING_DEPOSIT, PAYMENT_PLAN_DEPOSIT_IN_FLIGHT, PAYMENT_PLAN_BUSY, PAYMENT_PLAN_DEPOSIT_ATTEMPTS_EXHAUSTED, DEJAVOO_TERMINAL_DISABLED, DEJAVOO_TERMINAL_BUSY, DEJAVOO_TERMINAL_OFFLINE, SPIN_AUTH_KEY_UNREADABLE. An Authorization header answers 409 with no code: this route authenticates with cc-api-key only."},"children":[]}]}]}]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_CREDENTIALS_REJECTED: SPIn did not accept the terminal TPN and Auth Key. DEJAVOO_TERMINAL_ISV_ID_INVALID: the terminal isv_id is not 1 to 16 characters as SPIn requires."},"children":[]}]}]}]},{"code":"500","description":"Unexpected error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_UNREACHABLE: SPIn could not be reached to verify the terminal"},"children":[]}]}]}]}],"pointer":"/paths/~1payment-plans~1{id}~1deposit~1terminal/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/PaymentPlanPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"422"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/paymentplanscontroller_startterminaldeposit"}],"panels":[]}]},"httpPath":"/payment-plans/{id}/deposit/terminal"},{"label":"Resolve a terminal deposit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-plans/paymentplanscontroller_resolvedeposit","routeSlug":"/developer-guide/api/payment-plans/paymentplanscontroller_resolvedeposit","metadata":{"seo":{"title":"Resolve a terminal deposit","description":"Continues a terminal deposit whose outcome is not known yet (deposit.attempt.state resolving) or whose card was charged but not saved (approved_no_credential), and answers 200 with the payment plan. Call it again while the state is not final."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentPlansController_resolveDeposit","name":"Resolve a terminal deposit","isWebhook":false,"pointer":"/paths/~1payment-plans~1{id}~1deposit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resolve a terminal deposit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Continues a terminal deposit whose outcome is not known yet (deposit.attempt.state resolving) or whose card was charged but not saved (approved_no_credential), and answers 200 with the payment plan. Call it again while the state is not final."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_24","required":true}],"pointer":"/paths/~1payment-plans~1{id}~1deposit/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chaching SECRET API key (sk_...)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payment-plans~1{id}~1deposit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmptyDepositBodyPublicDto"}},"schemaId":"components/schemas/EmptyDepositBodyPublicDto","pointer":"/paths/~1payment-plans~1{id}~1deposit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-plans/{id}/deposit","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_24"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/EmptyDepositBodyPublicDto"}},"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/payment-plans/{id}/deposit","href":"payment-plans/paymentplanscontroller_resolvedeposit","openApiOperationId":"PaymentPlansController_resolveDeposit","summary":"Resolve a terminal deposit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/EmptyDepositBodyPublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmptyDepositBodyPublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment plan after the resolution attempt","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPublicDto"}},"schemaId":"components/schemas/PaymentPlanPublicDto"},{"code":"400","description":"Missing apiKey header, invalid apiKey format, or a body with a property"},{"code":"401","description":"Invalid API key"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLANS_NOT_ENABLED: Payment Plans are not enabled for this account. SECRET_API_KEY_REQUIRED: a publishable (pk_) key was presented."},"children":[]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLAN_NOT_FOUND: the plan is not on this account."},"children":[]}]}]}]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLAN_NOT_AWAITING_DEPOSIT (the plan is no longer awaiting a deposit; no vendor request is made), PAYMENT_PLAN_DEPOSIT_NO_ATTEMPT, PAYMENT_PLAN_DEPOSIT_IN_FLIGHT (the customer is still at the terminal), PAYMENT_PLAN_BUSY, SPIN_AUTH_KEY_UNREADABLE. An Authorization header answers 409 with no code: this route authenticates with cc-api-key only."},"children":[]}]}]}]},{"code":"500","description":"Unexpected error"}],"pointer":"/paths/~1payment-plans~1{id}~1deposit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentPlanPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/paymentplanscontroller_resolvedeposit"}],"panels":[]}]},"httpPath":"/payment-plans/{id}/deposit"},{"label":"Cancel a terminal deposit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-plans/paymentplanscontroller_cancelterminaldeposit","routeSlug":"/developer-guide/api/payment-plans/paymentplanscontroller_cancelterminaldeposit","metadata":{"seo":{"title":"Cancel a terminal deposit","description":"Asks the terminal to cancel the sale that is waiting for the customer and answers 202 with the payment plan. The attempt ends cancelled when the terminal reports the cancellation; poll GET /payment-plans/{id}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PaymentPlansController_cancelTerminalDeposit","name":"Cancel a terminal deposit","isWebhook":false,"pointer":"/paths/~1payment-plans~1{id}~1deposit~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a terminal deposit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asks the terminal to cancel the sale that is waiting for the customer and answers 202 with the payment plan. The attempt ends cancelled when the terminal reports the cancellation; poll GET /payment-plans/{id}."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_24","required":true}],"pointer":"/paths/~1payment-plans~1{id}~1deposit~1cancel/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chaching SECRET API key (sk_...)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payment-plans~1{id}~1deposit~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmptyDepositBodyPublicDto"}},"schemaId":"components/schemas/EmptyDepositBodyPublicDto","pointer":"/paths/~1payment-plans~1{id}~1deposit~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-plans/{id}/deposit/cancel","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_24"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/EmptyDepositBodyPublicDto"}},"responseCodes":["202","400","401","403","404","409","500"],"pointer":"/payment-plans/{id}/deposit/cancel","href":"payment-plans/paymentplanscontroller_cancelterminaldeposit","openApiOperationId":"PaymentPlansController_cancelTerminalDeposit","summary":"Cancel a terminal deposit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/EmptyDepositBodyPublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmptyDepositBodyPublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The cancellation was requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPublicDto"}},"schemaId":"components/schemas/PaymentPlanPublicDto"},{"code":"400","description":"Missing apiKey header, invalid apiKey format, or a body with a property"},{"code":"401","description":"Invalid API key"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLANS_NOT_ENABLED: Payment Plans are not enabled for this account. SECRET_API_KEY_REQUIRED: a publishable (pk_) key was presented."},"children":[]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLAN_NOT_FOUND: the plan is not on this account."},"children":[]}]}]}]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_PLAN_DEPOSIT_NOT_IN_FLIGHT (no sale is waiting at the terminal), SPIN_AUTH_KEY_UNREADABLE. An Authorization header answers 409 with no code: this route authenticates with cc-api-key only."},"children":[]}]}]}]},{"code":"500","description":"Unexpected error"}],"pointer":"/paths/~1payment-plans~1{id}~1deposit~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/PaymentPlanPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentPlanPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-plans/paymentplanscontroller_cancelterminaldeposit"}],"panels":[]}]},"httpPath":"/payment-plans/{id}/deposit/cancel"}],"content":{"contentType":"group","meta":{"name":"Payment Plans"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Plans","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Plans let a customer pay off a total amount in fixed installments charged automatically to a card on file. A plan created without a payment method collects installment 1 on a registered Dejavoo terminal and stores that card for the remaining installments. This surface is gated per account and is off by default — contact Chaching to enable it."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payment-plans","summary":"Create a payment plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-plans/paymentplanscontroller_createpaymentplan","deprecated":false},{"title":"/payment-plans","summary":"List payment plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-plans/paymentplanscontroller_listpaymentplans","deprecated":false},{"title":"/payment-plans/{id}/payments","summary":"Pay a payment plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-plans/paymentplanscontroller_createpaymentplanpayment","deprecated":false},{"title":"/payment-plans/{id}/payments/{payment_id}","summary":"Retrieve a payment plan payment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-plans/paymentplanscontroller_retrievepaymentplanpayment","deprecated":false},{"title":"/payment-plans/{id}/payments/{payment_id}/resolve","summary":"Resolve a terminal payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-plans/paymentplanscontroller_resolveterminalpayment","deprecated":false},{"title":"/payment-plans/{id}/payments/{payment_id}/cancel","summary":"Cancel the terminal sale of a payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-plans/paymentplanscontroller_cancelterminalpayment","deprecated":false},{"title":"/payment-plans/{id}","summary":"Retrieve a payment plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-plans/paymentplanscontroller_retrievepaymentplan","deprecated":false},{"title":"/payment-plans/{id}/installments","summary":"List a payment plan installments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-plans/paymentplanscontroller_listinstallments","deprecated":false},{"title":"/payment-plans/{id}/cancel","summary":"Cancel a payment plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-plans/paymentplanscontroller_cancelpaymentplan","deprecated":false},{"title":"/payment-plans/{id}/deposit/terminal","summary":"Start a terminal deposit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-plans/paymentplanscontroller_startterminaldeposit","deprecated":false},{"title":"/payment-plans/{id}/deposit","summary":"Resolve a terminal deposit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-plans/paymentplanscontroller_resolvedeposit","deprecated":false},{"title":"/payment-plans/{id}/deposit/cancel","summary":"Cancel a terminal deposit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-plans/paymentplanscontroller_cancelterminaldeposit","deprecated":false}]}]}]}]}},{"type":"group","label":"Dejavoo Terminals","link":"/developer-guide/api/dejavoo-terminals","routeSlug":"/developer-guide/api/dejavoo-terminals","items":[{"label":"List Dejavoo terminals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/dejavoo-terminals/dejavooterminalscontroller_listterminals","routeSlug":"/developer-guide/api/dejavoo-terminals/dejavooterminalscontroller_listterminals","metadata":{"seo":{"title":"List Dejavoo terminals","description":"Lists every terminal registered on the account, enabled and disabled. The Auth Key is never returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DejavooTerminalsController_listTerminals","name":"List Dejavoo terminals","isWebhook":false,"pointer":"/paths/~1dejavoo~1terminals/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Dejavoo terminals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists every terminal registered on the account, enabled and disabled. The Auth Key is never returned."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chaching SECRET API key (sk_...)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1dejavoo~1terminals/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/dejavoo/terminals","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","409"],"pointer":"/dejavoo/terminals","href":"dejavoo-terminals/dejavooterminalscontroller_listterminals","openApiOperationId":"DejavooTerminalsController_listTerminals","summary":"List Dejavoo terminals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The terminals of the account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DejavooTerminalListPublicDto"}},"schemaId":"components/schemas/DejavooTerminalListPublicDto"},{"code":"400","description":"Missing apiKey header or invalid apiKey format"},{"code":"401","description":"Invalid API key"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECRET_API_KEY_REQUIRED: a publishable (pk_) key was presented."},"children":[]}]}]}]},{"code":"409","description":"This route authenticates with cc-api-key only; remove the Authorization header"}],"pointer":"/paths/~1dejavoo~1terminals/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DejavooTerminalListPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DejavooTerminalListPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dejavoo-terminals/dejavooterminalscontroller_listterminals"}],"panels":[]}]},"httpPath":"/dejavoo/terminals"},{"label":"Register a Dejavoo terminal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/dejavoo-terminals/dejavooterminalscontroller_registerterminal","routeSlug":"/developer-guide/api/dejavoo-terminals/dejavooterminalscontroller_registerterminal","metadata":{"seo":{"title":"Register a Dejavoo terminal","description":"Registers a terminal by its own TPN and 10-character SPIn Auth Key. Chaching checks the pair with SPIn before saving it; a pair SPIn does not accept is never stored. The Auth Key is write-only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DejavooTerminalsController_registerTerminal","name":"Register a Dejavoo terminal","isWebhook":false,"pointer":"/paths/~1dejavoo~1terminals/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register a Dejavoo terminal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Registers a terminal by its own TPN and 10-character SPIn Auth Key. Chaching checks the pair with SPIn before saving it; a pair SPIn does not accept is never stored. The Auth Key is write-only."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chaching SECRET API key (sk_...)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1dejavoo~1terminals/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDejavooTerminalPublicDto"}},"schemaId":"components/schemas/CreateDejavooTerminalPublicDto","pointer":"/paths/~1dejavoo~1terminals/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/dejavoo/terminals","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateDejavooTerminalPublicDto"}},"responseCodes":["201","400","401","403","409","422","503"],"pointer":"/dejavoo/terminals","href":"dejavoo-terminals/dejavooterminalscontroller_registerterminal","openApiOperationId":"DejavooTerminalsController_registerTerminal","summary":"Register a Dejavoo terminal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateDejavooTerminalPublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDejavooTerminalPublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The registered terminal","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DejavooTerminalPublicDto"}},"schemaId":"components/schemas/DejavooTerminalPublicDto"},{"code":"400","description":"Missing apiKey header; invalid apiKey format; invalid request body."},{"code":"401","description":"Invalid API key"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECRET_API_KEY_REQUIRED: a publishable (pk_) key was presented."},"children":[]}]}]}]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEJAVOO_NOT_CONFIGURED (the account has no 12-digit e-commerce TPN); TERMINAL_TPN_EXISTS (the TPN is already registered on the account); or an Authorization header was sent."},"children":[]}]}]}]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_CREDENTIALS_REJECTED: SPIn did not accept the TPN and Auth Key."},"children":[]}]}]}]},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_UNREACHABLE: SPIn could not be reached; nothing was saved."},"children":[]}]}]}]}],"pointer":"/paths/~1dejavoo~1terminals/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/DejavooTerminalPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DejavooTerminalPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"409"},{"code":"422"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dejavoo-terminals/dejavooterminalscontroller_registerterminal"}],"panels":[]}]},"httpPath":"/dejavoo/terminals"},{"label":"Update a Dejavoo terminal","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/dejavoo-terminals/dejavooterminalscontroller_updateterminal","routeSlug":"/developer-guide/api/dejavoo-terminals/dejavooterminalscontroller_updateterminal","metadata":{"seo":{"title":"Update a Dejavoo terminal","description":"Relabels, enables or disables a terminal, re-enters its Auth Key, or updates its Register / ISV ids and FEED request record. Re-entering the Auth Key and enabling a disabled terminal re-check the credential with SPIn first. Terminals are disabled, never deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DejavooTerminalsController_updateTerminal","name":"Update a Dejavoo terminal","isWebhook":false,"pointer":"/paths/~1dejavoo~1terminals~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Dejavoo terminal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Relabels, enables or disables a terminal, re-enters its Auth Key, or updates its Register / ISV ids and FEED request record. Re-entering the Auth Key and enabling a disabled terminal re-check the credential with SPIn first. Terminals are disabled, never deleted."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1dejavoo~1terminals~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"cc-api-key","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chaching SECRET API key (sk_...)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1dejavoo~1terminals~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDejavooTerminalPublicDto"}},"schemaId":"components/schemas/UpdateDejavooTerminalPublicDto","pointer":"/paths/~1dejavoo~1terminals~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/dejavoo/terminals/{id}","servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"cc-api-key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateDejavooTerminalPublicDto"}},"responseCodes":["200","400","401","403","404","409","422","503"],"pointer":"/dejavoo/terminals/{id}","href":"dejavoo-terminals/dejavooterminalscontroller_updateterminal","openApiOperationId":"DejavooTerminalsController_updateTerminal","summary":"Update a Dejavoo terminal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/developer-guide/api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateDejavooTerminalPublicDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDejavooTerminalPublicDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The updated terminal","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DejavooTerminalPublicDto"}},"schemaId":"components/schemas/DejavooTerminalPublicDto"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing apiKey header; invalid apiKey format; invalid request body or id; DEJAVOO_TERMINAL_UPDATE_EMPTY (no updatable key sent)."},"children":[]}]}]}]},{"code":"401","description":"Invalid API key"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECRET_API_KEY_REQUIRED: a publishable (pk_) key was presented."},"children":[]}]}]}]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEJAVOO_TERMINAL_NOT_FOUND: no such terminal on this account."},"children":[]}]}]}]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_AUTH_KEY_UNREADABLE (the stored Auth Key cannot be read); or an Authorization header was sent."},"children":[]}]}]}]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_CREDENTIALS_REJECTED: SPIn did not accept the TPN and Auth Key."},"children":[]}]}]}]},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPIN_UNREACHABLE: SPIn could not be reached; nothing was changed."},"children":[]}]}]}]}],"pointer":"/paths/~1dejavoo~1terminals~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DejavooTerminalPublicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DejavooTerminalPublicDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"422"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dejavoo-terminals/dejavooterminalscontroller_updateterminal"}],"panels":[]}]},"httpPath":"/dejavoo/terminals/{id}"}],"content":{"contentType":"group","meta":{"name":"Dejavoo Terminals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dejavoo Terminals","showPageActions":true},{"nodeType":"markdoc","content":"Dejavoo Terminals are the physical Dejavoo payment terminals of your account, each addressed by its own TPN and driven over SPIn. Register a terminal with its TPN and its 10-character SPIn Auth Key; Chaching checks the pair with SPIn before saving it. The Auth Key is write-only: it is never returned. Terminals are disabled, never deleted."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/dejavoo/terminals","summary":"List Dejavoo terminals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dejavoo-terminals/dejavooterminalscontroller_listterminals","deprecated":false},{"title":"/dejavoo/terminals","summary":"Register a Dejavoo terminal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dejavoo-terminals/dejavooterminalscontroller_registerterminal","deprecated":false},{"title":"/dejavoo/terminals/{id}","summary":"Update a Dejavoo terminal","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/dejavoo-terminals/dejavooterminalscontroller_updateterminal","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","properties":{"city":{"type":"string","description":"City, district, suburb, town, or village.","example":"San Francisco"},"country":{"type":"string","description":"Two-letter country code(ISO 3166 - 1 alpha - 2).","example":"US"},"line1":{"type":"string","description":"Address line 1(e.g., street, PO Box, or company name).","example":"123 Market St"},"line2":{"type":"string","description":"Address line 2(e.g., apartment, suite, unit, or building).","example":"Apt 4B"},"postal_code":{"type":"string","description":"ZIP or postal code.","example":"94103"},"state":{"type":"string","description":"State, county, province, or region.","example":"CA"}}}},"components/schemas/Shipping":{"id":"components/schemas/Shipping","kind":"json-schema","title":"Shipping","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the recipient.","example":"John Doe"},"phone":{"type":"string","description":"The phone number of the recipient.","example":"+1 (555) 123-4567"},"address":{"description":"The address of the recipient.","allOf":[{"$ref":"#/components/schemas/Address"}]}},"required":["name","phone","address"]}},"components/schemas/CustomersCreatePublicDto":{"id":"components/schemas/CustomersCreatePublicDto","kind":"json-schema","title":"CustomersCreatePublicDto","data":{"type":"object","properties":{"name":{"type":"string","description":"The full name or business name of the customer.","example":"John Doe"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer’s email address."},"children":[]}]}]}],"example":"john.doe@example.com"},"description":{"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users.","example":"My First Test Customer"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer’s phone number."},"children":[]}]}]}],"example":null},"currency":{"type":"string","description":"Three-letter ISO currency code","example":"USD"},"address":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer’s address."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/Address"}},"shipping":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer’s shipping information. Appears on invoices emailed to this customer."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/Shipping"}]}},"required":["name"]}},"components/schemas/CustomersPublicDto":{"id":"components/schemas/CustomersPublicDto","kind":"json-schema","title":"CustomersPublicDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the object.","example":"cus_NffrFeUfNV2Hib"},"object":{"type":"string","description":"The type of the object.","example":"customer"},"name":{"type":"string","description":"The full name or business name of the customer.","example":"John Doe"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer’s email address."},"children":[]}]}]}],"example":"john.doe@example.com"},"description":{"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users.","example":"My First Test Customer"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer’s phone number."},"children":[]}]}]}],"example":null},"created":{"type":"number","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","example":1680893993},"currency":{"type":"string","description":"Three-letter ISO currency code","example":"USD"},"address":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer’s address."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/Address"}},"shipping":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer’s shipping information. Appears on invoices emailed to this customer."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/Shipping"}]}},"required":["id","object","name","created"]}},"components/schemas/CustomerPublicOutputDto":{"id":"components/schemas/CustomerPublicOutputDto","kind":"json-schema","title":"CustomerPublicOutputDto","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"}},"required":["id","name","email"]}},"components/schemas/BillingAddressDto":{"id":"components/schemas/BillingAddressDto","kind":"json-schema","title":"BillingAddressDto","data":{"type":"object","properties":{"email":{"type":"string","maxLength":128,"format":"email"},"address1":{"type":"string","maxLength":100},"address2":{"type":"string","maxLength":100},"postalCode":{"type":"string","maxLength":16},"city":{"type":"string","maxLength":50},"country":{"type":"string","maxLength":50},"state":{"type":"string","maxLength":50},"phone":{"type":"string","maxLength":25}}}},"components/schemas/ShippingAddressDto":{"id":"components/schemas/ShippingAddressDto","kind":"json-schema","title":"ShippingAddressDto","data":{"type":"object","properties":{"shippingAddress1":{"type":"string","maxLength":100},"shippingAddress2":{"type":"string","maxLength":100},"shippingPostalCode":{"type":"string","maxLength":16},"shippingCity":{"type":"string","maxLength":50},"shippingCountry":{"type":"string","maxLength":50},"shippingState":{"type":"string","maxLength":50},"shippingPhone":{"type":"string","maxLength":25}}}},"components/schemas/UpdateCustomerDto":{"id":"components/schemas/UpdateCustomerDto","kind":"json-schema","title":"UpdateCustomerDto","data":{"type":"object","properties":{"email":{"type":"string","maxLength":128,"format":"email"},"name":{"type":"string","maxLength":100},"billingAddress":{"$ref":"#/components/schemas/BillingAddressDto"},"shippingAddress":{"$ref":"#/components/schemas/ShippingAddressDto"}}}},"components/schemas/PageMetaDto":{"id":"components/schemas/PageMetaDto","kind":"json-schema","title":"PageMetaDto","data":{"type":"object","properties":{"page":{"type":"number"},"take":{"type":"number"},"itemsTotal":{"type":"number"},"pagesTotal":{"type":"number"}},"required":["page","take","itemsTotal","pagesTotal"]}},"components/schemas/PageDto":{"id":"components/schemas/PageDto","kind":"json-schema","title":"PageDto","data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"array"}},"meta":{"$ref":"#/components/schemas/PageMetaDto"}},"required":["data","meta"]}},"components/schemas/PaymentMethodCardPublicDto":{"id":"components/schemas/PaymentMethodCardPublicDto","kind":"json-schema","title":"PaymentMethodCardPublicDto","data":{"type":"object","properties":{"brand":{"type":"string","nullable":true,"example":"visa","description":"Card brand (lowercase)."},"last4":{"type":"string","nullable":true,"example":"4242","description":"Last 4 digits of the card."},"walletType":{"type":"string","example":"apple_pay","description":"Wallet that vaulted the card, when the payment method originated from Apple Pay or Google Pay. Null for directly entered cards.","enum":["apple_pay","google_pay"],"nullable":true}}}},"components/schemas/PaymentMethodAddressDto":{"id":"components/schemas/PaymentMethodAddressDto","kind":"json-schema","title":"PaymentMethodAddressDto","data":{"type":"object","properties":{"city":{"type":"string","nullable":true,"example":null,"description":"City of the billing address."},"country":{"type":"string","nullable":true,"example":null,"description":"Country of the billing address."},"line1":{"type":"string","nullable":true,"example":null,"description":"Street line 1 of the billing address."},"line2":{"type":"string","nullable":true,"example":null,"description":"Street line 2 of the billing address."},"postal_code":{"type":"string","nullable":true,"example":null,"description":"Postal or ZIP code."},"state":{"type":"string","nullable":true,"example":null,"description":"State or province."}}}},"components/schemas/PaymentMethodBillingDetailsDto":{"id":"components/schemas/PaymentMethodBillingDetailsDto","kind":"json-schema","title":"PaymentMethodBillingDetailsDto","data":{"type":"object","properties":{"address":{"description":"Billing address associated with the payment method.","allOf":[{"$ref":"#/components/schemas/PaymentMethodAddressDto"}]},"email":{"type":"string","nullable":true,"example":null,"description":"Billing email address."},"name":{"type":"string","nullable":true,"example":"John Doe","description":"Full name of the account owner."},"phone":{"type":"string","nullable":true,"example":null,"description":"Owner phone number."}},"required":["address","name"]}},"components/schemas/PaymentMethodNetworksDto":{"id":"components/schemas/PaymentMethodNetworksDto","kind":"json-schema","title":"PaymentMethodNetworksDto","data":{"type":"object","properties":{"preferred":{"type":"string","example":"ach","description":"Preferred bank transfer network."},"supported":{"example":["ach"],"description":"List of supported bank transfer networks.","type":"array","items":{"type":"string"}}},"required":["preferred","supported"]}},"components/schemas/PaymentMethodUsBankAccountDto":{"id":"components/schemas/PaymentMethodUsBankAccountDto","kind":"json-schema","title":"PaymentMethodUsBankAccountDto","data":{"type":"object","properties":{"account_holder_type":{"type":"string","example":"individual","description":"Type of account holder."},"account_type":{"type":"string","example":"checking","description":"Bank account type."},"bank_name":{"type":"string","example":"STRIPE TEST BANK","description":"Name of the bank."},"financial_connections_account":{"type":"string","nullable":true,"example":null,"description":"Financial connections account reference if available."},"fingerprint":{"type":"string","example":"LstWJFsCK7P349Bg","description":"Stripe fingerprint identifying the bank account."},"last4":{"type":"string","example":"6789","description":"Last 4 digits of the bank account."},"networks":{"description":"Supported and preferred bank transfer networks.","allOf":[{"$ref":"#/components/schemas/PaymentMethodNetworksDto"}]},"routing_number":{"type":"string","example":"110000000","description":"Bank routing number."},"status_details":{"type":"object","example":{},"description":"Additional status details if available."}},"required":["account_holder_type","account_type","bank_name","fingerprint","last4","networks","routing_number","status_details"]}},"components/schemas/PaymentMethodPublicDto":{"id":"components/schemas/PaymentMethodPublicDto","kind":"json-schema","title":"PaymentMethodPublicDto","data":{"type":"object","properties":{"id":{"type":"string","example":"pm_1Q0PsIJvEtkwdCNYMSaVuRz6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique, gateway-native identifier for the payment method: the Stripe payment-method id (pm_...) for Stripe-gateway accounts, and the Kill Bill payment-method id (a UUID) for NMI-gateway and Dejavoo-gateway accounts."},"children":[]}]}]}]},"card":{"description":"Card details when the payment method is a card (NMI, Stripe or Dejavoo).","allOf":[{"$ref":"#/components/schemas/PaymentMethodCardPublicDto"}]},"object":{"type":"string","example":"payment_method","description":"Type of Stripe object."},"allow_redisplay":{"type":"string","example":"unspecified","description":"Controls whether the payment method can be redisplayed."},"billing_details":{"description":"Billing details associated with the payment method.","allOf":[{"$ref":"#/components/schemas/PaymentMethodBillingDetailsDto"}]},"created":{"type":"number","example":1726673582,"description":"Unix timestamp when the payment method was created."},"customer":{"type":"string","nullable":true,"example":null,"description":"ID of the attached customer, if any."},"livemode":{"type":"boolean","example":false,"description":"Indicates if the object exists in live mode."},"metadata":{"type":"object","example":{},"description":"Set of key-value pairs for storing additional information."},"type":{"type":"string","example":"us_bank_account","description":"Payment method type."},"us_bank_account":{"description":"US bank account details if the payment method is a bank account.","allOf":[{"$ref":"#/components/schemas/PaymentMethodUsBankAccountDto"}]}},"required":["id","object","allow_redisplay","billing_details","created","livemode","metadata","type"]}},"components/schemas/ProductPublicDto":{"id":"components/schemas/ProductPublicDto","kind":"json-schema","title":"ProductPublicDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the object.","example":"prod_xT4LfvxLMQb4s9uFNIbXf9pm","format":"string"},"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object’s type."},"children":[]}]}]}],"example":"product","enum":["product"],"default":"product"},"active":{"type":"boolean","description":"Indicates whether the object is active.","example":true},"created":{"type":"number","description":"Time at which the object was created. Measured in seconds since the Unix epoch","example":1760018761,"minimum":0},"default_price":{"type":"string","nullable":true,"description":"The ID of the Price object that is the default price for this product.","example":"price_1SGKTmDZYOQH9uHk1vaSxPKa","format":"string"},"description":{"type":"string","nullable":true,"description":"Customer-facing description.","example":null,"maxLength":255},"name":{"type":"string","description":"The name of the product.","example":"Gold Plan","minLength":1,"maxLength":100},"tax_code":{"type":"string","default":"txcd_00000000","description":"The tax code for the product.","example":"txcd_10000000","pattern":"^txcd_[a-zA-Z0-9]+$"},"updated":{"type":"number","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","example":1753181495,"minimum":0,"nullable":true}},"required":["id","object","active","created","name","updated"]}},"components/schemas/RecurringInput":{"id":"components/schemas/RecurringInput","kind":"json-schema","title":"RecurringInput","data":{"type":"object","properties":{"interval":{"type":"string","enum":["day","week","month","year"],"description":"Billing frequency","example":"month"},"interval_count":{"type":"number","minimum":1,"maximum":365,"description":"Number of intervals between billings","example":1,"default":1}},"required":["interval","interval_count"]}},"components/schemas/PriceTypeEnum":{"id":"components/schemas/PriceTypeEnum","kind":"json-schema","title":"PriceTypeEnum","data":{"type":"string","enum":["recurring","one_time"],"description":"Price type"}},"components/schemas/CreateProductPublicDto":{"id":"components/schemas/CreateProductPublicDto","kind":"json-schema","title":"CreateProductPublicDto","data":{"type":"object","properties":{"currency":{"type":"string","enum":["USD"],"description":"Three-letter ISO currency code","example":"USD"},"description":{"type":"string","description":"Customer-facing price description","example":"Premium Plan - Monthly","maxLength":255},"recurring":{"nullable":true,"description":"Recurring components of the price","allOf":[{"$ref":"#/components/schemas/RecurringInput"}]},"tax_behavior":{"type":"string","default":"exclusive","enum":["exclusive","inclusive"],"description":"Tax calculation behavior","example":"exclusive"},"type":{"description":"Price type","example":"one_time","allOf":[{"$ref":"#/components/schemas/PriceTypeEnum"}]},"unit_amount":{"type":"number","minimum":0,"maximum":99999999,"description":"Unit amount in cents","example":1000},"name":{"type":"string","description":"The product name.","example":"premium_plan","minLength":1,"maxLength":100},"tax_code":{"type":"string","default":"txcd_00000000","enum":["txcd_99999999","txcd_20030000","txcd_10000000","txcd_00000000","txcd_10010001","txcd_10101000","txcd_10102000","txcd_10102001","txcd_10103000","txcd_10103001","txcd_10103100","txcd_10103101","txcd_10104001","txcd_10201000","txcd_10201001","txcd_10201002","txcd_10201003","txcd_10201004","txcd_10202000","txcd_10202001","txcd_10202003","txcd_10203000","txcd_10203001","txcd_10301000","txcd_10302000","txcd_10302001","txcd_10302002","txcd_10302003","txcd_10303000","txcd_10303001","txcd_10303002","txcd_10303100","txcd_10303101","txcd_10303102","txcd_10303104","txcd_10304000","txcd_10304001","txcd_10304002","txcd_10304003","txcd_10304100","txcd_10304101","txcd_10304102","txcd_10305000","txcd_10305001","txcd_10401000","txcd_10401001","txcd_10401100","txcd_10401200","txcd_10402000","txcd_10402100","txcd_10402110","txcd_10402200","txcd_10402300","txcd_10501000","txcd_10502000","txcd_10503000","txcd_10503001","txcd_10503002","txcd_10503003","txcd_10503004","txcd_10503005","txcd_10504000","txcd_10504003","txcd_10505000","txcd_10505001","txcd_10505002","txcd_10506000","txcd_10506001","txcd_10506002","txcd_10701000","txcd_10701100","txcd_10701200","txcd_10701300","txcd_10701400","txcd_10701401","txcd_10701410","txcd_10701411","txcd_10702000","txcd_10804001","txcd_10804002","txcd_10804003","txcd_10804010","txcd_20010001","txcd_20010003","txcd_20010004","txcd_20010006","txcd_20010007","txcd_20020009","txcd_20020010","txcd_20020018","txcd_20030002","txcd_20030003","txcd_20030004","txcd_20030005","txcd_20040001","txcd_20040002","txcd_20040003","txcd_20040004","txcd_20040005","txcd_20040006","txcd_20040007","txcd_20040008","txcd_20040009","txcd_20040010","txcd_20040011","txcd_20060000","txcd_20060001","txcd_20060002","txcd_20060008","txcd_20060009","txcd_20060010","txcd_20060013","txcd_20060017","txcd_20060021","txcd_20060022","txcd_20060026","txcd_20060027","txcd_20060029","txcd_20060030","txcd_20060035","txcd_20060040","txcd_20060042","txcd_20060044","txcd_20060045","txcd_20060047","txcd_20060048","txcd_20060049","txcd_20060050","txcd_20060051","txcd_20060052","txcd_20060053","txcd_20060054","txcd_20060055","txcd_20060056","txcd_20060057","txcd_20060058","txcd_20060059","txcd_20070001","txcd_20070006","txcd_20070007","txcd_20070008","txcd_20070010","txcd_20070013","txcd_20070016","txcd_20080003","txcd_20080004","txcd_20080005","txcd_20080007","txcd_20080008","txcd_20080009","txcd_20080010","txcd_20080011","txcd_20080012","txcd_20080013","txcd_20090001","txcd_20090002","txcd_20090003","txcd_20090004","txcd_20090006","txcd_20090010","txcd_20090012","txcd_20090015","txcd_20090018","txcd_20090022","txcd_20090023","txcd_20090024","txcd_20090025","txcd_20090026","txcd_20090027","txcd_20090028","txcd_20090029","txcd_20090030","txcd_20090031","txcd_20090032","txcd_20091000","txcd_20091001","txcd_20091002","txcd_20091003","txcd_20091004","txcd_20091005","txcd_20100001","txcd_30011000","txcd_30011002","txcd_30011003","txcd_30011015","txcd_30011020","txcd_30011028","txcd_30011034","txcd_30011045","txcd_30011100","txcd_30011200","txcd_30011201","txcd_30021000","txcd_30021001","txcd_30021200","txcd_30030001","txcd_30031004","txcd_30031041","txcd_30031404","txcd_30031405","txcd_30031406","txcd_30031407","txcd_30031408","txcd_30031409","txcd_30040003","txcd_30040005","txcd_30040006","txcd_30051302","txcd_30060001","txcd_30060004","txcd_30060005","txcd_30060006","txcd_30060007","txcd_30060010","txcd_30060011","txcd_30060013","txcd_30060014","txcd_30060015","txcd_30060016","txcd_30060017","txcd_30060018","txcd_30060019","txcd_30060020","txcd_30060021","txcd_30060101","txcd_30070001","txcd_30070002","txcd_30070003","txcd_30070004","txcd_30070005","txcd_30070006","txcd_30070007","txcd_30070008","txcd_30070009","txcd_30070010","txcd_30070011","txcd_30070012","txcd_30070013","txcd_30070014","txcd_30070015","txcd_30070017","txcd_30070018","txcd_30070019","txcd_30070020","txcd_30070021","txcd_30070022","txcd_30070023","txcd_30070024","txcd_30070025","txcd_30070026","txcd_30070028","txcd_30070029","txcd_30071000","txcd_30080001","txcd_30080002","txcd_30090005","txcd_30090009","txcd_30090010","txcd_31020001","txcd_31020002","txcd_31020003","txcd_31030001","txcd_31030003","txcd_31031202","txcd_31031203","txcd_31031204","txcd_31031205","txcd_31040001","txcd_31040002","txcd_31070001","txcd_32010001","txcd_32010002","txcd_32010003","txcd_32010004","txcd_32020001","txcd_32020002","txcd_32020003","txcd_32020004","txcd_32020005","txcd_32020006","txcd_32020011","txcd_32030001","txcd_32030002","txcd_32030003","txcd_32030004","txcd_32030005","txcd_32030006","txcd_32030007","txcd_32030008","txcd_32030009","txcd_32030010","txcd_32040002","txcd_32040003","txcd_32040004","txcd_32040005","txcd_32050001","txcd_32050005","txcd_32050006","txcd_32050007","txcd_32050009","txcd_32050012","txcd_32050013","txcd_32050014","txcd_32050015","txcd_32050017","txcd_32050018","txcd_32050019","txcd_32050020","txcd_32050021","txcd_32050022","txcd_32050023","txcd_32050024","txcd_32050025","txcd_32050026","txcd_32050027","txcd_32050028","txcd_32050029","txcd_32050030","txcd_32050031","txcd_32050032","txcd_32050033","txcd_32050034","txcd_32050035","txcd_32050036","txcd_32050037","txcd_32050038","txcd_32050039","txcd_32050040","txcd_32050041","txcd_32060001","txcd_32060002","txcd_32060007","txcd_32060012","txcd_32060017","txcd_32060018","txcd_32060023","txcd_32060024","txcd_32060025","txcd_32060026","txcd_32070003","txcd_32070004","txcd_32070018","txcd_32070019","txcd_32070020","txcd_32070028","txcd_32070029","txcd_32070030","txcd_32070031","txcd_32070032","txcd_32070033","txcd_32070034","txcd_32070035","txcd_32070036","txcd_32070037","txcd_32070038","txcd_32070039","txcd_32070040","txcd_32070041","txcd_32070042","txcd_32080001","txcd_32080003","txcd_32080004","txcd_32080005","txcd_32090003","txcd_32090005","txcd_32090006","txcd_32090007","txcd_32090008","txcd_32090013","txcd_32090014","txcd_32090015","txcd_32090016","txcd_32090017","txcd_32090018","txcd_32100001","txcd_32100002","txcd_32100003","txcd_32100004","txcd_32100005","txcd_32100006","txcd_32100007","txcd_32100008","txcd_32100010","txcd_32100011","txcd_32100012","txcd_32100013","txcd_33020001","txcd_33020002","txcd_33020003","txcd_33020004","txcd_33020005","txcd_33020006","txcd_33020007","txcd_33020008","txcd_33020009","txcd_33020010","txcd_33020011","txcd_33020012","txcd_33020013","txcd_33020014","txcd_33020200","txcd_33030001","txcd_33031001","txcd_33080201","txcd_33080202","txcd_33080300","txcd_33080301","txcd_33080302","txcd_33080303","txcd_33080304","txcd_33080305","txcd_33080306","txcd_33080400","txcd_33100001","txcd_33100101","txcd_33100200","txcd_33110001","txcd_33110002","txcd_33110003","txcd_33110004","txcd_33110005","txcd_33120000","txcd_33120001","txcd_33120002","txcd_33120003","txcd_33120004","txcd_33120005","txcd_33120006","txcd_33120007","txcd_33120008","txcd_33120009","txcd_33120010","txcd_33120011","txcd_33120012","txcd_33120013","txcd_33120014","txcd_33120015","txcd_33120016","txcd_33120017","txcd_33120018","txcd_33120019","txcd_33150001","txcd_33150002","txcd_33150003","txcd_33150004","txcd_33150005","txcd_33150006","txcd_34010001","txcd_34010002","txcd_34010003","txcd_34020001","txcd_34020002","txcd_34020003","txcd_34020004","txcd_34020005","txcd_34020006","txcd_34020027","txcd_34021000","txcd_34021001","txcd_34022000","txcd_34022001","txcd_34040001","txcd_34040002","txcd_34040003","txcd_34040004","txcd_34040005","txcd_34040006","txcd_34040007","txcd_34040008","txcd_34040009","txcd_34040010","txcd_34040011","txcd_34040012","txcd_34040013","txcd_34040014","txcd_34040015","txcd_34040016","txcd_34040017","txcd_34040018","txcd_35010000","txcd_35010001","txcd_35010400","txcd_35010410","txcd_35010500","txcd_35020100","txcd_35020200","txcd_35020220","txcd_36010001","txcd_36010002","txcd_36010003","txcd_36010004","txcd_36010005","txcd_36010006","txcd_36010007","txcd_37010000","txcd_37010003","txcd_37010036","txcd_37030002","txcd_37030003","txcd_37040001","txcd_37050001","txcd_37060001","txcd_37060002","txcd_37060003","txcd_37060008","txcd_37060009","txcd_37060010","txcd_37060011","txcd_37060012","txcd_37060013","txcd_37060035","txcd_37060045","txcd_37060046","txcd_37070001","txcd_37070002","txcd_37071001","txcd_37071002","txcd_37071003","txcd_37071006","txcd_37071007","txcd_37071009","txcd_37071010","txcd_37071011","txcd_37071014","txcd_37071015","txcd_37071101","txcd_37071103","txcd_37071104","txcd_37071106","txcd_40010000","txcd_40010001","txcd_40010002","txcd_40020002","txcd_40020004","txcd_40020005","txcd_40020006","txcd_40020007","txcd_40020008","txcd_40040000","txcd_40040003","txcd_40040004","txcd_40040009","txcd_40040010","txcd_40040013","txcd_40040016","txcd_40040017","txcd_40040019","txcd_40040020","txcd_40040021","txcd_40040022","txcd_40050003","txcd_40050004","txcd_40050005","txcd_40050006","txcd_40050007","txcd_40050008","txcd_40050009","txcd_40050010","txcd_40051001","txcd_40051002","txcd_40051003","txcd_40051004","txcd_40060003","txcd_40070001","txcd_40070002","txcd_40070005","txcd_40070006","txcd_40070007","txcd_40090001","txcd_40090002","txcd_40090005","txcd_40090008","txcd_40100001","txcd_40100002","txcd_40100003","txcd_40100004","txcd_40100010","txcd_40100011","txcd_40400005","txcd_41020001","txcd_41020002","txcd_41020003","txcd_41030001","txcd_41030002","txcd_41030003","txcd_41040002","txcd_41040003","txcd_41040004","txcd_41040005","txcd_41040008","txcd_41040009","txcd_41040010","txcd_41040011","txcd_41040012","txcd_41040013","txcd_41040014","txcd_41040015","txcd_41040016","txcd_41040017","txcd_41040018","txcd_41040019","txcd_41040020","txcd_41040021","txcd_41040022","txcd_41040023","txcd_41040024","txcd_41040025","txcd_41040026","txcd_41040027","txcd_41040028","txcd_41040029","txcd_41040030","txcd_41050001","txcd_41050002","txcd_41050003","txcd_41050004","txcd_41050005","txcd_41050006","txcd_41050007","txcd_41050008","txcd_41051001","txcd_41051002","txcd_41052001","txcd_41053001","txcd_41053002","txcd_41054001","txcd_41054002","txcd_41060003","txcd_41060006","txcd_50021001","txcd_50021002","txcd_50021003","txcd_50021101","txcd_50021103","txcd_90000001","txcd_90020001","txcd_92010001"],"description":"The tax category for this product","example":"txcd_10000000","nullable":true,"pattern":"^txcd_[a-zA-Z0-9]+$"}},"required":["currency","tax_behavior","type","unit_amount","name"]}},"components/schemas/UpdateProductPublicDto":{"id":"components/schemas/UpdateProductPublicDto","kind":"json-schema","title":"UpdateProductPublicDto","data":{"type":"object","properties":{"description":{"type":"string","description":"Customer-facing product description","example":"Product description","maxLength":255},"name":{"type":"string","description":"The product name.","example":"Music","minLength":1,"maxLength":100},"tax_code":{"type":"string","default":"txcd_00000000","enum":["txcd_99999999","txcd_20030000","txcd_10000000","txcd_00000000","txcd_10010001","txcd_10101000","txcd_10102000","txcd_10102001","txcd_10103000","txcd_10103001","txcd_10103100","txcd_10103101","txcd_10104001","txcd_10201000","txcd_10201001","txcd_10201002","txcd_10201003","txcd_10201004","txcd_10202000","txcd_10202001","txcd_10202003","txcd_10203000","txcd_10203001","txcd_10301000","txcd_10302000","txcd_10302001","txcd_10302002","txcd_10302003","txcd_10303000","txcd_10303001","txcd_10303002","txcd_10303100","txcd_10303101","txcd_10303102","txcd_10303104","txcd_10304000","txcd_10304001","txcd_10304002","txcd_10304003","txcd_10304100","txcd_10304101","txcd_10304102","txcd_10305000","txcd_10305001","txcd_10401000","txcd_10401001","txcd_10401100","txcd_10401200","txcd_10402000","txcd_10402100","txcd_10402110","txcd_10402200","txcd_10402300","txcd_10501000","txcd_10502000","txcd_10503000","txcd_10503001","txcd_10503002","txcd_10503003","txcd_10503004","txcd_10503005","txcd_10504000","txcd_10504003","txcd_10505000","txcd_10505001","txcd_10505002","txcd_10506000","txcd_10506001","txcd_10506002","txcd_10701000","txcd_10701100","txcd_10701200","txcd_10701300","txcd_10701400","txcd_10701401","txcd_10701410","txcd_10701411","txcd_10702000","txcd_10804001","txcd_10804002","txcd_10804003","txcd_10804010","txcd_20010001","txcd_20010003","txcd_20010004","txcd_20010006","txcd_20010007","txcd_20020009","txcd_20020010","txcd_20020018","txcd_20030002","txcd_20030003","txcd_20030004","txcd_20030005","txcd_20040001","txcd_20040002","txcd_20040003","txcd_20040004","txcd_20040005","txcd_20040006","txcd_20040007","txcd_20040008","txcd_20040009","txcd_20040010","txcd_20040011","txcd_20060000","txcd_20060001","txcd_20060002","txcd_20060008","txcd_20060009","txcd_20060010","txcd_20060013","txcd_20060017","txcd_20060021","txcd_20060022","txcd_20060026","txcd_20060027","txcd_20060029","txcd_20060030","txcd_20060035","txcd_20060040","txcd_20060042","txcd_20060044","txcd_20060045","txcd_20060047","txcd_20060048","txcd_20060049","txcd_20060050","txcd_20060051","txcd_20060052","txcd_20060053","txcd_20060054","txcd_20060055","txcd_20060056","txcd_20060057","txcd_20060058","txcd_20060059","txcd_20070001","txcd_20070006","txcd_20070007","txcd_20070008","txcd_20070010","txcd_20070013","txcd_20070016","txcd_20080003","txcd_20080004","txcd_20080005","txcd_20080007","txcd_20080008","txcd_20080009","txcd_20080010","txcd_20080011","txcd_20080012","txcd_20080013","txcd_20090001","txcd_20090002","txcd_20090003","txcd_20090004","txcd_20090006","txcd_20090010","txcd_20090012","txcd_20090015","txcd_20090018","txcd_20090022","txcd_20090023","txcd_20090024","txcd_20090025","txcd_20090026","txcd_20090027","txcd_20090028","txcd_20090029","txcd_20090030","txcd_20090031","txcd_20090032","txcd_20091000","txcd_20091001","txcd_20091002","txcd_20091003","txcd_20091004","txcd_20091005","txcd_20100001","txcd_30011000","txcd_30011002","txcd_30011003","txcd_30011015","txcd_30011020","txcd_30011028","txcd_30011034","txcd_30011045","txcd_30011100","txcd_30011200","txcd_30011201","txcd_30021000","txcd_30021001","txcd_30021200","txcd_30030001","txcd_30031004","txcd_30031041","txcd_30031404","txcd_30031405","txcd_30031406","txcd_30031407","txcd_30031408","txcd_30031409","txcd_30040003","txcd_30040005","txcd_30040006","txcd_30051302","txcd_30060001","txcd_30060004","txcd_30060005","txcd_30060006","txcd_30060007","txcd_30060010","txcd_30060011","txcd_30060013","txcd_30060014","txcd_30060015","txcd_30060016","txcd_30060017","txcd_30060018","txcd_30060019","txcd_30060020","txcd_30060021","txcd_30060101","txcd_30070001","txcd_30070002","txcd_30070003","txcd_30070004","txcd_30070005","txcd_30070006","txcd_30070007","txcd_30070008","txcd_30070009","txcd_30070010","txcd_30070011","txcd_30070012","txcd_30070013","txcd_30070014","txcd_30070015","txcd_30070017","txcd_30070018","txcd_30070019","txcd_30070020","txcd_30070021","txcd_30070022","txcd_30070023","txcd_30070024","txcd_30070025","txcd_30070026","txcd_30070028","txcd_30070029","txcd_30071000","txcd_30080001","txcd_30080002","txcd_30090005","txcd_30090009","txcd_30090010","txcd_31020001","txcd_31020002","txcd_31020003","txcd_31030001","txcd_31030003","txcd_31031202","txcd_31031203","txcd_31031204","txcd_31031205","txcd_31040001","txcd_31040002","txcd_31070001","txcd_32010001","txcd_32010002","txcd_32010003","txcd_32010004","txcd_32020001","txcd_32020002","txcd_32020003","txcd_32020004","txcd_32020005","txcd_32020006","txcd_32020011","txcd_32030001","txcd_32030002","txcd_32030003","txcd_32030004","txcd_32030005","txcd_32030006","txcd_32030007","txcd_32030008","txcd_32030009","txcd_32030010","txcd_32040002","txcd_32040003","txcd_32040004","txcd_32040005","txcd_32050001","txcd_32050005","txcd_32050006","txcd_32050007","txcd_32050009","txcd_32050012","txcd_32050013","txcd_32050014","txcd_32050015","txcd_32050017","txcd_32050018","txcd_32050019","txcd_32050020","txcd_32050021","txcd_32050022","txcd_32050023","txcd_32050024","txcd_32050025","txcd_32050026","txcd_32050027","txcd_32050028","txcd_32050029","txcd_32050030","txcd_32050031","txcd_32050032","txcd_32050033","txcd_32050034","txcd_32050035","txcd_32050036","txcd_32050037","txcd_32050038","txcd_32050039","txcd_32050040","txcd_32050041","txcd_32060001","txcd_32060002","txcd_32060007","txcd_32060012","txcd_32060017","txcd_32060018","txcd_32060023","txcd_32060024","txcd_32060025","txcd_32060026","txcd_32070003","txcd_32070004","txcd_32070018","txcd_32070019","txcd_32070020","txcd_32070028","txcd_32070029","txcd_32070030","txcd_32070031","txcd_32070032","txcd_32070033","txcd_32070034","txcd_32070035","txcd_32070036","txcd_32070037","txcd_32070038","txcd_32070039","txcd_32070040","txcd_32070041","txcd_32070042","txcd_32080001","txcd_32080003","txcd_32080004","txcd_32080005","txcd_32090003","txcd_32090005","txcd_32090006","txcd_32090007","txcd_32090008","txcd_32090013","txcd_32090014","txcd_32090015","txcd_32090016","txcd_32090017","txcd_32090018","txcd_32100001","txcd_32100002","txcd_32100003","txcd_32100004","txcd_32100005","txcd_32100006","txcd_32100007","txcd_32100008","txcd_32100010","txcd_32100011","txcd_32100012","txcd_32100013","txcd_33020001","txcd_33020002","txcd_33020003","txcd_33020004","txcd_33020005","txcd_33020006","txcd_33020007","txcd_33020008","txcd_33020009","txcd_33020010","txcd_33020011","txcd_33020012","txcd_33020013","txcd_33020014","txcd_33020200","txcd_33030001","txcd_33031001","txcd_33080201","txcd_33080202","txcd_33080300","txcd_33080301","txcd_33080302","txcd_33080303","txcd_33080304","txcd_33080305","txcd_33080306","txcd_33080400","txcd_33100001","txcd_33100101","txcd_33100200","txcd_33110001","txcd_33110002","txcd_33110003","txcd_33110004","txcd_33110005","txcd_33120000","txcd_33120001","txcd_33120002","txcd_33120003","txcd_33120004","txcd_33120005","txcd_33120006","txcd_33120007","txcd_33120008","txcd_33120009","txcd_33120010","txcd_33120011","txcd_33120012","txcd_33120013","txcd_33120014","txcd_33120015","txcd_33120016","txcd_33120017","txcd_33120018","txcd_33120019","txcd_33150001","txcd_33150002","txcd_33150003","txcd_33150004","txcd_33150005","txcd_33150006","txcd_34010001","txcd_34010002","txcd_34010003","txcd_34020001","txcd_34020002","txcd_34020003","txcd_34020004","txcd_34020005","txcd_34020006","txcd_34020027","txcd_34021000","txcd_34021001","txcd_34022000","txcd_34022001","txcd_34040001","txcd_34040002","txcd_34040003","txcd_34040004","txcd_34040005","txcd_34040006","txcd_34040007","txcd_34040008","txcd_34040009","txcd_34040010","txcd_34040011","txcd_34040012","txcd_34040013","txcd_34040014","txcd_34040015","txcd_34040016","txcd_34040017","txcd_34040018","txcd_35010000","txcd_35010001","txcd_35010400","txcd_35010410","txcd_35010500","txcd_35020100","txcd_35020200","txcd_35020220","txcd_36010001","txcd_36010002","txcd_36010003","txcd_36010004","txcd_36010005","txcd_36010006","txcd_36010007","txcd_37010000","txcd_37010003","txcd_37010036","txcd_37030002","txcd_37030003","txcd_37040001","txcd_37050001","txcd_37060001","txcd_37060002","txcd_37060003","txcd_37060008","txcd_37060009","txcd_37060010","txcd_37060011","txcd_37060012","txcd_37060013","txcd_37060035","txcd_37060045","txcd_37060046","txcd_37070001","txcd_37070002","txcd_37071001","txcd_37071002","txcd_37071003","txcd_37071006","txcd_37071007","txcd_37071009","txcd_37071010","txcd_37071011","txcd_37071014","txcd_37071015","txcd_37071101","txcd_37071103","txcd_37071104","txcd_37071106","txcd_40010000","txcd_40010001","txcd_40010002","txcd_40020002","txcd_40020004","txcd_40020005","txcd_40020006","txcd_40020007","txcd_40020008","txcd_40040000","txcd_40040003","txcd_40040004","txcd_40040009","txcd_40040010","txcd_40040013","txcd_40040016","txcd_40040017","txcd_40040019","txcd_40040020","txcd_40040021","txcd_40040022","txcd_40050003","txcd_40050004","txcd_40050005","txcd_40050006","txcd_40050007","txcd_40050008","txcd_40050009","txcd_40050010","txcd_40051001","txcd_40051002","txcd_40051003","txcd_40051004","txcd_40060003","txcd_40070001","txcd_40070002","txcd_40070005","txcd_40070006","txcd_40070007","txcd_40090001","txcd_40090002","txcd_40090005","txcd_40090008","txcd_40100001","txcd_40100002","txcd_40100003","txcd_40100004","txcd_40100010","txcd_40100011","txcd_40400005","txcd_41020001","txcd_41020002","txcd_41020003","txcd_41030001","txcd_41030002","txcd_41030003","txcd_41040002","txcd_41040003","txcd_41040004","txcd_41040005","txcd_41040008","txcd_41040009","txcd_41040010","txcd_41040011","txcd_41040012","txcd_41040013","txcd_41040014","txcd_41040015","txcd_41040016","txcd_41040017","txcd_41040018","txcd_41040019","txcd_41040020","txcd_41040021","txcd_41040022","txcd_41040023","txcd_41040024","txcd_41040025","txcd_41040026","txcd_41040027","txcd_41040028","txcd_41040029","txcd_41040030","txcd_41050001","txcd_41050002","txcd_41050003","txcd_41050004","txcd_41050005","txcd_41050006","txcd_41050007","txcd_41050008","txcd_41051001","txcd_41051002","txcd_41052001","txcd_41053001","txcd_41053002","txcd_41054001","txcd_41054002","txcd_41060003","txcd_41060006","txcd_50021001","txcd_50021002","txcd_50021003","txcd_50021101","txcd_50021103","txcd_90000001","txcd_90020001","txcd_92010001"],"description":"The tax category for this product","example":"txcd_10000000","nullable":true,"pattern":"^txcd_[a-zA-Z0-9]+$"}},"required":["name"]}},"components/schemas/TransactionPublicDto":{"id":"components/schemas/TransactionPublicDto","kind":"json-schema","title":"TransactionPublicDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the object.","example":"txn_1MiN3gLkdIwHu7ixxapQrznl"},"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object’s type."},"children":[]}]}]}],"example":"balance_transaction"},"amount":{"type":"number","description":"Gross amount of this transaction (in cents).","example":-400},"surcharge_amount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card surcharge the gateway added to this charge (in cents). 0 when none was added. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the amount requested and never includes it."},"children":[]}]}]}],"example":3},"amount_charged":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total charged to the card (in cents): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus the surcharge. Equals "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no surcharge was added."},"children":[]}]}]}],"example":103},"payment_method":{"type":"string","description":"ID of the payment method used in this transaction.","example":"pm_1MiN3gLkdIwHu7ixxYzWqR2b"},"balance_type":{"type":"string","description":"The balance type of the transaction.","example":"default"},"available_on":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date that the transaction’s net funds become available in the Stripe balance."},"children":[]}]}]}],"example":1678043844},"created":{"type":"number","description":"The date the transaction was created.","example":1678043844},"currency":{"type":"string","nullable":true,"description":"Three-letter ISO currency code.","example":"usd"},"description":{"type":"string","description":"Description of the transaction.","example":"Transfer to acct_1MiN3gLkdIwHu7ix"},"exchange_rate":{"type":"number","description":"The exchange rate applied to this transaction.","example":null},"fee":{"type":"number","description":"The fee applied to this transaction (in cents).","example":0},"fee_details":{"description":"Detailed breakdown of fees (in cents) paid for this transaction.","example":[],"type":"array","items":{"type":"string"}},"net":{"type":"number","description":"The net amount of this transaction (in cents).","example":-400},"status":{"type":"string","description":"The status of the transaction.","example":"available"},"type":{"type":"string","description":"The type of the transaction.","example":"transfer"},"failure_code":{"type":"string","nullable":true,"description":"Gateway error code of this transaction, null when the transaction did not fail.","example":"05"},"failure_message":{"type":"string","nullable":true,"description":"Sanitized gateway error message of this transaction, null when the transaction did not fail or the gateway returned no message.","example":"Do not honor"}},"required":["id","object","amount","surcharge_amount","amount_charged","payment_method","balance_type","available_on","created","currency","fee","fee_details","net","status","type","failure_code","failure_message"]}},"components/schemas/PlanDetails":{"id":"components/schemas/PlanDetails","kind":"json-schema","title":"PlanDetails","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the plan.","example":"price_1MowQULkdIwHu7ixraBm864M"},"object":{"type":"string","description":"String representing the object's type.","example":"plan","default":"plan"},"active":{"type":"boolean","description":"Whether the plan is currently available for new subscriptions.","example":true},"amount":{"type":"number","description":"The amount in cents to be charged on the interval specified.","example":1000,"minimum":0},"amount_decimal":{"type":"string","description":"Same as amount, but contains a decimal value with at most 12 decimal places.","example":"1000"},"created":{"type":"number","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","example":1679609766,"minimum":0},"currency":{"type":"string","description":"Three-letter ISO currency code, in uppercase.","example":"USD","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"},"interval":{"type":"string","description":"The frequency at which a subscription is billed.","example":"month","enum":["day","week","month","year"]},"interval_count":{"type":"number","description":"The number of intervals between subscription billings. A value of 0 means the plan has no billing period.","example":1,"minimum":0},"product":{"type":"string","description":"The product whose pricing this plan determines.","example":"prod_yROQV5usRxkTFtZBlNWGlwc1"}},"required":["id","object","active","amount","amount_decimal","created","currency","interval","interval_count","product"]}},"components/schemas/Recurring":{"id":"components/schemas/Recurring","kind":"json-schema","title":"Recurring","data":{"type":"object","properties":{"interval":{"type":"string","description":"The frequency of the recurring price.","enum":["day","week","month","year"],"example":"month"},"interval_count":{"type":"number","description":"The number of intervals (specified in the interval attribute) between subscription billings. A value of 0 means the price has no billing period.","example":1,"minimum":0,"maximum":365,"default":1}},"required":["interval","interval_count"]}},"components/schemas/PricePublicDto":{"id":"components/schemas/PricePublicDto","kind":"json-schema","title":"PricePublicDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the object.","example":"price_1SGKTmDZYOQH9uHk1vaSxPKa","format":"string"},"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object’s type."},"children":[]}]}]}],"example":"price","enum":["price"],"default":"price"},"active":{"type":"boolean","description":"Indicates whether the object is active.","example":true},"created":{"type":"number","description":"Time at which the object was created. Measured in seconds since the Unix epoch","example":1760018761,"minimum":0},"currency":{"type":"string","description":"Three-letter ISO currency code, in uppercase","example":"USD","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"},"description":{"type":"string","nullable":true,"description":"Customer-facing price description","example":"Premium Plan - Monthly","maxLength":255},"product":{"type":"string","description":"ID of the product this price is associated with","example":null,"format":"string"},"recurring":{"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recurring components of a price such as interval and interval_count. Null if the price is not recurring."},"children":[]}]}]}],"example":{"interval":"month","interval_count":1},"allOf":[{"$ref":"#/components/schemas/Recurring"}]},"tax_behavior":{"type":"string","description":"The tax behavior of the product.","enum":["exclusive","inclusive"],"example":"exclusive","default":"exclusive"},"type":{"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. Null on a subscription item whose price cannot be resolved."},"children":[]}]}]}],"example":"one_time","allOf":[{"$ref":"#/components/schemas/PriceTypeEnum"}]},"unit_amount":{"type":"number","nullable":true,"description":"The unit amount in cents to be charged, represented as a whole integer if possible.","example":1000,"minimum":0,"maximum":999999999},"unit_amount_decimal":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same as unit_amount"},"children":[]}]}]}],"example":"1000"},"link":{"type":"string","description":"Payment link associated with the price for hosted pages or other off-session payments.","nullable":true}},"required":["id","object","active","created","currency","product","recurring","tax_behavior","type","unit_amount","unit_amount_decimal"]}},"components/schemas/TaxTypeEnum":{"id":"components/schemas/TaxTypeEnum","kind":"json-schema","title":"TaxTypeEnum","data":{"type":"string","enum":["Sales tax","VAT","GST","Custom"],"description":"Type of the tax rate"}},"components/schemas/TaxesPublicDto":{"id":"components/schemas/TaxesPublicDto","kind":"json-schema","title":"TaxesPublicDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the object.","example":"txr_inQ4hbLZPyljDXFRCEnjtEqK","format":"string"},"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object’s type."},"children":[]}]}]}],"example":"tax_rate","enum":["tax_rate"],"default":"tax_rate"},"active":{"type":"boolean","description":"Indicates whether the object is active.","example":true},"country":{"type":"string","nullable":true,"description":"Two-letter ISO country code representing the country for the tax rate (only US is supported)","example":"US","enum":["US"]},"created":{"type":"number","description":"Timestamp (in seconds since Unix epoch) of when the object was created.","example":1678833149,"minimum":0},"description":{"type":"string","nullable":true,"description":"An arbitrary string attached to the object. Often useful for displaying to users.","example":"State sales tax"},"display_name":{"type":"string","description":"The display name of the tax rate, e.g., \"Sales Tax\".","example":"Sales Tax"},"inclusive":{"type":"boolean","description":"Specifies if the tax is inclusive (included in price) or exclusive (added on top).","example":true},"percentage":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax percentage rate, e.g., 7.25 for 7.25%."},"children":[]}]}]}],"example":7.25,"minimum":0,"maximum":100},"tax_type":{"description":"Type of the tax rate","example":"Custom","allOf":[{"$ref":"#/components/schemas/TaxTypeEnum"}]}},"required":["id","object","active","created","display_name","inclusive","percentage","tax_type"]}},"components/schemas/Taxes":{"id":"components/schemas/Taxes","kind":"json-schema","title":"Taxes","data":{"type":"object","properties":{"amount":{"type":"number","description":"The amount of the tax, in cents.","example":150},"tax_behavior":{"type":"string","description":"Whether this tax is inclusive or exclusive.","enum":["exclusive","inclusive"],"example":"exclusive","default":"exclusive"},"tax_rate":{"type":"string","description":"Tax rate id.","example":"txr_1S2tlWDZYOQH9uHkltYEi1ap"},"taxable_amount":{"type":"number","description":"The amount on which tax is calculated.","example":1500}},"required":["amount","tax_behavior","tax_rate","taxable_amount"]}},"components/schemas/InvoiceItem":{"id":"components/schemas/InvoiceItem","kind":"json-schema","title":"InvoiceItem","data":{"type":"object","properties":{"amount":{"type":"number","description":"The amount, in cents.","example":1000,"minimum":0},"currency":{"type":"string","description":"Three-letter ISO currency code, in uppercase.","example":"USD","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"},"description":{"type":"string","description":"Description of the invoice item.","example":"Monthly Subscription Fee"},"invoice":{"type":"string","description":"The ID of the invoice this item belongs to.","example":"a80baa67-1341-4184-b712-b6f9b85b5a2b"},"plan":{"description":"The plan details for this subscription item.","allOf":[{"$ref":"#/components/schemas/PlanDetails"}]},"price":{"description":"The price details for this subscription item.","allOf":[{"$ref":"#/components/schemas/PricePublicDto"}]},"quantity":{"type":"number","description":"The quantity of the plan to which the customer should be subscribed.","example":1,"minimum":1},"subscription":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subscription this subscription item belongs to. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an invoice that belongs to a payment plan."},"children":[]}]}]}],"example":"sub_1MowQVLkdIwHu7ixeRlqHVzs"},"tax_rates":{"description":"The tax rates which apply to this subscription item.","allOf":[{"$ref":"#/components/schemas/TaxesPublicDto"}]},"taxes":{"description":"The aggregate amounts calculated per tax rate for all line items.","nullable":true,"allOf":[{"$ref":"#/components/schemas/Taxes"}]}},"required":["amount","currency","description","invoice","plan","price","quantity","subscription","tax_rates","taxes"]}},"components/schemas/InvoiceItems":{"id":"components/schemas/InvoiceItems","kind":"json-schema","title":"InvoiceItems","data":{"type":"object","properties":{"object":{"type":"string","description":"String representing the object's type.","example":"list","default":"list"},"data":{"description":"Array of invoice items.","type":"array","items":{"$ref":"#/components/schemas/InvoiceItem"}},"total_count":{"type":"number","description":"The total number of invoice items.","example":1,"minimum":0}},"required":["object","data","total_count"]}},"components/schemas/StatusTransitions":{"id":"components/schemas/StatusTransitions","kind":"json-schema","title":"StatusTransitions","data":{"type":"object","properties":{"finalized_at":{"type":"number","nullable":true,"description":"Timestamp when the invoice was marked as finalized.","example":1680645568},"paid_at":{"type":"number","nullable":true,"description":"Timestamp when the invoice was marked as paid.","example":1680645568},"voided_at":{"type":"number","nullable":true,"description":"Timestamp when the invoice was marked as voided.","example":1680645568}},"required":["finalized_at","paid_at","voided_at"]}},"components/schemas/InvoicesPublicDto":{"id":"components/schemas/InvoicesPublicDto","kind":"json-schema","title":"InvoicesPublicDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the object.","example":"a80baa67-1341-4184-b712-b6f9b85b5a2b","format":"string"},"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object’s type."},"children":[]}]}]}],"example":"invoice","enum":["invoice"],"default":"invoice"},"account_country":{"type":"string","nullable":true,"description":"Country of the account associated with the invoice (only US is supported).","example":"US","enum":["US"]},"account_name":{"type":"string","nullable":true,"description":"Name of the account associated with the invoice.","example":"Acme Corp"},"amount_due":{"type":"number","description":"Final amount due at this time for this invoice (in cents for USD).","example":1500,"minimum":0},"amount_paid":{"type":"number","description":"The amount, in cents, that was paid.","example":500,"minimum":0,"nullable":true},"surcharge_amount":{"type":"number","description":"The card surcharge the gateway added to the payments of this invoice, in cents. 0 when none was added. The invoice total never includes it.","example":3},"amount_charged":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total charged to the card for this invoice, in cents: amount_paid plus the surcharge. Equals amount_paid when none was added."},"children":[]}]}]}],"example":103},"amount_remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The difference between amount_due and amount_paid, in cents."},"children":[]}]}]}],"example":1000,"minimum":0,"nullable":true},"attempt_count":{"type":"number","description":"Number of payment attempts made for this invoice.","example":1,"minimum":0,"nullable":true},"next_payment_attempt":{"type":"number","nullable":true},"attempted":{"type":"boolean","description":"Whether payment of this invoice was attempted.","example":true,"nullable":true},"billing_reason":{"type":"string","description":"Describes why this invoice was created.","example":"subscription","enum":["subscription","manual"],"nullable":true},"collection_method":{"type":"string","description":"Collection method of this invoice.","example":"charge_automatically","enum":["charge_automatically","send_invoice"],"nullable":true},"created":{"type":"number","description":"Time at which the object was created. Measured in seconds since the Unix epoch","example":1680645568,"minimum":0},"currency":{"type":"string","description":"Three-letter ISO currency code, in uppercase","example":"USD","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"},"customer":{"type":"string","description":"ID of the customer associated with this invoice.","example":"cus_383fda0065594749023e8c8d","nullable":true},"customer_address":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer’s address."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/Address"}]},"customer_email":{"type":"string","description":"Email of the customer associated with the invoice.","example":"john.doe@example.com","format":"email"},"customer_name":{"type":"string","description":"Name of the customer associated with the invoice.","example":"John Doe"},"customer_phone":{"type":"string","description":"Phone number of the customer.","example":"+1234567890","nullable":true},"lines":{"description":"The individual line items that make up the invoice.","allOf":[{"$ref":"#/components/schemas/InvoiceItems"}]},"number":{"type":"string","description":"A unique, identifying string that appears on emails sent to the customer for this invoice.","example":"INV-1001"},"paid":{"type":"boolean","description":"Whether payment was successfully collected for this invoice.","example":true},"period_end":{"type":"number","description":"End of the usage period during which invoice items were added to this invoice.","example":1680645568,"minimum":0,"nullable":true},"period_start":{"type":"number","description":"Start of the usage period during which invoice items were added to this invoice.","example":1680645568,"minimum":0,"nullable":true},"status":{"type":"string","description":"The status of the invoice, one of draft, open, paid, or void.","example":"paid","enum":["draft","open","paid","void"]},"status_transitions":{"description":"The timestamps at which the invoice status was updated.","nullable":true,"allOf":[{"$ref":"#/components/schemas/StatusTransitions"}]},"subscription":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the subscription that this invoice was prepared for, if any. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an invoice that belongs to a payment plan."},"children":[]}]}]}],"example":"sub_Wm45f5PGQvv67azFeH1z7PO3"},"payment_plan":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment plan this invoice was prepared for, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when this invoice does not belong to a payment plan."},"children":[]}]}]}],"example":"pp_1ef17ace4b4d96ff32461285"},"installment":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment plan installment this invoice was prepared for, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no installment matches."},"children":[]}]}]}],"example":"ppi_9c1a3d0e2f4b8756a1c0d3ef"},"subtotal":{"type":"number","description":"Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied","example":1500,"minimum":0,"nullable":true},"subtotal_excluding_tax":{"type":"number","description":"The integer amount in cents representing the subtotal of the invoice before any invoice level discount or tax is applied","example":1500,"minimum":0,"nullable":true},"tax":{"type":"number","description":"The amount of tax on this invoice.","example":150,"minimum":0,"nullable":true},"total":{"type":"number","description":"Total after discounts and taxes.","example":1650,"minimum":0,"nullable":true},"total_excluding_tax":{"type":"number","description":"The integer amount in cents representing the total amount of the invoice including all discounts but excluding all tax.","example":1500,"minimum":0,"nullable":true},"total_taxes":{"description":"The aggregate amounts calculated per tax rate for all line items.","nullable":true,"allOf":[{"$ref":"#/components/schemas/Taxes"}]}},"required":["id","object","amount_due","surcharge_amount","amount_charged","created","currency","customer_email","customer_name","lines","number","paid","status","payment_plan","installment"]}},"components/schemas/ItemsPublicDto":{"id":"components/schemas/ItemsPublicDto","kind":"json-schema","title":"ItemsPublicDto","data":{"type":"object","properties":{"price":{"type":"string","pattern":"^[a-z]+_[a-zA-Z0-9]+$","description":"The price ID in friendly ID format.","example":"price_4N2gcTPKLGscC1OtN5ICQiIj"},"tax":{"description":"Array of tax IDs in friendly ID format.","example":["txr_dUhN2gnTAuEyTjHHVBr1eAZ8"],"type":"array","items":{"type":"string","pattern":"^[a-z]+_[a-zA-Z0-9]+$"}},"quantity":{"type":"number","minimum":1,"description":"The quantity of the product.","example":3}},"required":["price","quantity"]}},"components/schemas/CreateInvoicePublicDto":{"id":"components/schemas/CreateInvoicePublicDto","kind":"json-schema","title":"CreateInvoicePublicDto","data":{"type":"object","properties":{"collection_method":{"type":"string","enum":["charge_automatically","send_invoice"],"description":"The collection method for this invoice.","example":"charge_automatically"},"customer":{"type":"string","description":"The ID of the customer for whom the invoice is to be created.","example":"cus_383fda0065594749023e8c8d"},"due_date":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which payment for this invoice is due. Valid only for invoices where collection_method=send_invoice."},"children":[]}]}]}],"example":1672531199},"default_payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default payment method to be used for this invoice. Valid only for invoices where collection_method=charge_automatically."},"children":[]}]}]}],"example":"pm_1SfME4DZYOQH9uHkDutknty1"},"items":{"description":"Array of products to be included in the invoice.","type":"array","items":{"$ref":"#/components/schemas/ItemsPublicDto"}}},"required":["collection_method","customer","items"]}},"components/schemas/CreateTaxPublicDto":{"id":"components/schemas/CreateTaxPublicDto","kind":"json-schema","title":"CreateTaxPublicDto","data":{"type":"object","properties":{"tax_type":{"description":"Type of tax rate","example":"Custom","allOf":[{"$ref":"#/components/schemas/TaxTypeEnum"}]},"display_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display name for the tax rate. Required when tax_type is Custom"},"children":[]}]}]}],"example":"Custom Tax Rate"},"description":{"type":"string","description":"Description of the tax rate","example":"Tax rate for custom purposes"},"country":{"type":"string","enum":["US"],"description":"Country code (only US is supported)","example":"US"},"percentage":{"type":"number","minimum":0,"maximum":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax percentage rate, e.g., 7.25 for 7.25%."},"children":[]}]}]}],"example":8.5},"inclusive":{"type":"boolean","default":false,"description":"Whether this tax rate is inclusive or exclusive","example":false}},"required":["tax_type","country","percentage","inclusive"]}},"components/schemas/UpdateTaxPublicDto":{"id":"components/schemas/UpdateTaxPublicDto","kind":"json-schema","title":"UpdateTaxPublicDto","data":{"type":"object","properties":{"tax_type":{"description":"Type of tax rate","example":"Custom","allOf":[{"$ref":"#/components/schemas/TaxTypeEnum"}]},"display_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display name for the tax rate. Required when tax_type is Custom"},"children":[]}]}]}],"example":"Custom Tax Rate"},"description":{"type":"string","description":"Description of the tax rate","example":"Tax rate for custom purposes"}},"required":["tax_type"]}},"components/schemas/CreatePricePublicDto":{"id":"components/schemas/CreatePricePublicDto","kind":"json-schema","title":"CreatePricePublicDto","data":{"type":"object","properties":{"currency":{"type":"string","enum":["USD"],"description":"Three-letter ISO currency code","example":"USD"},"description":{"type":"string","description":"Customer-facing price description","example":"Premium Plan - Monthly","maxLength":255},"recurring":{"nullable":true,"description":"Recurring components of the price","allOf":[{"$ref":"#/components/schemas/RecurringInput"}]},"tax_behavior":{"type":"string","default":"exclusive","enum":["exclusive","inclusive"],"description":"Tax calculation behavior","example":"exclusive"},"type":{"description":"Price type","example":"one_time","allOf":[{"$ref":"#/components/schemas/PriceTypeEnum"}]},"unit_amount":{"type":"number","minimum":0,"maximum":99999999,"description":"Unit amount in cents","example":1000}},"required":["currency","tax_behavior","type","unit_amount"]}},"components/schemas/UpdatePriceDto":{"id":"components/schemas/UpdatePriceDto","kind":"json-schema","title":"UpdatePriceDto","data":{"type":"object","properties":{"description":{"type":"string","description":"Customer-facing price description","example":"Premium Plan - Monthly","maxLength":255}}}},"components/schemas/SubscriptionItem":{"id":"components/schemas/SubscriptionItem","kind":"json-schema","title":"SubscriptionItem","data":{"type":"object","properties":{"created":{"type":"number","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","example":1679609768,"minimum":0},"current_period_end":{"type":"number","description":"End of the current period that the subscription has been invoiced for.","example":1682288167,"minimum":0},"current_period_start":{"type":"number","description":"Start of the current period that the subscription has been invoiced for.","example":1679609767,"minimum":0},"plan":{"description":"The plan details for this subscription item.","allOf":[{"$ref":"#/components/schemas/PlanDetails"}]},"price":{"description":"The price details for this subscription item.","allOf":[{"$ref":"#/components/schemas/PricePublicDto"}]},"quantity":{"type":"number","description":"The quantity of the plan to which the customer should be subscribed.","example":1,"minimum":1},"subscription":{"type":"string","description":"The subscription this subscription item belongs to.","example":"sub_1MowQVLkdIwHu7ixeRlqHVzs"},"tax_rates":{"description":"The tax rates which apply to this subscription item.","allOf":[{"$ref":"#/components/schemas/TaxesPublicDto"}]}},"required":["created","current_period_end","current_period_start","plan","price","quantity","subscription","tax_rates"]}},"components/schemas/SubscriptionItems":{"id":"components/schemas/SubscriptionItems","kind":"json-schema","title":"SubscriptionItems","data":{"type":"object","properties":{"object":{"type":"string","description":"String representing the object's type.","example":"list","default":"list"},"data":{"description":"Array of subscription items.","type":"array","items":{"$ref":"#/components/schemas/SubscriptionItem"}},"total_count":{"type":"number","description":"The total number of subscription items.","example":1,"minimum":0}},"required":["object","data","total_count"]}},"components/schemas/SubscriptionsPublicDto":{"id":"components/schemas/SubscriptionsPublicDto","kind":"json-schema","title":"SubscriptionsPublicDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the subscription.","example":"sub_2FdhgypnsJQn9mZlY5qGaElL","pattern":"^[a-z]+_[a-zA-Z0-9]+$"},"object":{"type":"string","description":"String representing the object's type.","example":"subscription","enum":["subscription"],"default":"subscription"},"billing_cycle_anchor":{"type":"number","description":"Determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices.","example":1679609767,"minimum":0},"cancel_at":{"type":"number","nullable":true,"description":"A date in the future at which the subscription will automatically get canceled.","example":null},"cancel_at_period_end":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period."},"children":[]}]}]}],"example":false},"canceled_at":{"type":"number","nullable":true,"description":"If the subscription has been canceled, the date of that cancellation.","example":null},"collection_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either charge_automatically, or send_invoice."},"children":[]}]}]}],"example":"charge_automatically","enum":["charge_automatically","send_invoice"]},"created":{"type":"number","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","example":1679609767,"minimum":0},"currency":{"type":"string","description":"Three-letter ISO currency code, in uppercase.","example":"USD","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"},"customer":{"type":"string","description":"ID of the customer who owns the subscription.","example":"cus_739c07713fd4b68565a969cd"},"ended_at":{"type":"number","nullable":true,"description":"If the subscription has ended, the date the subscription ended.","example":null},"items":{"description":"List of subscription items, each with an attached plan.","allOf":[{"$ref":"#/components/schemas/SubscriptionItems"}]},"latest_invoice":{"type":"string","description":"The most recent invoice this subscription has generated.","example":"58d0f1c9-ca00-4998-8e89-d74a290b4df6"},"start_date":{"type":"number","description":"Date when the subscription was first created.","example":1679609767,"minimum":0},"status":{"type":"string","description":"The status of the subscription.","example":"active","enum":["active","scheduled","canceled","expired","trialing"]},"trial_end":{"type":"number","nullable":true,"description":"If the subscription has a trial, the end of that trial.","example":null},"trial_start":{"type":"number","nullable":true,"description":"If the subscription has a trial, the beginning of that trial.","example":null},"reason":{"type":"object"},"initiated_by":{"type":"object"}},"required":["id","object","billing_cycle_anchor","cancel_at","cancel_at_period_end","canceled_at","collection_method","created","currency","customer","ended_at","items","latest_invoice","start_date","status","trial_end","trial_start"]}},"components/schemas/CreateSubscriptionPublicDto":{"id":"components/schemas/CreateSubscriptionPublicDto","kind":"json-schema","title":"CreateSubscriptionPublicDto","data":{"type":"object","properties":{"customer":{"type":"string","description":"The ID of the customer for whom the invoice is to be created.","example":"cus_e29d2542e2615c78af0d313d"},"items":{"description":"Array of products to be included in the subscription.","type":"array","items":{"$ref":"#/components/schemas/ItemsPublicDto"}},"trial_days":{"type":"number","minimum":0,"description":"The number of trial days for the subscription.","example":14},"start_date":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day when subscription starts. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be a valid Unix timestamp (positive number) in seconds"},"children":[]}]}]}],"example":1672531199},"end_date":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day when subscription ends. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be a valid Unix timestamp (positive number) in seconds"},"children":[]}]}]}],"example":1672531199},"start_billing_date":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day when subscription starts billing. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_billing_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be a valid Unix timestamp (positive number) in seconds"},"children":[]}]}]}],"example":1672531199}},"required":["customer","items","trial_days","start_date"]}},"components/schemas/UpdateSubscriptionPublicDto":{"id":"components/schemas/UpdateSubscriptionPublicDto","kind":"json-schema","title":"UpdateSubscriptionPublicDto","data":{"type":"object","properties":{"customer":{"type":"string","description":"The ID of the customer for whom the invoice is to be created.","example":"cus_e29d2542e2615c78af0d313d"},"items":{"description":"Array of products to be included in the subscription.","type":"array","items":{"$ref":"#/components/schemas/ItemsPublicDto"}},"trial_days":{"type":"number","minimum":0,"description":"The number of trial days for the subscription.","example":14},"end_date":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day when subscription ends. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be a valid Unix timestamp (positive number) in seconds"},"children":[]}]}]}],"example":1672531199}},"required":["customer","items","trial_days"]}},"components/schemas/SourceTypesDto":{"id":"components/schemas/SourceTypesDto","kind":"json-schema","title":"SourceTypesDto","data":{"type":"object","properties":{"card":{"type":"number","description":"Total amount coming from card payments.","example":358511},"bank_account":{"type":"number","description":"Total amount coming from legacy US ACH payments.","example":0},"fpx":{"type":"number","description":"Total amount coming from FPX payments.","example":0}},"required":["card"]}},"components/schemas/BalanceItemDto":{"id":"components/schemas/BalanceItemDto","kind":"json-schema","title":"BalanceItemDto","data":{"type":"object","properties":{"amount":{"type":"number","description":"Amount of funds available or pending in this currency.","example":358511},"currency":{"type":"string","description":"Three-letter ISO currency code.","example":"usd"},"source_types":{"description":"Breakdown of the balance by payment source type.","example":{"card":4097256},"allOf":[{"$ref":"#/components/schemas/SourceTypesDto"}]}},"required":["amount","currency","source_types"]}},"components/schemas/PrefundingItemDto":{"id":"components/schemas/PrefundingItemDto","kind":"json-schema","title":"PrefundingItemDto","data":{"type":"object","properties":{"amount":{"type":"number","description":"Amount of prefunding for this currency.","example":0},"currency":{"type":"string","description":"Currency of the prefunded amount.","example":"pln"}},"required":["amount","currency"]}},"components/schemas/RefundAndDisputePrefundingDto":{"id":"components/schemas/RefundAndDisputePrefundingDto","kind":"json-schema","title":"RefundAndDisputePrefundingDto","data":{"type":"object","properties":{"available":{"description":"List of available prefunded balances for refunds and disputes.","example":[{"amount":0,"currency":"usd"}],"type":"array","items":{"$ref":"#/components/schemas/PrefundingItemDto"}},"pending":{"description":"List of pending prefunded balances for refunds and disputes.","example":[{"amount":0,"currency":"usd"}],"type":"array","items":{"$ref":"#/components/schemas/PrefundingItemDto"}}},"required":["available","pending"]}},"components/schemas/BalancePublicDto":{"id":"components/schemas/BalancePublicDto","kind":"json-schema","title":"BalancePublicDto","data":{"type":"object","properties":{"object":{"type":"string","description":"Type of object returned by Stripe.","example":"balance"},"available":{"description":"List of balances available for payout.","example":[{"amount":4097256,"currency":"usd","source_types":{"card":4097256}}],"type":"array","items":{"$ref":"#/components/schemas/BalanceItemDto"}},"pending":{"description":"List of pending (not yet available) balance amounts.","example":[{"amount":5169,"currency":"usd","source_types":{"card":5169}}],"type":"array","items":{"$ref":"#/components/schemas/BalanceItemDto"}},"livemode":{"type":"boolean","description":"Indicates whether the balance belongs to a live (production) account.","example":false},"refund_and_dispute_prefunding":{"description":"Details about prefunded amounts for refunds and disputes.","example":{"available":[{"amount":0,"currency":"usd"}],"pending":[{"amount":0,"currency":"usd"}]},"allOf":[{"$ref":"#/components/schemas/RefundAndDisputePrefundingDto"}]}},"required":["object","available","pending","livemode","refund_and_dispute_prefunding"]}},"components/schemas/AttachPaymentMethodPublicRequestDto":{"id":"components/schemas/AttachPaymentMethodPublicRequestDto","kind":"json-schema","title":"AttachPaymentMethodPublicRequestDto","data":{"type":"object","properties":{"customerId":{"type":"string","description":"ID of the customer to attach the payment method to","example":"cust_123456789"},"cardNumber":{"type":"string","pattern":"^\\d{4,6}\\*{2,}\\d{4}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Masked card number from Collect.js (e.g. 411111******1111)"},"children":[]}]}]}]},"cardType":{"type":"string","description":"Card brand from Collect.js (e.g. visa)"},"cardExp":{"type":"string","pattern":"^(0[1-9]|1[0-2])\\d{2}$","description":"Card expiration from Collect.js in MMYY format (e.g. 1230)"},"walletType":{"type":"string","enum":["apple_pay","google_pay"],"description":"Wallet source of the payment, when the Collect.js token originated from Apple Pay or Google Pay.","example":"apple_pay"},"zipcode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing ZIP/postal code forwarded to the NMI Customer Vault add as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plugin property."},"children":[]}]}]}]}},"required":["customerId"]}},"components/schemas/SetDefaultPaymentMethodPublicRequestDto":{"id":"components/schemas/SetDefaultPaymentMethodPublicRequestDto","kind":"json-schema","title":"SetDefaultPaymentMethodPublicRequestDto","data":{"type":"object","properties":{"customerId":{"type":"string","description":"ID of the customer whose default payment method is being set","example":"cust_123456789"}},"required":["customerId"]}},"components/schemas/RevenueRecoveryPublicDto":{"id":"components/schemas/RevenueRecoveryPublicDto","kind":"json-schema","title":"RevenueRecoveryPublicDto","data":{"type":"object","properties":{"payment_retries":{"description":"The number of days after the previous attempt (or the invoice date, for the first entry) to wait before each automatic retry of a failed payment. At most 10 values.","example":[1,3,5,7],"maxItems":10,"type":"array","items":{"type":"integer"}},"subscription_state_on_payment_failure":{"enum":["cancel","unpaid","past-due"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What happens to a customer's subscriptions once the last retry in payment_retries has failed."},"children":[]}]}]}],"example":"cancel"},"invoice_state_on_payment_failure":{"enum":["past-due","uncollectible"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What happens to a customer's unpaid invoices once the last retry in payment_retries has failed."},"children":[]}]}]}],"example":"uncollectible"},"outcome_day":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. The sum of payment_retries plus one: the day, counted from the invoice date of the customer's oldest unpaid invoice that counts, on which the outcome is applied."},"children":[]}]}]}],"example":17}},"required":["payment_retries","subscription_state_on_payment_failure","invoice_state_on_payment_failure","outcome_day"]}},"components/schemas/UpdateRevenueRecoveryPublicDto":{"id":"components/schemas/UpdateRevenueRecoveryPublicDto","kind":"json-schema","title":"UpdateRevenueRecoveryPublicDto","data":{"type":"object","properties":{"payment_retries":{"minItems":1,"description":"The number of days after the previous attempt (or the invoice date, for the first entry) to wait before each automatic retry of a failed payment. At most 10 values.","example":[1,3,5,7],"maxItems":10,"type":"array","items":{"type":"integer","minimum":0}},"subscription_state_on_payment_failure":{"enum":["cancel","unpaid","past-due"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What happens to a customer's subscriptions once the last retry in payment_retries has failed."},"children":[]}]}]}],"example":"cancel"},"invoice_state_on_payment_failure":{"enum":["past-due","uncollectible"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What happens to a customer's unpaid invoices once the last retry in payment_retries has failed."},"children":[]}]}]}],"example":"uncollectible"}},"required":["payment_retries","subscription_state_on_payment_failure","invoice_state_on_payment_failure"]}},"components/schemas/PaymentPlanDepositAttemptPublicDto":{"id":"components/schemas/PaymentPlanDepositAttemptPublicDto","kind":"json-schema","title":"PaymentPlanDepositAttemptPublicDto","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the attempt, ppda_…."},"children":[]}]}]}],"example":"ppda_8QN4mTcRk2VwZfLp"},"object":{"type":"string","enum":["payment_plan_deposit_attempt"],"example":"payment_plan_deposit_attempt"},"terminal":{"type":"string","format":"uuid","description":"The id of the registered Dejavoo terminal the sale was sent to."},"reference_id":{"type":"string","description":"The 10-character reference of this attempt: the plan reference followed by the attempt number."},"state":{"type":"string","enum":["in_flight","resolving","approved","approved_no_credential","declined","cancelled","not_charged","failed","partial_approval","force_closed"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in_flight: the customer is at the terminal, or the sale is being confirmed. resolving: the outcome is not known yet; call POST /payment-plans/{id}/deposit. approved: installment 1 is paid and the card is saved. approved_no_credential: the card was charged but not saved yet; call POST /payment-plans/{id}/deposit again. declined: the card was declined; nothing was charged. cancelled: the sale was cancelled; nothing was charged. not_charged: the terminal confirmed that no sale took place. failed: the terminal or the SPIn proxy refused the request without producing an authorization; nothing was charged. partial_approval: the card was charged an amount different from installment 1; void the sale on the terminal. force_closed: ChaChing staff closed an attempt whose outcome could not be confirmed; nothing is recorded for it."},"children":[]}]}]}]},"started":{"type":"number","description":"Unix seconds at which the attempt started."},"resolved":{"type":"number","nullable":true,"description":"Unix seconds at which the outcome was read. null while unresolved."},"decline_code":{"type":"string","nullable":true,"description":"The SPIn status code of a declined, cancelled, failed or partially approved attempt. null otherwise."},"decline_message":{"type":"string","nullable":true,"description":"The sanitized SPIn message of a declined, cancelled, failed or partially approved attempt. null otherwise."},"surcharge_amount":{"type":"number","description":"The surcharge added to the sale at the terminal, in integer cents. 0 when none."},"amount_charged":{"type":"number","description":"The total charged to the card, in integer cents. 0 until the sale is approved."}},"required":["id","object","terminal","reference_id","state","started","resolved","decline_code","decline_message","surcharge_amount","amount_charged"]}},"components/schemas/PaymentPlanDepositPublicDto":{"id":"components/schemas/PaymentPlanDepositPublicDto","kind":"json-schema","title":"PaymentPlanDepositPublicDto","data":{"type":"object","properties":{"reference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant-facing terminal-deposit reference, 8 characters [A-Z0-9]."},"children":[]}]}]}]},"amount":{"type":"number","description":"The amount to collect at the terminal, in integer cents (the amount of installment 1)."},"status":{"type":"string","enum":["pending","collected"]},"transaction_reference":{"type":"string","nullable":true,"description":"The gateway transaction id of the approved deposit. When the deposit was confirmed only through the Transaction Status Check, it is the attempt's own reference id."},"collected_at":{"type":"number","nullable":true,"description":"Unix seconds at which the deposit was collected."},"attempt":{"nullable":true,"description":"The latest terminal deposit attempt of this plan. null when the plan has no attempt.","allOf":[{"$ref":"#/components/schemas/PaymentPlanDepositAttemptPublicDto"}]}},"required":["reference","amount","status","transaction_reference","collected_at","attempt"]}},"components/schemas/PaymentPlanPublicDto":{"id":"components/schemas/PaymentPlanPublicDto","kind":"json-schema","title":"PaymentPlanPublicDto","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier, pp_…."},"children":[]}]}]}],"example":"pp_8QN4mTcRk2VwZfLp"},"object":{"type":"string","enum":["payment_plan"],"example":"payment_plan"},"customer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer this plan belongs to, cus_…."},"children":[]}]}]}]},"description":{"type":"string","nullable":true,"description":"The text describing what this plan pays for, as sent at creation. null when none was sent."},"status":{"type":"string","enum":["awaiting_deposit","active","past_due","defaulted","paid_off","canceled"],"description":"The plan status. The spelling is canceled, with one l."},"currency":{"type":"string","description":"Three-letter ISO currency code, uppercase.","example":"USD"},"total_amount":{"type":"number","description":"The full amount agreed, in integer cents."},"down_payment_amount":{"type":"number","description":"The amount charged at creation outside the scheduled installments, in integer cents, recorded as installment sequence 0. 0 when there is none."},"installment_amount":{"type":"number","description":"The amount of a regular installment, in integer cents."},"installment_count":{"type":"number","description":"The number of scheduled installments. The down payment is not counted."},"interval":{"type":"string","enum":["weekly","biweekly","monthly"]},"start_date":{"type":"number","description":"Due date of installment 1, Unix seconds (00:00:00 UTC of that date)."},"remainder_placement":{"type":"string","enum":["first","last"]},"remaining_balance":{"type":"number","description":"What the customer still owes on this plan, in integer cents."},"installments_paid":{"type":"number","description":"Scheduled installments in status paid. The down payment is not counted."},"installments_remaining":{"type":"number","description":"Installments in status scheduled or failed."},"next_due_date":{"type":"number","nullable":true,"description":"Due date of the next unpaid installment, Unix seconds. null when none remains."},"payment_method":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment method charged for this plan, as returned by the payment-methods endpoints. null while the plan is awaiting_deposit."},"children":[]}]}]}]},"gateway":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment gateway that charges this plan. null while the plan is awaiting_deposit."},"children":[]}]}]}]},"reference":{"type":"string","nullable":true,"description":"The terminal-deposit reference. null for a plan created with a payment method."},"deposit":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentPlanDepositPublicDto"}]},"created":{"type":"number","description":"Creation time, Unix seconds."},"ended_at":{"type":"number","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the plan reached paid_off, Unix seconds."},"children":[]}]}]}]},"canceled_at":{"type":"number","nullable":true,"description":"When the plan was canceled, Unix seconds."}},"required":["id","object","customer","description","status","currency","total_amount","down_payment_amount","installment_amount","installment_count","interval","start_date","remainder_placement","remaining_balance","installments_paid","installments_remaining","next_due_date","payment_method","gateway","reference","deposit","created","ended_at","canceled_at"]}},"components/schemas/PaymentPlanInstallmentPublicDto":{"id":"components/schemas/PaymentPlanInstallmentPublicDto","kind":"json-schema","title":"PaymentPlanInstallmentPublicDto","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier, ppi_…."},"children":[]}]}]}]},"object":{"type":"string","enum":["payment_plan_installment"],"example":"payment_plan_installment"},"payment_plan":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The plan this installment belongs to, pp_…."},"children":[]}]}]}]},"sequence":{"type":"number","description":"Position in the schedule, starting at 1. Sequence 0 is the down payment."},"due_date":{"type":"number","description":"Due date, Unix seconds (00:00:00 UTC of that date)."},"amount":{"type":"number","description":"Amount in integer cents."},"amount_paid":{"type":"number","description":"Cents paid toward this installment so far."},"surcharge_amount":{"type":"number","description":"Card surcharge in integer cents the gateway added to the charge(s) that paid this installment. 0 when none."},"amount_charged":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total charged to the card in integer cents: amount_paid plus the surcharge. Equals amount_paid when there is no surcharge."},"children":[]}]}]}]},"status":{"type":"string","enum":["scheduled","paid","failed","canceled"]},"attempt_count":{"type":"number","description":"Charge attempts made on this installment, including retries."},"next_payment_attempt":{"type":"number","nullable":true,"description":"Date of the next scheduled retry, Unix seconds. null when no retry is scheduled."},"paid_at":{"type":"number","nullable":true,"description":"When the installment was paid, Unix seconds."},"invoice":{"type":"string","nullable":true,"description":"The invoice raised for this installment. null until the installment is billed."}},"required":["id","object","payment_plan","sequence","due_date","amount","amount_paid","surcharge_amount","amount_charged","status","attempt_count","next_payment_attempt","paid_at","invoice"]}},"components/schemas/PaymentPlanTerminalAttemptPublicDto":{"id":"components/schemas/PaymentPlanTerminalAttemptPublicDto","kind":"json-schema","title":"PaymentPlanTerminalAttemptPublicDto","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the attempt, ppda_…."},"children":[]}]}]}],"example":"ppda_8QN4mTcRk2VwZfLp"},"object":{"type":"string","enum":["payment_plan_terminal_attempt"],"example":"payment_plan_terminal_attempt"},"terminal":{"type":"string","format":"uuid","description":"The id of the registered Dejavoo terminal the sale was sent to."},"reference_id":{"type":"string","description":"The 10-character reference of this attempt."},"state":{"type":"string","enum":["in_flight","resolving","approved","approved_no_credential","declined","cancelled","not_charged","failed","partial_approval","force_closed"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in_flight: the customer is at the terminal, or the sale is being confirmed. resolving: the outcome is not known yet; call POST /payment-plans/{id}/payments/{payment_id}/resolve. approved: the sale was approved. approved_no_credential: the card was charged, but ChaChing has not confirmed the amount or recorded the payment yet; call POST /payment-plans/{id}/payments/{payment_id}/resolve. declined: the card was declined; nothing was charged. cancelled: the sale was cancelled; nothing was charged. not_charged: the terminal confirmed that no sale took place. failed: the terminal or the SPIn proxy refused the request without producing an authorization; nothing was charged. partial_approval: the terminal approved less than the amount sent. force_closed: ChaChing staff closed a payment whose outcome could not be confirmed; the payment reads not_attempted and the card can have been charged: check the sale in your Dejavoo (iPOSpays) account."},"children":[]}]}]}]},"started":{"type":"number","description":"Unix seconds at which the attempt started."},"resolved":{"type":"number","nullable":true,"description":"Unix seconds at which the outcome was read. null while unresolved."},"decline_code":{"type":"string","nullable":true,"description":"The terminal's SPIn status code of a declined, cancelled, failed or partially approved attempt. null otherwise."},"decline_message":{"type":"string","nullable":true,"description":"The sanitized SPIn message of a declined, cancelled, failed or partially approved attempt. null otherwise."},"surcharge_amount":{"type":"number","description":"The surcharge added to the sale at the terminal, in integer cents. 0 when none or not known."},"amount_charged":{"type":"number","description":"The total charged to the card, in integer cents. 0 until the sale is approved."},"transaction_id":{"type":"string","nullable":true,"description":"The iPOSpays transaction id of the sale. null until it is known."},"rrn":{"type":"string","nullable":true,"description":"The retrieval reference number of the sale. null until it is known."},"auth_code":{"type":"string","nullable":true,"description":"The authorization code the terminal returned for the sale; null until it is known."},"card_last4":{"type":"string","nullable":true,"description":"The last four digits of the card. null until it is known."},"card_brand":{"type":"string","nullable":true,"description":"The card brand, lowercase (for example visa). null until it is known."},"card_entry_type":{"type":"string","nullable":true,"description":"How the card was read (for example Contactless). null until it is known."}},"required":["id","object","terminal","reference_id","state","started","resolved","decline_code","decline_message","surcharge_amount","amount_charged","transaction_id","rrn","auth_code","card_last4","card_brand","card_entry_type"]}},"components/schemas/PaymentPlanPaymentPublicDto":{"id":"components/schemas/PaymentPlanPaymentPublicDto","kind":"json-schema","title":"PaymentPlanPaymentPublicDto","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier, ppp_…."},"children":[]}]}]}]},"object":{"type":"string","enum":["payment_plan_payment"],"example":"payment_plan_payment"},"payment_plan":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The plan, pp_…."},"children":[]}]}]}]},"status":{"type":"string","enum":["processing","applied","partially_applied","declined","not_attempted","unconfirmed"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of this payment. processing: at least one charge of the payment has no confirmed outcome yet, the payment is not recorded yet, amount reads 0, and payment_plan.payment_succeeded is sent when it is recorded. applied: every charge was approved and the whole amount was applied. partially_applied: a later charge was declined or not attempted, or the terminal approved less than the amount sent; amount is the part that was applied. declined: the first charge, or the terminal sale, was declined; nothing was applied. not_attempted: the first charge was not attempted, or the terminal sale did not take place (cancelled, not charged, refused by the terminal, or closed by ChaChing); nothing was applied. It also reads not_attempted when the terminal approved and charged the card but the plan could absorb none of the amount: terminal.state is approved or partial_approval and terminal.amount_charged carries the collected amount; amount_charged on the payment is 0 — do not ask the customer to pay again. unconfirmed: the outcome of the first charge could not be confirmed and nothing was recorded; read the plan before retrying. declined, not_attempted and unconfirmed are read on GET /payment-plans/{id}/payments/{payment_id} and on the resolve and cancel responses; the 201 of POST /payment-plans/{id}/payments and the payment_plan.payment_succeeded webhook never carry them."},"children":[]}]}]}]},"amount":{"type":"number","description":"Cents actually applied. Lower than the amount sent when a later charge of the payment was declined; 0 while a later charge's outcome is not confirmed yet."},"surcharge_amount":{"type":"number","description":"Card surcharge in integer cents the gateway added to the charges of this payment. 0 when none."},"amount_charged":{"type":"number","description":"Total charged to the card in integer cents: amount plus the surcharge. Equals amount when there is no surcharge."},"external":{"type":"boolean","description":"true when the payment was collected outside ChaChing and only recorded."},"payment_method":{"type":"string","nullable":true,"description":"The payment method charged. null for an external payment."},"invoice":{"type":"string","nullable":true,"description":"The last installment invoice this payment paid. null when the payment only reached the unbilled part of the plan."},"payoff":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true when this payment moved the plan to paid_off."},"children":[]}]}]}]},"created":{"type":"number","description":"Unix seconds."},"payment_plan_status":{"type":"string","enum":["awaiting_deposit","active","past_due","defaulted","paid_off","canceled"],"description":"The plan status after the payment."},"remaining_balance":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The plan's remaining_balance after the payment, in integer cents."},"children":[]}]}]}]},"installments_remaining":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The plan's installments_remaining after the payment."},"children":[]}]}]}]},"terminal":{"nullable":true,"description":"The terminal sale of a payment taken on a Dejavoo terminal. null for a payment taken any other way.","allOf":[{"$ref":"#/components/schemas/PaymentPlanTerminalAttemptPublicDto"}]}},"required":["id","object","payment_plan","status","amount","surcharge_amount","amount_charged","external","payment_method","invoice","payoff","created","payment_plan_status","remaining_balance","installments_remaining","terminal"]}},"components/schemas/TerminalPaymentMethodPublicDto":{"id":"components/schemas/TerminalPaymentMethodPublicDto","kind":"json-schema","title":"TerminalPaymentMethodPublicDto","data":{"type":"object","properties":{"type":{"type":"string","enum":["terminal"],"example":"terminal"},"terminal_id":{"type":"string","format":"uuid","description":"The id of a registered Dejavoo terminal of this account, as returned by GET /dejavoo/terminals."}},"required":["type","terminal_id"]}},"components/schemas/CreatePaymentPlanPublicDto":{"id":"components/schemas/CreatePaymentPlanPublicDto","kind":"json-schema","title":"CreatePaymentPlanPublicDto","data":{"type":"object","properties":{"customer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer id, cus_…."},"children":[]}]}]}]},"total_amount":{"type":"number","minimum":1,"description":"The total amount to be paid, in integer cents."},"installment_count":{"type":"number","minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of installments. Mutually exclusive with installment_amount — exactly one of the two must be provided. Between 1 and 60."},"children":[]}]}]}]},"installment_amount":{"type":"number","minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of each regular installment, in integer cents. Mutually exclusive with installment_count."},"children":[]}]}]}]},"down_payment_amount":{"type":"number","minimum":0,"description":"The amount collected up front, in integer cents.","default":0},"interval":{"enum":["weekly","biweekly","monthly"],"type":"string","default":"monthly"},"start_date":{"type":"number","minimum":1,"description":"Unix seconds of the first installment due date. Only the UTC calendar date is used: the time of day is dropped and the plan starts at 00:00:00 UTC of that date. The date must fall on a later calendar day (UTC) than the request. Default: one interval after today."},"remainder_placement":{"enum":["first","last"],"type":"string","default":"first"},"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of a payment method of this customer, as returned by the payment-methods endpoints. Leave it out to create the plan in terminal-deposit mode: the plan opens in awaiting_deposit and the customer pays installment 1 on a registered Dejavoo terminal through POST /payment-plans/{id}/deposit/terminal."},"children":[]}]}]}]},"description":{"type":"string","nullable":true,"maxLength":255,"pattern":"^[^\\u0000-\\u001F\\u007F]*$","description":"A short text describing what this plan pays for. Shown to the customer on the plan receipts and failed-payment emails. Up to 255 characters, with no line breaks or other control characters. Leading and trailing spaces are removed; an empty value is stored as no description."}},"required":["customer","total_amount"]}},"components/schemas/CreatePaymentPlanPaymentPublicDto":{"id":"components/schemas/CreatePaymentPlanPaymentPublicDto","kind":"json-schema","title":"CreatePaymentPlanPaymentPublicDto","data":{"type":"object","properties":{"amount":{"type":"number","description":"The amount to charge, in integer cents."},"payment_method":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/TerminalPaymentMethodPublicDto"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of a payment method of the plan's customer, as returned by the payment-methods endpoints, or { \"type\": \"terminal\", \"terminal_id\": \"the terminal id\" } to take the payment on one of your registered Dejavoo terminals. Default: the customer's default payment method. Ignored when external is true; a terminal cannot be combined with external: true."},"children":[]}]}]}]},"external":{"type":"boolean","description":"true when this payment was collected outside ChaChing and is only recorded; nothing is charged. Default false."}},"required":["amount"]}},"components/schemas/EmptyDepositBodyPublicDto":{"id":"components/schemas/EmptyDepositBodyPublicDto","kind":"json-schema","title":"EmptyDepositBodyPublicDto","data":{"type":"object","properties":{}}},"components/schemas/StartTerminalDepositPublicDto":{"id":"components/schemas/StartTerminalDepositPublicDto","kind":"json-schema","title":"StartTerminalDepositPublicDto","data":{"type":"object","properties":{"terminal_id":{"type":"string","format":"uuid","description":"The id of a registered Dejavoo terminal of this account, as returned by GET /dejavoo/terminals."}},"required":["terminal_id"]}},"components/schemas/DejavooTerminalPublicDto":{"id":"components/schemas/DejavooTerminalPublicDto","kind":"json-schema","title":"DejavooTerminalPublicDto","data":{"type":"object","properties":{"id":{"type":"string","description":"The terminal id."},"object":{"type":"string","enum":["dejavoo_terminal"],"description":"Object type."},"tpn":{"type":"string","description":"The terminal's 12-digit TPN."},"label":{"type":"string","description":"The terminal label."},"enabled":{"type":"boolean","description":"Whether the terminal is enabled."},"register_id":{"type":"string","nullable":true,"description":"The Register ID, if recorded."},"isv_id":{"type":"string","nullable":true,"description":"The ISV identifier, if recorded."},"spin_auth_key_set":{"type":"boolean","example":true,"description":"Always true: an Auth Key is stored. The key itself is never returned."},"credential_rotated_at":{"type":"number","nullable":true,"description":"Unix seconds of the last Auth Key re-entry, or null."},"last_probe_at":{"type":"number","nullable":true,"description":"Unix seconds of the last successful SPIn check, or null."},"last_probe_status":{"type":"string","enum":["Online","Offline"],"nullable":true,"description":"The SPIn terminal status at the last successful check."},"build":{"type":"string","nullable":true,"description":"The terminal build reported by SPIn, if any."},"serial":{"type":"string","nullable":true,"description":"The terminal serial number reported by SPIn, if any."},"feed_enable_requested_at":{"type":"number","nullable":true,"description":"Unix seconds when Dejavoo was recorded as asked to enable FEED on this TPN, or null."},"created":{"type":"number","description":"Unix seconds when the terminal was registered."}},"required":["id","object","tpn","label","enabled","register_id","isv_id","spin_auth_key_set","credential_rotated_at","last_probe_at","last_probe_status","build","serial","feed_enable_requested_at","created"]}},"components/schemas/DejavooTerminalListPublicDto":{"id":"components/schemas/DejavooTerminalListPublicDto","kind":"json-schema","title":"DejavooTerminalListPublicDto","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DejavooTerminalPublicDto"}}},"required":["data"]}},"components/schemas/CreateDejavooTerminalPublicDto":{"id":"components/schemas/CreateDejavooTerminalPublicDto","kind":"json-schema","title":"CreateDejavooTerminalPublicDto","data":{"type":"object","properties":{"tpn":{"type":"string","description":"The terminal's own 12-digit TPN.","example":"118126362850"},"label":{"type":"string","description":"A human label for the terminal, 1 to 64 characters.","example":"Front desk"},"spin_auth_key":{"type":"string","description":"The 10-character SPIn Auth Key of this terminal (not the Ecom Token). Write-only: it is never returned."},"register_id":{"type":"string","description":"The portal's Register ID for this terminal."},"isv_id":{"type":"string","description":"The iPOSpays ISV identifier for this terminal, 1 to 16 characters (the limit of the SPIn Sale request)."},"enabled":{"type":"boolean","default":true,"description":"Whether the terminal is enabled. Defaults to true. Send false to store it disabled until Dejavoo confirms FEED on this TPN."},"feed_enable_requested":{"type":"boolean","default":false,"description":"Record that Dejavoo was asked to enable FEED on this TPN. Defaults to false."}},"required":["tpn","label","spin_auth_key"]}},"components/schemas/UpdateDejavooTerminalPublicDto":{"id":"components/schemas/UpdateDejavooTerminalPublicDto","kind":"json-schema","title":"UpdateDejavooTerminalPublicDto","data":{"type":"object","properties":{"label":{"type":"string","description":"A new label, 1 to 64 characters."},"enabled":{"type":"boolean","description":"Enable or disable the terminal. Enabling a disabled terminal re-checks its stored Auth Key with SPIn."},"spin_auth_key":{"type":"string","description":"A new 10-character SPIn Auth Key. Checked with SPIn before it is saved. Write-only."},"register_id":{"type":"string","nullable":true,"description":"The Register ID, or null to clear it."},"isv_id":{"type":"string","nullable":true,"description":"The ISV identifier, 1 to 16 characters, or null to clear it."},"feed_enable_requested":{"type":"boolean","description":"true records that Dejavoo was asked to enable FEED on this TPN (now); false clears the record."}}}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"default":"","type":"string"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"minimum":1,"default":1,"type":"number"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"minimum":1,"maximum":50,"default":10,"type":"number"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"default":"ASC","type":"string","enum":["ASC","DESC"]},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"default":"createdAt","type":"string"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CustomersPublicDto"}},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerPublicOutputDto"}},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"example":"cus_c93f7e842b89b9f7cad17918","type":"string"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"number"},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"example":"pm_1234567890abcdef","type":"string"},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"type":"string"},"example":{"txcd_92010001":"Shipping","txcd_20030000":"General - Services"}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductPublicDto"}},"meta":{"type":"object","properties":{"page":{"type":"number","example":1,"description":"Current page number"},"take":{"type":"number","example":10,"description":"Number of items per page"},"itemsTotal":{"type":"number","example":50,"description":"Total number of items"},"pagesTotal":{"type":"number","example":5,"description":"Total number of pages"}}}}},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"pattern":"^[a-z]+_[a-zA-Z0-9]+$","example":"prod_xT4LfvxLMQb4s9uFNIbXf9pm","type":"string"},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","example":"prod_xT4LfvxLMQb4s9uFNIbXf9pm"},"deleted":{"type":"boolean","example":true}}},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"format":"json","default":"","type":"string"},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"example":"84c413b1-cda9-4637-a75d-352e36274bf2","type":"string"},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"example":"1ac67144-c4eb-4977-a185-674278685a5f","type":"string"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"example":"txr_inQ4hbLZPyljDXFRCEnjtEqK","type":"string"},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PricePublicDto"}},"meta":{"type":"object","properties":{"page":{"type":"number","example":1},"take":{"type":"number","example":10},"itemsTotal":{"type":"number","example":50},"pagesTotal":{"type":"number","example":5}}}}},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"pattern":"^[a-z]+_[a-zA-Z0-9]+$","example":"price_1SGKTmDZYOQH9uHk1vaSxPKa","type":"string"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","example":"price_1SGKTmDZYOQH9uHk1vaSxPKa"},"deleted":{"type":"boolean","example":true}}},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"pattern":"^[a-z]+_[a-zA-Z0-9]+$","example":"sub_2FdhgypnsJQn9mZlY5qGaElL","type":"string"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentPlanPublicDto"}},"meta":{"type":"object","properties":{"page":{"type":"number","example":1,"description":"Current page number"},"take":{"type":"number","example":10,"description":"Number of items per page"},"itemsTotal":{"type":"number","example":50,"description":"Total number of items"},"pagesTotal":{"type":"number","example":5,"description":"Total number of pages"}}}}},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"pattern":"^[a-z]+_[a-zA-Z0-9]+$","type":"string"},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentPlanInstallmentPublicDto"}},"meta":{"type":"object","properties":{"page":{"type":"number","example":1,"description":"Current page number"},"take":{"type":"number","example":10,"description":"Number of items per page"},"itemsTotal":{"type":"number","example":50,"description":"Total number of items"},"pagesTotal":{"type":"number","example":5,"description":"Total number of pages"}}}}},"id":"schema_25"}},"exampleStore":{"paths/~1products~1{id}/patch/requestBody/content/application~1json/examples/Update Product":{"value":{"name":"premium_plan_updated","description":"Updated premium plan","tax_code":"txcd_20030000"},"key":"Update Product","summary":"Update Product","id":"paths/~1products~1{id}/patch/requestBody/content/application~1json/examples/Update Product"},"paths/~1taxRates/post/requestBody/content/application~1json/examples/example1":{"value":{"display_name":"Sales Tax","percentage":8.5,"inclusive":false,"active":true},"key":"example1","summary":"Basic tax rate","id":"paths/~1taxRates/post/requestBody/content/application~1json/examples/example1"},"paths/~1prices~1{id}/post/requestBody/content/application~1json/examples/Recurring Price":{"value":{"currency":"USD","unit_amount":2999,"type":"recurring","recurring":{"interval":"month","interval_count":1},"tax_behavior":"exclusive","description":"Monthly subscription"},"key":"Recurring Price","summary":"Recurring Price","id":"paths/~1prices~1{id}/post/requestBody/content/application~1json/examples/Recurring Price"},"paths/~1prices~1{id}/post/requestBody/content/application~1json/examples/One-time Price":{"value":{"currency":"USD","unit_amount":9999,"type":"one_time","recurring":null,"tax_behavior":"exclusive","description":"One-time purchase"},"key":"One-time Price","summary":"One-time Price","id":"paths/~1prices~1{id}/post/requestBody/content/application~1json/examples/One-time Price"},"paths/~1prices~1{id}~1inactive/patch/requestBody/content/application~1json/examples/Update Recurring Price":{"value":{"currency":"USD","unit_amount":3999,"type":"recurring","recurring":{"interval":"month","interval_count":1},"tax_behavior":"exclusive","description":"Updated monthly subscription"},"key":"Update Recurring Price","summary":"Update Recurring Price","id":"paths/~1prices~1{id}~1inactive/patch/requestBody/content/application~1json/examples/Update Recurring Price"},"paths/~1prices~1{id}~1active/patch/requestBody/content/application~1json/examples/Update Description":{"value":{"description":"Updated description for active price"},"key":"Update Description","summary":"Update Description","id":"paths/~1prices~1{id}~1active/patch/requestBody/content/application~1json/examples/Update Description"}},"securitySchemeStore":{},"servers":[{"url":"/_mock/developer-guide/api","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/developer-guide/api","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/Developer Guide/api.json?download"},{"url":"/_bundle/Developer Guide/api.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Chaching API","description":"Chaching is a modern subscription-billing platform designed to simplify product management, customer lifecycle workflows, and recurring payments. It combines a clean dashboard for business users with a powerful API built for developers who need full automation and control."}},"baseSlug":"/developer-guide/api","routesMapping":{}}