{"item":[{"name":"Customers","description":"Operations related to customers.\n","item":[{"id":"15dec5bc-3599-4f15-bc73-4a4c0c142c40","name":"List customers","request":{"name":"List customers","description":{"content":"Retrieves a list of customers available in your account.\n\nThis endpoint supports [pagination](https://docs.properpayments.io/get-started/api-setup/pagination).\n","type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the country of the customer.","type":"text/plain"},"key":"country","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the customer being overdue or not.","type":"text/plain"},"key":"isOverdue","value":"<boolean>"},{"disabled":false,"description":{"content":"Filter on the legal entity of the customer.","type":"text/plain"},"key":"legalEntity","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"561871d3-6be7-4324-95a8-3db37f2d74e6","name":"A list of customers","originalRequest":{"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the country of the customer.","type":"text/plain"},"key":"country","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the customer being overdue or not.","type":"text/plain"},"key":"isOverdue","value":"<boolean>"},{"disabled":false,"description":{"content":"Filter on the legal entity of the customer.","type":"text/plain"},"key":"legalEntity","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"customers\": [\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"address\": {\n        \"line1\": \"<string>\",\n        \"postalCode\": \"<string>\",\n        \"city\": \"<string>\",\n        \"country\": \"<string>\",\n        \"line2\": \"<string>\"\n      },\n      \"vatId\": \"<string>\",\n      \"invoiceSettings\": {\n        \"customFields\": [\n          {\n            \"name\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"name\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"customMemo\": \"<string>\",\n        \"customFooter\": \"<string>\"\n      },\n      \"legalEntity\": \"Individual\",\n      \"isOverdue\": \"<boolean>\",\n      \"requirements\": {\n        \"missingFields\": [\n          \"<string>\",\n          \"<string>\"\n        ]\n      },\n      \"metaData\": {\n        \"et_8\": \"<string>\",\n        \"amete\": \"<string>\"\n      },\n      \"autoAdvance\": \"<boolean>\",\n      \"language\": \"en\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"address\": {\n        \"line1\": \"<string>\",\n        \"postalCode\": \"<string>\",\n        \"city\": \"<string>\",\n        \"country\": \"<string>\",\n        \"line2\": \"<string>\"\n      },\n      \"vatId\": \"<string>\",\n      \"invoiceSettings\": {\n        \"customFields\": [\n          {\n            \"name\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"name\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"customMemo\": \"<string>\",\n        \"customFooter\": \"<string>\"\n      },\n      \"legalEntity\": \"Company\",\n      \"isOverdue\": \"<boolean>\",\n      \"requirements\": {\n        \"missingFields\": [\n          \"<string>\",\n          \"<string>\"\n        ]\n      },\n      \"metaData\": {\n        \"ad_a_\": \"<string>\",\n        \"ut_f2d\": \"<string>\",\n        \"incididunt_2_\": \"<string>\"\n      },\n      \"autoAdvance\": \"<boolean>\",\n      \"language\": \"en\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1e7f0496-e8a0-4740-9f86-9982c17b72af","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the country of the customer.","type":"text/plain"},"key":"country","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the customer being overdue or not.","type":"text/plain"},"key":"isOverdue","value":"<boolean>"},{"disabled":false,"description":{"content":"Filter on the legal entity of the customer.","type":"text/plain"},"key":"legalEntity","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d03ccc04-deeb-49c0-8f28-94d5eb240ef3","name":"Create customer","request":{"name":"Create customer","description":{"content":"Creates a new customer in your account.\n","type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"address\": {\n    \"line1\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line2\": \"<string>\"\n  },\n  \"legalEntity\": \"Individual\",\n  \"vatId\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"metaData\": {\n    \"pariatur95\": \"<string>\",\n    \"laborum0\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\",\n  \"language\": \"ed\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"3b0f4409-4423-45a5-be92-721e524c8343","name":"The created customer","originalRequest":{"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"address\": {\n    \"line1\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line2\": \"<string>\"\n  },\n  \"legalEntity\": \"Individual\",\n  \"vatId\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"metaData\": {\n    \"pariatur95\": \"<string>\",\n    \"laborum0\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\",\n  \"language\": \"ed\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"address\": {\n    \"line1\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line2\": \"<string>\"\n  },\n  \"vatId\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"legalEntity\": \"Company\",\n  \"isOverdue\": \"<boolean>\",\n  \"requirements\": {\n    \"missingFields\": [\n      \"<string>\",\n      \"<string>\"\n    ]\n  },\n  \"metaData\": {\n    \"culpa675\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\",\n  \"language\": \"en\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"53533762-52bb-4ac3-bebc-c7088e49da5d","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"address\": {\n    \"line1\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line2\": \"<string>\"\n  },\n  \"legalEntity\": \"Individual\",\n  \"vatId\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"metaData\": {\n    \"pariatur95\": \"<string>\",\n    \"laborum0\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\",\n  \"language\": \"ed\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"01ee5eef-c99f-45d1-a9c2-22e95a24e904","name":"Get customer","request":{"name":"Get customer","description":{"content":"Retrieves the details of an existing customer. You need to supply the unique customer identifier that was returned upon customer creation.\n","type":"text/plain"},"url":{"path":["customers",":customerId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"customerId","disabled":false,"description":{"content":"(Required) The ID of the customer to retrieve.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"abbeea14-82ce-4e64-8d89-0b4bc585e47e","name":"The customer details","originalRequest":{"url":{"path":["customers",":customerId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"address\": {\n    \"line1\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line2\": \"<string>\"\n  },\n  \"vatId\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"legalEntity\": \"Company\",\n  \"isOverdue\": \"<boolean>\",\n  \"requirements\": {\n    \"missingFields\": [\n      \"<string>\",\n      \"<string>\"\n    ]\n  },\n  \"metaData\": {\n    \"culpa675\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\",\n  \"language\": \"en\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0c0a3db5-a1ae-462f-a3a6-ceec9410b43b","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["customers",":customerId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2192e74a-af2e-4a2b-8662-e35fa8c1f5ad","name":"Update customer","request":{"name":"Update customer","description":{"content":"Updates a customer in your account.\n","type":"text/plain"},"url":{"path":["customers",":customerId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"customerId","disabled":false,"description":{"content":"(Required) The ID of the customer to update.","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"address\": {\n    \"line1\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line2\": \"<string>\"\n  },\n  \"vatId\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"legalEntity\": \"Company\",\n  \"metaData\": {\n    \"qui_93e\": \"<string>\",\n    \"dolor_6b7\": \"<string>\",\n    \"laborum9da\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\",\n  \"language\": \"fh\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"f17385b0-a8fc-47f5-a914-7f1a6b5dc6b8","name":"The updated customer","originalRequest":{"url":{"path":["customers",":customerId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"address\": {\n    \"line1\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line2\": \"<string>\"\n  },\n  \"vatId\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"legalEntity\": \"Company\",\n  \"metaData\": {\n    \"qui_93e\": \"<string>\",\n    \"dolor_6b7\": \"<string>\",\n    \"laborum9da\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\",\n  \"language\": \"fh\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"address\": {\n    \"line1\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line2\": \"<string>\"\n  },\n  \"vatId\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"legalEntity\": \"Company\",\n  \"isOverdue\": \"<boolean>\",\n  \"requirements\": {\n    \"missingFields\": [\n      \"<string>\",\n      \"<string>\"\n    ]\n  },\n  \"metaData\": {\n    \"culpa675\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\",\n  \"language\": \"en\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ed9b4025-6c76-4946-b863-f996a2e37fd9","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["customers",":customerId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"address\": {\n    \"line1\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line2\": \"<string>\"\n  },\n  \"vatId\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"legalEntity\": \"Company\",\n  \"metaData\": {\n    \"qui_93e\": \"<string>\",\n    \"dolor_6b7\": \"<string>\",\n    \"laborum9da\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\",\n  \"language\": \"fh\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7e64a201-b614-4894-9487-9a2c624df341","name":"Delete customer","request":{"name":"Delete customer","description":{"content":"Deletes a customer if there are no agreements, invoices or subscriptions attached.\n","type":"text/plain"},"url":{"path":["customers",":customerId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"customerId","disabled":false,"description":{"content":"(Required) The ID of the customer to delete.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"e1bd31e7-0c9d-48ed-b189-0a931cb5bed2","name":"Customer deleted","originalRequest":{"url":{"path":["customers",":customerId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"846eba14-64c8-4ce9-b274-74abf4cc4c21","name":"Cannot delete customer with attached agreements, invoices or subscriptions","originalRequest":{"url":{"path":["customers",":customerId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Agreements","description":"Operations related to agreements.\n","item":[{"id":"fe5e7274-e178-4e2e-8faa-c7430cd3f9ff","name":"List agreements","request":{"name":"List agreements","description":{"content":"Retrieves a list of agreements for a specific customer.\n\nThis endpoint supports [pagination](https://docs.properpayments.io/get-started/api-setup/pagination).\n","type":"text/plain"},"url":{"path":["agreements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the customer of the agreement.","type":"text/plain"},"key":"customerId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the customer being overdue or not.","type":"text/plain"},"key":"isOverdue","value":"<boolean>"},{"disabled":false,"description":{"content":"Filter on the currency of the agreement.","type":"text/plain"},"key":"currency","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"df03573e-1358-4f2b-a1aa-4857a4e8390f","name":"A list of agreements","originalRequest":{"url":{"path":["agreements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the customer of the agreement.","type":"text/plain"},"key":"customerId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the customer being overdue or not.","type":"text/plain"},"key":"isOverdue","value":"<boolean>"},{"disabled":false,"description":{"content":"Filter on the currency of the agreement.","type":"text/plain"},"key":"currency","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"agreements\": [\n    {\n      \"customerId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"invoiceEmail\": \"<string>\",\n      \"currency\": \"<string>\",\n      \"eInvoicing\": {\n        \"enabled\": \"<boolean>\",\n        \"ean\": \"2760290116909\",\n        \"contactId\": \"<string>\"\n      },\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"invoiceSettings\": {\n        \"customFields\": [\n          {\n            \"name\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"name\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"customMemo\": \"<string>\",\n        \"customFooter\": \"<string>\"\n      },\n      \"balance\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"isOverdue\": \"<boolean>\",\n      \"metaData\": {\n        \"deseruntfe7\": \"<string>\",\n        \"eub_f\": \"<string>\"\n      },\n      \"autoAdvance\": \"<boolean>\"\n    },\n    {\n      \"customerId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"invoiceEmail\": \"<string>\",\n      \"currency\": \"<string>\",\n      \"eInvoicing\": {\n        \"enabled\": \"<boolean>\",\n        \"ean\": \"6429499622001\",\n        \"contactId\": \"<string>\"\n      },\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"invoiceSettings\": {\n        \"customFields\": [\n          {\n            \"name\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"name\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"customMemo\": \"<string>\",\n        \"customFooter\": \"<string>\"\n      },\n      \"balance\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"isOverdue\": \"<boolean>\",\n      \"metaData\": {\n        \"fugiatb9\": \"<string>\"\n      },\n      \"autoAdvance\": \"<boolean>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eec8daa5-5749-4825-8acd-4a6969dda43c","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["agreements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the customer of the agreement.","type":"text/plain"},"key":"customerId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the customer being overdue or not.","type":"text/plain"},"key":"isOverdue","value":"<boolean>"},{"disabled":false,"description":{"content":"Filter on the currency of the agreement.","type":"text/plain"},"key":"currency","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3786d0f9-ac36-4a96-9fa6-67b55a6eeef9","name":"Create agreement","request":{"name":"Create agreement","description":{"content":"Creates a new agreement for a customer.\n","type":"text/plain"},"url":{"path":["agreements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"customerId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"invoiceEmail\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"eInvoicing\": {\n    \"enabled\": \"<boolean>\",\n    \"ean\": \"7048022414470\",\n    \"contactId\": \"<string>\"\n  },\n  \"metaData\": {\n    \"amet_06\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"0c219c5e-28b4-4662-a027-fbf0ef21b48a","name":"The created agreement","originalRequest":{"url":{"path":["agreements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"customerId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"invoiceEmail\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"eInvoicing\": {\n    \"enabled\": \"<boolean>\",\n    \"ean\": \"7048022414470\",\n    \"contactId\": \"<string>\"\n  },\n  \"metaData\": {\n    \"amet_06\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"customerId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"invoiceEmail\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"eInvoicing\": {\n    \"enabled\": \"<boolean>\",\n    \"ean\": \"8387865492349\",\n    \"contactId\": \"<string>\"\n  },\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"balance\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"isOverdue\": \"<boolean>\",\n  \"metaData\": {\n    \"pariatur_59\": \"<string>\",\n    \"eiusmod96\": \"<string>\",\n    \"labored5d\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d00091e8-0a5f-40a0-9737-329e4bc7ef26","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["agreements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"customerId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"invoiceEmail\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"eInvoicing\": {\n    \"enabled\": \"<boolean>\",\n    \"ean\": \"7048022414470\",\n    \"contactId\": \"<string>\"\n  },\n  \"metaData\": {\n    \"amet_06\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e376482a-7bcd-45be-9b3a-76aa7b8b7ec7","name":"Get agreement","request":{"name":"Get agreement","description":{"content":"Retrieves the details of an existing agreement. You need to supply the unique agreement identifier that was returned upon agreement creation.\n","type":"text/plain"},"url":{"path":["agreements",":agreementId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"agreementId","disabled":false,"description":{"content":"(Required) The ID of the agreement to retrieve.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"f3e0655a-2fba-4c35-b50b-2b56d7408d14","name":"The agreement details","originalRequest":{"url":{"path":["agreements",":agreementId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"customerId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"invoiceEmail\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"eInvoicing\": {\n    \"enabled\": \"<boolean>\",\n    \"ean\": \"8387865492349\",\n    \"contactId\": \"<string>\"\n  },\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"balance\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"isOverdue\": \"<boolean>\",\n  \"metaData\": {\n    \"pariatur_59\": \"<string>\",\n    \"eiusmod96\": \"<string>\",\n    \"labored5d\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4bd5171d-acf4-4345-ab1e-93fc3d6e7368","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["agreements",":agreementId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"924b53d8-fe4b-422b-bdeb-2249f2263698","name":"Update agreement","request":{"name":"Update agreement","description":{"content":"Updates an agreement for a customer.\n","type":"text/plain"},"url":{"path":["agreements",":agreementId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"agreementId","disabled":false,"description":{"content":"(Required) The ID of the agreement to update.","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"invoiceEmail\": \"<string>\",\n  \"eInvoicing\": {\n    \"enabled\": \"<boolean>\",\n    \"ean\": \"9363641719206\",\n    \"contactId\": \"<string>\"\n  },\n  \"metaData\": {\n    \"enim_a4\": \"<string>\",\n    \"proident3b2\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"4132c464-d501-4775-b50d-2f8514f5357a","name":"The created agreement","originalRequest":{"url":{"path":["agreements",":agreementId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"invoiceEmail\": \"<string>\",\n  \"eInvoicing\": {\n    \"enabled\": \"<boolean>\",\n    \"ean\": \"9363641719206\",\n    \"contactId\": \"<string>\"\n  },\n  \"metaData\": {\n    \"enim_a4\": \"<string>\",\n    \"proident3b2\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"customerId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"invoiceEmail\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"eInvoicing\": {\n    \"enabled\": \"<boolean>\",\n    \"ean\": \"8387865492349\",\n    \"contactId\": \"<string>\"\n  },\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"balance\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"isOverdue\": \"<boolean>\",\n  \"metaData\": {\n    \"pariatur_59\": \"<string>\",\n    \"eiusmod96\": \"<string>\",\n    \"labored5d\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"292eba92-f91d-466d-996f-36634faeb8a9","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["agreements",":agreementId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"invoiceEmail\": \"<string>\",\n  \"eInvoicing\": {\n    \"enabled\": \"<boolean>\",\n    \"ean\": \"9363641719206\",\n    \"contactId\": \"<string>\"\n  },\n  \"metaData\": {\n    \"enim_a4\": \"<string>\",\n    \"proident3b2\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3d7003a4-fa35-4db4-a7f4-04e2fb0084d0","name":"Delete agreement","request":{"name":"Delete agreement","description":{"content":"Deletes an agreement if there are no subscriptions, invoices or transactions attached.\n","type":"text/plain"},"url":{"path":["agreements",":agreementId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"agreementId","disabled":false,"description":{"content":"(Required) The ID of the agreement to delete.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"a75c8300-da79-40b5-8b51-2e077656af2a","name":"Agreement deleted","originalRequest":{"url":{"path":["agreements",":agreementId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aa8f2603-0cb1-45c1-8973-9934deb29f9b","name":"Cannot delete agreement with attached subscriptions","originalRequest":{"url":{"path":["agreements",":agreementId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"69a4ebc8-41f8-4258-92dd-5e2d5952aa33","name":"404 response","originalRequest":{"url":{"path":["agreements",":agreementId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[],"cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f9ad3e40-7e2c-49ff-8bbd-b546fe4f0fa8","name":"Register payment","request":{"name":"Register payment","description":{"content":"Register an external payment on the agreement.\n","type":"text/plain"},"url":{"path":["agreements",":agreementId","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"agreementId","disabled":false,"description":{"content":"(Required) The ID of the agreement to register the payment on.","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"paymentDate\": \"<date>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"note\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"99850215-617f-4ae6-8702-f65401670f35","name":"The transaction and payment created for the payment","originalRequest":{"url":{"path":["agreements",":agreementId","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"paymentDate\": \"<date>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"note\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"transaction\": {\n    \"id\": \"<string>\",\n    \"accountId\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"agreementId\": \"<string>\",\n    \"amount\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"balance\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"transactionNumber\": \"<integer>\",\n    \"invoiceId\": \"<string>\",\n    \"creditNoteId\": \"<string>\",\n    \"paymentId\": \"<string>\",\n    \"issuedAt\": \"<dateTime>\",\n    \"dueDate\": \"<date>\",\n    \"paymentDate\": \"<date>\",\n    \"type\": \"CreditNoteIssued\"\n  },\n  \"payment\": {\n    \"id\": \"<string>\",\n    \"accountId\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"agreementId\": \"<string>\",\n    \"invoiceId\": \"<string>\",\n    \"paymentDate\": \"<date>\",\n    \"amount\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"handleBy\": \"External\",\n    \"note\": \"<string>\",\n    \"status\": \"Reversed\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"16918b6b-66c6-4b0c-bdf8-ddda578f5d1e","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["agreements",":agreementId","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"paymentDate\": \"<date>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"note\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Subscriptions","description":"Operations related to subscriptions.\n","item":[{"id":"06f4f2d9-dcd0-4197-880d-6e145208e004","name":"List subscriptions","request":{"name":"List subscriptions","description":{"content":"Retrieves a list of subscriptions for an agreement.\n\nThis endpoint supports [pagination](https://docs.properpayments.io/get-started/api-setup/pagination).\n","type":"text/plain"},"url":{"path":["subscriptions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the customer of the subscription.","type":"text/plain"},"key":"customerId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the agreement of the subscription.","type":"text/plain"},"key":"agreementId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the product of the subscription.","type":"text/plain"},"key":"productId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the billing scheme of the subscription.","type":"text/plain"},"key":"billingScheme","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"d1b45099-a7ac-493d-8198-1f5c86fcf178","name":"A list of subscriptions","originalRequest":{"url":{"path":["subscriptions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the customer of the subscription.","type":"text/plain"},"key":"customerId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the agreement of the subscription.","type":"text/plain"},"key":"agreementId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the product of the subscription.","type":"text/plain"},"key":"productId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the billing scheme of the subscription.","type":"text/plain"},"key":"billingScheme","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"subscriptions\": [\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"agreementId\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"billingStartDate\": \"<date>\",\n      \"initialBilling\": \"NoCharge\",\n      \"billingScheme\": \"Metered\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Graduated\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"quantity\": \"<integer>\",\n      \"taxRateId\": \"<string>\",\n      \"billingFrequency\": {\n        \"interval\": \"Week\",\n        \"intervalCount\": \"<integer>\"\n      },\n      \"paymentTerms\": {\n        \"timing\": \"PayInArrears\",\n        \"fixedBy\": \"DueDate\",\n        \"dayOfCycle\": \"<integer>\",\n        \"dueOffsetDays\": \"<integer>\",\n        \"dueOffsetUnit\": \"Day\"\n      },\n      \"startDate\": \"<date>\",\n      \"endDate\": \"<date>\",\n      \"endReason\": \"<string>\",\n      \"nextBillingPeriodStartDate\": \"<date>\",\n      \"metaData\": {\n        \"Excepteura_\": \"<string>\",\n        \"in_d87\": \"<string>\"\n      },\n      \"issuedBillingPeriods\": [\n        {\n          \"billingPeriod\": \"<string>\",\n          \"issueDate\": \"<date>\",\n          \"dueDate\": \"<date>\",\n          \"lineItems\": [\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            },\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            }\n          ]\n        },\n        {\n          \"billingPeriod\": \"<string>\",\n          \"issueDate\": \"<date>\",\n          \"dueDate\": \"<date>\",\n          \"lineItems\": [\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            },\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            }\n          ]\n        }\n      ],\n      \"appliedChanges\": [\n        {\n          \"id\": \"<string>\",\n          \"effectiveDate\": \"<date>\",\n          \"quantity\": \"<integer>\",\n          \"pricing\": {\n            \"unitPrice\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"tiered\": {\n              \"tierType\": \"Volume\",\n              \"tiers\": [\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                },\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                }\n              ]\n            }\n          },\n          \"taxRateId\": \"<string>\"\n        },\n        {\n          \"id\": \"<string>\",\n          \"effectiveDate\": \"<date>\",\n          \"quantity\": \"<integer>\",\n          \"pricing\": {\n            \"unitPrice\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"tiered\": {\n              \"tierType\": \"Graduated\",\n              \"tiers\": [\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                },\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                }\n              ]\n            }\n          },\n          \"taxRateId\": \"<string>\"\n        }\n      ],\n      \"pendingChanges\": [\n        {\n          \"id\": \"<string>\",\n          \"effectiveDate\": \"<date>\",\n          \"quantity\": \"<integer>\",\n          \"pricing\": {\n            \"unitPrice\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"tiered\": {\n              \"tierType\": \"Graduated\",\n              \"tiers\": [\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                },\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                }\n              ]\n            }\n          },\n          \"taxRateId\": \"<string>\"\n        },\n        {\n          \"id\": \"<string>\",\n          \"effectiveDate\": \"<date>\",\n          \"quantity\": \"<integer>\",\n          \"pricing\": {\n            \"unitPrice\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"tiered\": {\n              \"tierType\": \"Volume\",\n              \"tiers\": [\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                },\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                }\n              ]\n            }\n          },\n          \"taxRateId\": \"<string>\"\n        }\n      ],\n      \"customDescription\": \"<string>\",\n      \"autoAdvance\": \"<boolean>\",\n      \"pendingBillingPeriods\": [\n        {\n          \"billingPeriod\": \"<string>\",\n          \"issueDate\": \"<date>\",\n          \"dueDate\": \"<date>\",\n          \"subtotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vatTotals\": [\n            {\n              \"total\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"vat\": {\n                \"rate\": \"<number>\",\n                \"taxRateId\": \"<string>\",\n                \"taxMode\": \"Exempt\"\n              }\n            },\n            {\n              \"total\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"vat\": {\n                \"rate\": \"<number>\",\n                \"taxRateId\": \"<string>\",\n                \"taxMode\": \"Inclusive\"\n              }\n            }\n          ],\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"lineItems\": [\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            },\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            }\n          ]\n        },\n        {\n          \"billingPeriod\": \"<string>\",\n          \"issueDate\": \"<date>\",\n          \"dueDate\": \"<date>\",\n          \"subtotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vatTotals\": [\n            {\n              \"total\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"vat\": {\n                \"rate\": \"<number>\",\n                \"taxRateId\": \"<string>\",\n                \"taxMode\": \"Exclusive\"\n              }\n            },\n            {\n              \"total\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"vat\": {\n                \"rate\": \"<number>\",\n                \"taxRateId\": \"<string>\",\n                \"taxMode\": \"Exempt\"\n              }\n            }\n          ],\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"lineItems\": [\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            },\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            }\n          ]\n        }\n      ],\n      \"currentBillingPeriod\": {\n        \"billingPeriod\": \"<string>\",\n        \"issueDate\": \"<date>\",\n        \"dueDate\": \"<date>\",\n        \"subtotal\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"vatTotals\": [\n          {\n            \"total\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"vat\": {\n              \"rate\": \"<number>\",\n              \"taxRateId\": \"<string>\",\n              \"taxMode\": \"ReverseCharge\"\n            }\n          },\n          {\n            \"total\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"vat\": {\n              \"rate\": \"<number>\",\n              \"taxRateId\": \"<string>\",\n              \"taxMode\": \"ReverseCharge\"\n            }\n          }\n        ],\n        \"total\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"lineItems\": [\n          {\n            \"subscriptionId\": \"<string>\",\n            \"productId\": \"<string>\",\n            \"unitPrice\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"quantity\": \"<integer>\",\n            \"price\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"subTotal\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"taxRateId\": \"<string>\",\n            \"billingPeriod\": \"<string>\",\n            \"appliedPeriod\": \"<string>\",\n            \"hideBillingPeriod\": \"<boolean>\"\n          },\n          {\n            \"subscriptionId\": \"<string>\",\n            \"productId\": \"<string>\",\n            \"unitPrice\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"quantity\": \"<integer>\",\n            \"price\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"subTotal\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"taxRateId\": \"<string>\",\n            \"billingPeriod\": \"<string>\",\n            \"appliedPeriod\": \"<string>\",\n            \"hideBillingPeriod\": \"<boolean>\"\n          }\n        ]\n      },\n      \"hideBillingPeriod\": \"<boolean>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"agreementId\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"billingStartDate\": \"<date>\",\n      \"initialBilling\": \"NoCharge\",\n      \"billingScheme\": \"Metered\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Volume\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"quantity\": \"<integer>\",\n      \"taxRateId\": \"<string>\",\n      \"billingFrequency\": {\n        \"interval\": \"Year\",\n        \"intervalCount\": \"<integer>\"\n      },\n      \"paymentTerms\": {\n        \"timing\": \"PayInArrears\",\n        \"fixedBy\": \"DueDate\",\n        \"dayOfCycle\": \"<integer>\",\n        \"dueOffsetDays\": \"<integer>\",\n        \"dueOffsetUnit\": \"BankDay\"\n      },\n      \"startDate\": \"<date>\",\n      \"endDate\": \"<date>\",\n      \"endReason\": \"<string>\",\n      \"nextBillingPeriodStartDate\": \"<date>\",\n      \"metaData\": {\n        \"consequat951\": \"<string>\",\n        \"officia0\": \"<string>\",\n        \"adipisicing_f\": \"<string>\",\n        \"voluptate9\": \"<string>\"\n      },\n      \"issuedBillingPeriods\": [\n        {\n          \"billingPeriod\": \"<string>\",\n          \"issueDate\": \"<date>\",\n          \"dueDate\": \"<date>\",\n          \"lineItems\": [\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            },\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            }\n          ]\n        },\n        {\n          \"billingPeriod\": \"<string>\",\n          \"issueDate\": \"<date>\",\n          \"dueDate\": \"<date>\",\n          \"lineItems\": [\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            },\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            }\n          ]\n        }\n      ],\n      \"appliedChanges\": [\n        {\n          \"id\": \"<string>\",\n          \"effectiveDate\": \"<date>\",\n          \"quantity\": \"<integer>\",\n          \"pricing\": {\n            \"unitPrice\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"tiered\": {\n              \"tierType\": \"Graduated\",\n              \"tiers\": [\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                },\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                }\n              ]\n            }\n          },\n          \"taxRateId\": \"<string>\"\n        },\n        {\n          \"id\": \"<string>\",\n          \"effectiveDate\": \"<date>\",\n          \"quantity\": \"<integer>\",\n          \"pricing\": {\n            \"unitPrice\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"tiered\": {\n              \"tierType\": \"Volume\",\n              \"tiers\": [\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                },\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                }\n              ]\n            }\n          },\n          \"taxRateId\": \"<string>\"\n        }\n      ],\n      \"pendingChanges\": [\n        {\n          \"id\": \"<string>\",\n          \"effectiveDate\": \"<date>\",\n          \"quantity\": \"<integer>\",\n          \"pricing\": {\n            \"unitPrice\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"tiered\": {\n              \"tierType\": \"Volume\",\n              \"tiers\": [\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                },\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                }\n              ]\n            }\n          },\n          \"taxRateId\": \"<string>\"\n        },\n        {\n          \"id\": \"<string>\",\n          \"effectiveDate\": \"<date>\",\n          \"quantity\": \"<integer>\",\n          \"pricing\": {\n            \"unitPrice\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"tiered\": {\n              \"tierType\": \"Volume\",\n              \"tiers\": [\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                },\n                {\n                  \"upTo\": \"<integer>\",\n                  \"unitPrice\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  },\n                  \"flatFee\": {\n                    \"currency\": \"<string>\",\n                    \"amount\": \"<number>\"\n                  }\n                }\n              ]\n            }\n          },\n          \"taxRateId\": \"<string>\"\n        }\n      ],\n      \"customDescription\": \"<string>\",\n      \"autoAdvance\": \"<boolean>\",\n      \"pendingBillingPeriods\": [\n        {\n          \"billingPeriod\": \"<string>\",\n          \"issueDate\": \"<date>\",\n          \"dueDate\": \"<date>\",\n          \"subtotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vatTotals\": [\n            {\n              \"total\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"vat\": {\n                \"rate\": \"<number>\",\n                \"taxRateId\": \"<string>\",\n                \"taxMode\": \"Inclusive\"\n              }\n            },\n            {\n              \"total\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"vat\": {\n                \"rate\": \"<number>\",\n                \"taxRateId\": \"<string>\",\n                \"taxMode\": \"Exclusive\"\n              }\n            }\n          ],\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"lineItems\": [\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            },\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            }\n          ]\n        },\n        {\n          \"billingPeriod\": \"<string>\",\n          \"issueDate\": \"<date>\",\n          \"dueDate\": \"<date>\",\n          \"subtotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vatTotals\": [\n            {\n              \"total\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"vat\": {\n                \"rate\": \"<number>\",\n                \"taxRateId\": \"<string>\",\n                \"taxMode\": \"ReverseCharge\"\n              }\n            },\n            {\n              \"total\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"vat\": {\n                \"rate\": \"<number>\",\n                \"taxRateId\": \"<string>\",\n                \"taxMode\": \"Exclusive\"\n              }\n            }\n          ],\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"lineItems\": [\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            },\n            {\n              \"subscriptionId\": \"<string>\",\n              \"productId\": \"<string>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"quantity\": \"<integer>\",\n              \"price\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"subTotal\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"taxRateId\": \"<string>\",\n              \"billingPeriod\": \"<string>\",\n              \"appliedPeriod\": \"<string>\",\n              \"hideBillingPeriod\": \"<boolean>\"\n            }\n          ]\n        }\n      ],\n      \"currentBillingPeriod\": {\n        \"billingPeriod\": \"<string>\",\n        \"issueDate\": \"<date>\",\n        \"dueDate\": \"<date>\",\n        \"subtotal\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"vatTotals\": [\n          {\n            \"total\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"vat\": {\n              \"rate\": \"<number>\",\n              \"taxRateId\": \"<string>\",\n              \"taxMode\": \"Exclusive\"\n            }\n          },\n          {\n            \"total\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"vat\": {\n              \"rate\": \"<number>\",\n              \"taxRateId\": \"<string>\",\n              \"taxMode\": \"Inclusive\"\n            }\n          }\n        ],\n        \"total\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"lineItems\": [\n          {\n            \"subscriptionId\": \"<string>\",\n            \"productId\": \"<string>\",\n            \"unitPrice\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"quantity\": \"<integer>\",\n            \"price\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"subTotal\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"taxRateId\": \"<string>\",\n            \"billingPeriod\": \"<string>\",\n            \"appliedPeriod\": \"<string>\",\n            \"hideBillingPeriod\": \"<boolean>\"\n          },\n          {\n            \"subscriptionId\": \"<string>\",\n            \"productId\": \"<string>\",\n            \"unitPrice\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"quantity\": \"<integer>\",\n            \"price\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"subTotal\": {\n              \"currency\": \"<string>\",\n              \"amount\": \"<number>\"\n            },\n            \"taxRateId\": \"<string>\",\n            \"billingPeriod\": \"<string>\",\n            \"appliedPeriod\": \"<string>\",\n            \"hideBillingPeriod\": \"<boolean>\"\n          }\n        ]\n      },\n      \"hideBillingPeriod\": \"<boolean>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e0aa8663-4a02-4ed8-bf86-e6f636b79192","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["subscriptions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the customer of the subscription.","type":"text/plain"},"key":"customerId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the agreement of the subscription.","type":"text/plain"},"key":"agreementId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the product of the subscription.","type":"text/plain"},"key":"productId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the billing scheme of the subscription.","type":"text/plain"},"key":"billingScheme","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"071af0fc-82d4-40a5-b7e9-8dec9233383b","name":"Create subscription","request":{"name":"Create subscription","description":{"content":"Creates a new subscription for an agreement.\n","type":"text/plain"},"url":{"path":["subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"billingStartDate\": \"<date>\",\n  \"agreementId\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"taxRateId\": \"<string>\",\n  \"billingScheme\": \"Licensed\",\n  \"paymentTerms\": {\n    \"timing\": \"PayInArrears\",\n    \"fixedBy\": \"IssueDate\",\n    \"dayOfCycle\": \"<integer>\",\n    \"dueOffsetDays\": \"<integer>\",\n    \"dueOffsetUnit\": \"BankDay\"\n  },\n  \"startDate\": \"<date>\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Volume\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"billingFrequency\": {\n    \"interval\": \"Year\",\n    \"intervalCount\": \"<integer>\"\n  },\n  \"initialBilling\": \"NoCharge\",\n  \"metaData\": {\n    \"ex_2be\": \"<string>\",\n    \"aute_926\": \"<string>\",\n    \"Excepteur_d\": \"<string>\",\n    \"id_40\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\",\n  \"customDescription\": \"<string>\",\n  \"endDate\": \"<date>\",\n  \"hideBillingPeriod\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"d73af253-8dc4-4475-82aa-5bedb0a79f2e","name":"The created subscription","originalRequest":{"url":{"path":["subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"billingStartDate\": \"<date>\",\n  \"agreementId\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"taxRateId\": \"<string>\",\n  \"billingScheme\": \"Licensed\",\n  \"paymentTerms\": {\n    \"timing\": \"PayInArrears\",\n    \"fixedBy\": \"IssueDate\",\n    \"dayOfCycle\": \"<integer>\",\n    \"dueOffsetDays\": \"<integer>\",\n    \"dueOffsetUnit\": \"BankDay\"\n  },\n  \"startDate\": \"<date>\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Volume\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"billingFrequency\": {\n    \"interval\": \"Year\",\n    \"intervalCount\": \"<integer>\"\n  },\n  \"initialBilling\": \"NoCharge\",\n  \"metaData\": {\n    \"ex_2be\": \"<string>\",\n    \"aute_926\": \"<string>\",\n    \"Excepteur_d\": \"<string>\",\n    \"id_40\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\",\n  \"customDescription\": \"<string>\",\n  \"endDate\": \"<date>\",\n  \"hideBillingPeriod\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"billingStartDate\": \"<date>\",\n  \"initialBilling\": \"NoCharge\",\n  \"billingScheme\": \"Metered\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Graduated\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\",\n  \"billingFrequency\": {\n    \"interval\": \"Year\",\n    \"intervalCount\": \"<integer>\"\n  },\n  \"paymentTerms\": {\n    \"timing\": \"PayInArrears\",\n    \"fixedBy\": \"IssueDate\",\n    \"dayOfCycle\": \"<integer>\",\n    \"dueOffsetDays\": \"<integer>\",\n    \"dueOffsetUnit\": \"BankDay\"\n  },\n  \"startDate\": \"<date>\",\n  \"endDate\": \"<date>\",\n  \"endReason\": \"<string>\",\n  \"nextBillingPeriodStartDate\": \"<date>\",\n  \"metaData\": {\n    \"adipisicing_e0b\": \"<string>\"\n  },\n  \"issuedBillingPeriods\": [\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    },\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    }\n  ],\n  \"appliedChanges\": [\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Volume\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Graduated\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    }\n  ],\n  \"pendingChanges\": [\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Volume\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Volume\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    }\n  ],\n  \"customDescription\": \"<string>\",\n  \"autoAdvance\": \"<boolean>\",\n  \"pendingBillingPeriods\": [\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vatTotals\": [\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Exclusive\"\n          }\n        },\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Exclusive\"\n          }\n        }\n      ],\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    },\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vatTotals\": [\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Inclusive\"\n          }\n        },\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Inclusive\"\n          }\n        }\n      ],\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    }\n  ],\n  \"currentBillingPeriod\": {\n    \"billingPeriod\": \"<string>\",\n    \"issueDate\": \"<date>\",\n    \"dueDate\": \"<date>\",\n    \"subtotal\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"vatTotals\": [\n      {\n        \"total\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"vat\": {\n          \"rate\": \"<number>\",\n          \"taxRateId\": \"<string>\",\n          \"taxMode\": \"Exempt\"\n        }\n      },\n      {\n        \"total\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"vat\": {\n          \"rate\": \"<number>\",\n          \"taxRateId\": \"<string>\",\n          \"taxMode\": \"Inclusive\"\n        }\n      }\n    ],\n    \"total\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"lineItems\": [\n      {\n        \"subscriptionId\": \"<string>\",\n        \"productId\": \"<string>\",\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"quantity\": \"<integer>\",\n        \"price\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"subTotal\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"taxRateId\": \"<string>\",\n        \"billingPeriod\": \"<string>\",\n        \"appliedPeriod\": \"<string>\",\n        \"hideBillingPeriod\": \"<boolean>\"\n      },\n      {\n        \"subscriptionId\": \"<string>\",\n        \"productId\": \"<string>\",\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"quantity\": \"<integer>\",\n        \"price\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"subTotal\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"taxRateId\": \"<string>\",\n        \"billingPeriod\": \"<string>\",\n        \"appliedPeriod\": \"<string>\",\n        \"hideBillingPeriod\": \"<boolean>\"\n      }\n    ]\n  },\n  \"hideBillingPeriod\": \"<boolean>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"17426aec-cd03-46de-9971-78f67c970d52","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"billingStartDate\": \"<date>\",\n  \"agreementId\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"taxRateId\": \"<string>\",\n  \"billingScheme\": \"Licensed\",\n  \"paymentTerms\": {\n    \"timing\": \"PayInArrears\",\n    \"fixedBy\": \"IssueDate\",\n    \"dayOfCycle\": \"<integer>\",\n    \"dueOffsetDays\": \"<integer>\",\n    \"dueOffsetUnit\": \"BankDay\"\n  },\n  \"startDate\": \"<date>\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Volume\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"billingFrequency\": {\n    \"interval\": \"Year\",\n    \"intervalCount\": \"<integer>\"\n  },\n  \"initialBilling\": \"NoCharge\",\n  \"metaData\": {\n    \"ex_2be\": \"<string>\",\n    \"aute_926\": \"<string>\",\n    \"Excepteur_d\": \"<string>\",\n    \"id_40\": \"<string>\"\n  },\n  \"autoAdvance\": \"<boolean>\",\n  \"customDescription\": \"<string>\",\n  \"endDate\": \"<date>\",\n  \"hideBillingPeriod\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ae6fc48c-211d-4923-a720-e2e91e16654e","name":"Get subscription","request":{"name":"Get subscription","description":{"content":"Retrieves the details of an existing subscription. You need to supply the unique subscription identifier that was returned upon subscription creation.\n","type":"text/plain"},"url":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"subscriptionId","disabled":false,"description":{"content":"(Required) The ID of the subscription to retrieve.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"45a89b29-670d-401d-b7b9-c0c070d69bff","name":"The subscription details","originalRequest":{"url":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"billingStartDate\": \"<date>\",\n  \"initialBilling\": \"NoCharge\",\n  \"billingScheme\": \"Metered\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Graduated\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\",\n  \"billingFrequency\": {\n    \"interval\": \"Year\",\n    \"intervalCount\": \"<integer>\"\n  },\n  \"paymentTerms\": {\n    \"timing\": \"PayInArrears\",\n    \"fixedBy\": \"IssueDate\",\n    \"dayOfCycle\": \"<integer>\",\n    \"dueOffsetDays\": \"<integer>\",\n    \"dueOffsetUnit\": \"BankDay\"\n  },\n  \"startDate\": \"<date>\",\n  \"endDate\": \"<date>\",\n  \"endReason\": \"<string>\",\n  \"nextBillingPeriodStartDate\": \"<date>\",\n  \"metaData\": {\n    \"adipisicing_e0b\": \"<string>\"\n  },\n  \"issuedBillingPeriods\": [\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    },\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    }\n  ],\n  \"appliedChanges\": [\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Volume\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Graduated\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    }\n  ],\n  \"pendingChanges\": [\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Volume\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Volume\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    }\n  ],\n  \"customDescription\": \"<string>\",\n  \"autoAdvance\": \"<boolean>\",\n  \"pendingBillingPeriods\": [\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vatTotals\": [\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Exclusive\"\n          }\n        },\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Exclusive\"\n          }\n        }\n      ],\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    },\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vatTotals\": [\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Inclusive\"\n          }\n        },\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Inclusive\"\n          }\n        }\n      ],\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    }\n  ],\n  \"currentBillingPeriod\": {\n    \"billingPeriod\": \"<string>\",\n    \"issueDate\": \"<date>\",\n    \"dueDate\": \"<date>\",\n    \"subtotal\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"vatTotals\": [\n      {\n        \"total\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"vat\": {\n          \"rate\": \"<number>\",\n          \"taxRateId\": \"<string>\",\n          \"taxMode\": \"Exempt\"\n        }\n      },\n      {\n        \"total\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"vat\": {\n          \"rate\": \"<number>\",\n          \"taxRateId\": \"<string>\",\n          \"taxMode\": \"Inclusive\"\n        }\n      }\n    ],\n    \"total\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"lineItems\": [\n      {\n        \"subscriptionId\": \"<string>\",\n        \"productId\": \"<string>\",\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"quantity\": \"<integer>\",\n        \"price\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"subTotal\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"taxRateId\": \"<string>\",\n        \"billingPeriod\": \"<string>\",\n        \"appliedPeriod\": \"<string>\",\n        \"hideBillingPeriod\": \"<boolean>\"\n      },\n      {\n        \"subscriptionId\": \"<string>\",\n        \"productId\": \"<string>\",\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"quantity\": \"<integer>\",\n        \"price\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"subTotal\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"taxRateId\": \"<string>\",\n        \"billingPeriod\": \"<string>\",\n        \"appliedPeriod\": \"<string>\",\n        \"hideBillingPeriod\": \"<boolean>\"\n      }\n    ]\n  },\n  \"hideBillingPeriod\": \"<boolean>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"020a740f-c53d-4048-b283-5e3290edee3f","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a1bb832f-bc02-44cc-8e72-8f3952e6e142","name":"Delete subscription","request":{"name":"Delete subscription","description":{"content":"Delete the subscription. You need to supply the unique subscription identifier that was returned upon subscription creation.\n","type":"text/plain"},"url":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"subscriptionId","disabled":false,"description":{"content":"(Required) The ID of the subscription to delete.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"b7389321-6cf7-4cb7-aed4-c85786e6a25f","name":"A blank json object","originalRequest":{"url":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"79b166a1-d2fd-4b41-8bce-cdc04954f9e7","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"49ee4c3c-bbaf-480f-8b08-fd40c51ca00d","name":"Update subscription","request":{"name":"Update subscription","description":{"content":"Update the subscription. You need to supply the unique subscription identifier that was returned upon subscription creation.\n","type":"text/plain"},"url":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"subscriptionId","disabled":false,"description":{"content":"(Required) The ID of the subscription to update.","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"productId\": \"<string>\",\n  \"metaData\": {\n    \"eaa4c\": \"<string>\",\n    \"ut_5\": \"<string>\",\n    \"velit_6b\": \"<string>\",\n    \"pariaturbdb\": \"<string>\"\n  },\n  \"startDate\": \"<date>\",\n  \"endDate\": \"<date>\",\n  \"endReason\": \"<string>\",\n  \"initialBilling\": \"NoCharge\",\n  \"autoAdvance\": \"<boolean>\",\n  \"billingStartDate\": \"<date>\",\n  \"billingFrequency\": {\n    \"interval\": \"Year\",\n    \"intervalCount\": \"<integer>\"\n  },\n  \"paymentTerms\": {\n    \"timing\": \"PayInArrears\",\n    \"fixedBy\": \"IssueDate\",\n    \"dayOfCycle\": \"<integer>\",\n    \"dueOffsetDays\": \"<integer>\",\n    \"dueOffsetUnit\": \"BankDay\"\n  },\n  \"customDescription\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"removeEndDate\": \"<boolean>\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Volume\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\",\n  \"billingScheme\": \"Metered\",\n  \"prorationType\": \"PeriodStart\",\n  \"prorationDate\": \"<date>\",\n  \"hideBillingPeriod\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"39bbb008-1002-4f5d-ba1e-c8f83526ad6f","name":"The subscription details","originalRequest":{"url":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"productId\": \"<string>\",\n  \"metaData\": {\n    \"eaa4c\": \"<string>\",\n    \"ut_5\": \"<string>\",\n    \"velit_6b\": \"<string>\",\n    \"pariaturbdb\": \"<string>\"\n  },\n  \"startDate\": \"<date>\",\n  \"endDate\": \"<date>\",\n  \"endReason\": \"<string>\",\n  \"initialBilling\": \"NoCharge\",\n  \"autoAdvance\": \"<boolean>\",\n  \"billingStartDate\": \"<date>\",\n  \"billingFrequency\": {\n    \"interval\": \"Year\",\n    \"intervalCount\": \"<integer>\"\n  },\n  \"paymentTerms\": {\n    \"timing\": \"PayInArrears\",\n    \"fixedBy\": \"IssueDate\",\n    \"dayOfCycle\": \"<integer>\",\n    \"dueOffsetDays\": \"<integer>\",\n    \"dueOffsetUnit\": \"BankDay\"\n  },\n  \"customDescription\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"removeEndDate\": \"<boolean>\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Volume\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\",\n  \"billingScheme\": \"Metered\",\n  \"prorationType\": \"PeriodStart\",\n  \"prorationDate\": \"<date>\",\n  \"hideBillingPeriod\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"billingStartDate\": \"<date>\",\n  \"initialBilling\": \"NoCharge\",\n  \"billingScheme\": \"Metered\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Graduated\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\",\n  \"billingFrequency\": {\n    \"interval\": \"Year\",\n    \"intervalCount\": \"<integer>\"\n  },\n  \"paymentTerms\": {\n    \"timing\": \"PayInArrears\",\n    \"fixedBy\": \"IssueDate\",\n    \"dayOfCycle\": \"<integer>\",\n    \"dueOffsetDays\": \"<integer>\",\n    \"dueOffsetUnit\": \"BankDay\"\n  },\n  \"startDate\": \"<date>\",\n  \"endDate\": \"<date>\",\n  \"endReason\": \"<string>\",\n  \"nextBillingPeriodStartDate\": \"<date>\",\n  \"metaData\": {\n    \"adipisicing_e0b\": \"<string>\"\n  },\n  \"issuedBillingPeriods\": [\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    },\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    }\n  ],\n  \"appliedChanges\": [\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Volume\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Graduated\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    }\n  ],\n  \"pendingChanges\": [\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Volume\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Volume\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    }\n  ],\n  \"customDescription\": \"<string>\",\n  \"autoAdvance\": \"<boolean>\",\n  \"pendingBillingPeriods\": [\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vatTotals\": [\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Exclusive\"\n          }\n        },\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Exclusive\"\n          }\n        }\n      ],\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    },\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vatTotals\": [\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Inclusive\"\n          }\n        },\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Inclusive\"\n          }\n        }\n      ],\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    }\n  ],\n  \"currentBillingPeriod\": {\n    \"billingPeriod\": \"<string>\",\n    \"issueDate\": \"<date>\",\n    \"dueDate\": \"<date>\",\n    \"subtotal\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"vatTotals\": [\n      {\n        \"total\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"vat\": {\n          \"rate\": \"<number>\",\n          \"taxRateId\": \"<string>\",\n          \"taxMode\": \"Exempt\"\n        }\n      },\n      {\n        \"total\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"vat\": {\n          \"rate\": \"<number>\",\n          \"taxRateId\": \"<string>\",\n          \"taxMode\": \"Inclusive\"\n        }\n      }\n    ],\n    \"total\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"lineItems\": [\n      {\n        \"subscriptionId\": \"<string>\",\n        \"productId\": \"<string>\",\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"quantity\": \"<integer>\",\n        \"price\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"subTotal\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"taxRateId\": \"<string>\",\n        \"billingPeriod\": \"<string>\",\n        \"appliedPeriod\": \"<string>\",\n        \"hideBillingPeriod\": \"<boolean>\"\n      },\n      {\n        \"subscriptionId\": \"<string>\",\n        \"productId\": \"<string>\",\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"quantity\": \"<integer>\",\n        \"price\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"subTotal\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"taxRateId\": \"<string>\",\n        \"billingPeriod\": \"<string>\",\n        \"appliedPeriod\": \"<string>\",\n        \"hideBillingPeriod\": \"<boolean>\"\n      }\n    ]\n  },\n  \"hideBillingPeriod\": \"<boolean>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5e34f74c-bf4a-4754-b834-907b7fb6e656","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["subscriptions",":subscriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"productId\": \"<string>\",\n  \"metaData\": {\n    \"eaa4c\": \"<string>\",\n    \"ut_5\": \"<string>\",\n    \"velit_6b\": \"<string>\",\n    \"pariaturbdb\": \"<string>\"\n  },\n  \"startDate\": \"<date>\",\n  \"endDate\": \"<date>\",\n  \"endReason\": \"<string>\",\n  \"initialBilling\": \"NoCharge\",\n  \"autoAdvance\": \"<boolean>\",\n  \"billingStartDate\": \"<date>\",\n  \"billingFrequency\": {\n    \"interval\": \"Year\",\n    \"intervalCount\": \"<integer>\"\n  },\n  \"paymentTerms\": {\n    \"timing\": \"PayInArrears\",\n    \"fixedBy\": \"IssueDate\",\n    \"dayOfCycle\": \"<integer>\",\n    \"dueOffsetDays\": \"<integer>\",\n    \"dueOffsetUnit\": \"BankDay\"\n  },\n  \"customDescription\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"removeEndDate\": \"<boolean>\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Volume\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\",\n  \"billingScheme\": \"Metered\",\n  \"prorationType\": \"PeriodStart\",\n  \"prorationDate\": \"<date>\",\n  \"hideBillingPeriod\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2fb6da13-c939-497a-9d4c-a327a237928e","name":"Schedule a change to the subscription","request":{"name":"Schedule a change to the subscription","description":{"content":"Schedules a change to the subscription on the provided date.\n","type":"text/plain"},"url":{"path":["subscriptions",":subscriptionId","changes"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"subscriptionId","disabled":false,"description":{"content":"(Required) The ID of the subscription.","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"effectiveDateType\": \"Date\",\n  \"effectiveDate\": \"<date>\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Volume\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"a13668b5-82b9-4ab3-8790-e6709e4b415b","name":"The subscription details","originalRequest":{"url":{"path":["subscriptions",":subscriptionId","changes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"effectiveDateType\": \"Date\",\n  \"effectiveDate\": \"<date>\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Volume\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"productId\": \"<string>\",\n  \"billingStartDate\": \"<date>\",\n  \"initialBilling\": \"NoCharge\",\n  \"billingScheme\": \"Metered\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Graduated\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\",\n  \"billingFrequency\": {\n    \"interval\": \"Year\",\n    \"intervalCount\": \"<integer>\"\n  },\n  \"paymentTerms\": {\n    \"timing\": \"PayInArrears\",\n    \"fixedBy\": \"IssueDate\",\n    \"dayOfCycle\": \"<integer>\",\n    \"dueOffsetDays\": \"<integer>\",\n    \"dueOffsetUnit\": \"BankDay\"\n  },\n  \"startDate\": \"<date>\",\n  \"endDate\": \"<date>\",\n  \"endReason\": \"<string>\",\n  \"nextBillingPeriodStartDate\": \"<date>\",\n  \"metaData\": {\n    \"adipisicing_e0b\": \"<string>\"\n  },\n  \"issuedBillingPeriods\": [\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    },\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    }\n  ],\n  \"appliedChanges\": [\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Volume\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Graduated\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    }\n  ],\n  \"pendingChanges\": [\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Volume\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"effectiveDate\": \"<date>\",\n      \"quantity\": \"<integer>\",\n      \"pricing\": {\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"tiered\": {\n          \"tierType\": \"Volume\",\n          \"tiers\": [\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            },\n            {\n              \"upTo\": \"<integer>\",\n              \"unitPrice\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              },\n              \"flatFee\": {\n                \"currency\": \"<string>\",\n                \"amount\": \"<number>\"\n              }\n            }\n          ]\n        }\n      },\n      \"taxRateId\": \"<string>\"\n    }\n  ],\n  \"customDescription\": \"<string>\",\n  \"autoAdvance\": \"<boolean>\",\n  \"pendingBillingPeriods\": [\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vatTotals\": [\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Exclusive\"\n          }\n        },\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Exclusive\"\n          }\n        }\n      ],\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    },\n    {\n      \"billingPeriod\": \"<string>\",\n      \"issueDate\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vatTotals\": [\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Inclusive\"\n          }\n        },\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Inclusive\"\n          }\n        }\n      ],\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"lineItems\": [\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"subscriptionId\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subTotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ]\n    }\n  ],\n  \"currentBillingPeriod\": {\n    \"billingPeriod\": \"<string>\",\n    \"issueDate\": \"<date>\",\n    \"dueDate\": \"<date>\",\n    \"subtotal\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"vatTotals\": [\n      {\n        \"total\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"vat\": {\n          \"rate\": \"<number>\",\n          \"taxRateId\": \"<string>\",\n          \"taxMode\": \"Exempt\"\n        }\n      },\n      {\n        \"total\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"vat\": {\n          \"rate\": \"<number>\",\n          \"taxRateId\": \"<string>\",\n          \"taxMode\": \"Inclusive\"\n        }\n      }\n    ],\n    \"total\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"lineItems\": [\n      {\n        \"subscriptionId\": \"<string>\",\n        \"productId\": \"<string>\",\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"quantity\": \"<integer>\",\n        \"price\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"subTotal\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"taxRateId\": \"<string>\",\n        \"billingPeriod\": \"<string>\",\n        \"appliedPeriod\": \"<string>\",\n        \"hideBillingPeriod\": \"<boolean>\"\n      },\n      {\n        \"subscriptionId\": \"<string>\",\n        \"productId\": \"<string>\",\n        \"unitPrice\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"quantity\": \"<integer>\",\n        \"price\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"subTotal\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"taxRateId\": \"<string>\",\n        \"billingPeriod\": \"<string>\",\n        \"appliedPeriod\": \"<string>\",\n        \"hideBillingPeriod\": \"<boolean>\"\n      }\n    ]\n  },\n  \"hideBillingPeriod\": \"<boolean>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"587ae1d8-abaf-4d3b-998e-5a433ca05e68","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["subscriptions",":subscriptionId","changes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"effectiveDateType\": \"Date\",\n  \"effectiveDate\": \"<date>\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Volume\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"74dba98c-eff3-4366-8253-a714ccfd5425","name":"Get a specific change to the subscription.","request":{"name":"Get a specific change to the subscription.","description":{"content":"Fetch a specific change to the subscription.\n","type":"text/plain"},"url":{"path":["subscriptions",":subscriptionId","changes",":changeId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"subscriptionId","disabled":false,"description":{"content":"(Required) The ID of the subscription.","type":"text/plain"}},{"type":"any","value":"<string>","key":"changeId","disabled":false,"description":{"content":"(Required) The ID of the change.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"fedf0c6d-21ef-4955-b184-9133821de744","name":"The subscription details","originalRequest":{"url":{"path":["subscriptions",":subscriptionId","changes",":changeId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"effectiveDate\": \"<date>\",\n  \"quantity\": \"<integer>\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Graduated\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"taxRateId\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2ef658de-127b-4004-961f-9c493ac9e0f7","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["subscriptions",":subscriptionId","changes",":changeId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c25208a1-b6e9-45fd-b549-e1f5f8580e88","name":"Update a specific change to the subscription.","request":{"name":"Update a specific change to the subscription.","description":{"content":"Update a specific change to the subscription.\n","type":"text/plain"},"url":{"path":["subscriptions",":subscriptionId","changes",":changeId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"subscriptionId","disabled":false,"description":{"content":"(Required) The ID of the subscription.","type":"text/plain"}},{"type":"any","value":"<string>","key":"changeId","disabled":false,"description":{"content":"(Required) The ID of the change.","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n  \"effectiveDateType\": \"Date\",\n  \"effectiveDate\": \"<date>\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Volume\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"5def48f6-ff54-43b0-af47-cc0572f8af00","name":"The subscription details","originalRequest":{"url":{"path":["subscriptions",":subscriptionId","changes",":changeId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PUT","body":{"mode":"raw","raw":"{\n  \"effectiveDateType\": \"Date\",\n  \"effectiveDate\": \"<date>\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Volume\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"effectiveDate\": \"<date>\",\n  \"quantity\": \"<integer>\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Graduated\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"taxRateId\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d5660d23-a70e-41c3-813e-c3daa7f4fd4a","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["subscriptions",":subscriptionId","changes",":changeId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PUT","body":{"mode":"raw","raw":"{\n  \"effectiveDateType\": \"Date\",\n  \"effectiveDate\": \"<date>\",\n  \"pricing\": {\n    \"unitPrice\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"tiered\": {\n      \"tierType\": \"Volume\",\n      \"tiers\": [\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        },\n        {\n          \"upTo\": \"<integer>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"flatFee\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          }\n        }\n      ]\n    }\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1a6e2fc1-90f6-4922-9cf7-82b49e85e1e7","name":"Delete a specific change to the subscription.","request":{"name":"Delete a specific change to the subscription.","description":{"content":"Delete a specific scheduled change. Can only be done to pending changes.\n","type":"text/plain"},"url":{"path":["subscriptions",":subscriptionId","changes",":changeId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"subscriptionId","disabled":false,"description":{"content":"(Required) The ID of the subscription.","type":"text/plain"}},{"type":"any","value":"<string>","key":"changeId","disabled":false,"description":{"content":"(Required) The ID of the change.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"aa5a0246-eda0-4454-b0f3-b572cc510ab0","name":"A blank json object","originalRequest":{"url":{"path":["subscriptions",":subscriptionId","changes",":changeId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"86fd72eb-6295-4002-b6c4-39ed63d9a477","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["subscriptions",":subscriptionId","changes",":changeId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Invoices","description":"Operations related to invoices.\n","item":[{"id":"700b48eb-d6ea-4ab8-9952-76d85ab3ede9","name":"List invoices","request":{"name":"List invoices","description":{"content":"Retrieves a list of invoices available in your account.\n","type":"text/plain"},"url":{"path":["invoices"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the agreement of the invoice.","type":"text/plain"},"key":"agreementId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the invoice being overdue or not.","type":"text/plain"},"key":"isOverdue","value":"<boolean>"},{"disabled":false,"description":{"content":"Filter on the customer of the invoice.","type":"text/plain"},"key":"customerId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the status of the invoice.","type":"text/plain"},"key":"status","value":"Open"},{"disabled":false,"description":{"content":"Filter on the invoice number.","type":"text/plain"},"key":"number","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the due date. Supports ranges (2024-01-01..2024-01-31) and operators (>2024-01-01, >=2024-01-01, <2024-01-01, <=2024-01-01)","type":"text/plain"},"key":"dueDate","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the issue date. Supports ranges (2024-01-01..2024-01-31) and operators (>2024-01-01, >=2024-01-01, <2024-01-01, <=2024-01-01)","type":"text/plain"},"key":"issueDate","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"c99ed6ef-2ca2-44a4-8d0f-b37c4b999121","name":"A list of invoices","originalRequest":{"url":{"path":["invoices"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the agreement of the invoice.","type":"text/plain"},"key":"agreementId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the invoice being overdue or not.","type":"text/plain"},"key":"isOverdue","value":"<boolean>"},{"disabled":false,"description":{"content":"Filter on the customer of the invoice.","type":"text/plain"},"key":"customerId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the status of the invoice.","type":"text/plain"},"key":"status","value":"Open"},{"disabled":false,"description":{"content":"Filter on the invoice number.","type":"text/plain"},"key":"number","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the due date. Supports ranges (2024-01-01..2024-01-31) and operators (>2024-01-01, >=2024-01-01, <2024-01-01, <=2024-01-01)","type":"text/plain"},"key":"dueDate","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the issue date. Supports ranges (2024-01-01..2024-01-31) and operators (>2024-01-01, >=2024-01-01, <2024-01-01, <=2024-01-01)","type":"text/plain"},"key":"issueDate","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"invoices\": [\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"agreementId\": \"<string>\",\n      \"number\": \"<string>\",\n      \"issueAt\": \"<dateTime>\",\n      \"issuedAt\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"currency\": \"<string>\",\n      \"metaData\": {\n        \"adipisicing_2\": \"<string>\",\n        \"est6\": \"<string>\"\n      },\n      \"lineItems\": [\n        {\n          \"id\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subtotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"customDescription\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"id\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subtotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"customDescription\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ],\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vatTotals\": [\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Exempt\"\n          }\n        },\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Exempt\"\n          }\n        }\n      ],\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"invoiceSettings\": {\n        \"customFields\": [\n          {\n            \"name\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"name\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"customMemo\": \"<string>\",\n        \"customFooter\": \"<string>\"\n      },\n      \"isOverdue\": \"<boolean>\",\n      \"autoAdvance\": \"<boolean>\",\n      \"status\": \"Open\",\n      \"deliveryStatus\": {\n        \"et9c\": \"<string>\"\n      }\n    },\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"agreementId\": \"<string>\",\n      \"number\": \"<string>\",\n      \"issueAt\": \"<dateTime>\",\n      \"issuedAt\": \"<date>\",\n      \"dueDate\": \"<date>\",\n      \"currency\": \"<string>\",\n      \"metaData\": {\n        \"Ut_\": \"<string>\",\n        \"commodo_e\": \"<string>\"\n      },\n      \"lineItems\": [\n        {\n          \"id\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subtotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"customDescription\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"id\": \"<string>\",\n          \"productId\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subtotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"customDescription\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ],\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vatTotals\": [\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Inclusive\"\n          }\n        },\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Exempt\"\n          }\n        }\n      ],\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"invoiceSettings\": {\n        \"customFields\": [\n          {\n            \"name\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"name\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"customMemo\": \"<string>\",\n        \"customFooter\": \"<string>\"\n      },\n      \"isOverdue\": \"<boolean>\",\n      \"autoAdvance\": \"<boolean>\",\n      \"status\": \"Paid\",\n      \"deliveryStatus\": {\n        \"inef9\": \"<string>\"\n      }\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d671e799-8cf9-43d2-8f5b-fe2264afc7b2","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["invoices"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the agreement of the invoice.","type":"text/plain"},"key":"agreementId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the invoice being overdue or not.","type":"text/plain"},"key":"isOverdue","value":"<boolean>"},{"disabled":false,"description":{"content":"Filter on the customer of the invoice.","type":"text/plain"},"key":"customerId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the status of the invoice.","type":"text/plain"},"key":"status","value":"Open"},{"disabled":false,"description":{"content":"Filter on the invoice number.","type":"text/plain"},"key":"number","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the due date. Supports ranges (2024-01-01..2024-01-31) and operators (>2024-01-01, >=2024-01-01, <2024-01-01, <=2024-01-01)","type":"text/plain"},"key":"dueDate","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the issue date. Supports ranges (2024-01-01..2024-01-31) and operators (>2024-01-01, >=2024-01-01, <2024-01-01, <=2024-01-01)","type":"text/plain"},"key":"issueDate","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"10f2e4b6-84d9-493f-9621-bbea14a269a9","name":"Create invoice","request":{"name":"Create invoice","description":{"content":"Creates a new invoice.\n","type":"text/plain"},"url":{"path":["invoices"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"agreementId\": \"<string>\",\n  \"lineItems\": [\n    {\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    },\n    {\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    }\n  ],\n  \"dueDate\": \"<date>\",\n  \"autoAdvance\": \"<boolean>\",\n  \"metaData\": {\n    \"exercitation_3\": \"<string>\"\n  },\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"d45f19eb-0ed1-4897-8463-f623fbccdc22","name":"The created invoice","originalRequest":{"url":{"path":["invoices"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"agreementId\": \"<string>\",\n  \"lineItems\": [\n    {\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    },\n    {\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    }\n  ],\n  \"dueDate\": \"<date>\",\n  \"autoAdvance\": \"<boolean>\",\n  \"metaData\": {\n    \"exercitation_3\": \"<string>\"\n  },\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"number\": \"<string>\",\n  \"issueAt\": \"<dateTime>\",\n  \"issuedAt\": \"<date>\",\n  \"dueDate\": \"<date>\",\n  \"currency\": \"<string>\",\n  \"metaData\": {\n    \"aliqua117\": \"<string>\",\n    \"officia6a_\": \"<string>\"\n  },\n  \"lineItems\": [\n    {\n      \"id\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    }\n  ],\n  \"subtotal\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"vatTotals\": [\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"ReverseCharge\"\n      }\n    },\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"Exempt\"\n      }\n    }\n  ],\n  \"total\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"isOverdue\": \"<boolean>\",\n  \"autoAdvance\": \"<boolean>\",\n  \"status\": \"Paid\",\n  \"deliveryStatus\": {\n    \"culpa32\": \"<string>\",\n    \"veniam1fc\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0ddbff46-8524-4734-a0f0-b71ea4536c13","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["invoices"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"agreementId\": \"<string>\",\n  \"lineItems\": [\n    {\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    },\n    {\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    }\n  ],\n  \"dueDate\": \"<date>\",\n  \"autoAdvance\": \"<boolean>\",\n  \"metaData\": {\n    \"exercitation_3\": \"<string>\"\n  },\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e6b83f56-e9dd-4f43-be6b-28ea80207d61","name":"Get invoice","request":{"name":"Get invoice","description":{"content":"Retrieves the details of an existing invoice. You need to supply the unique invoice identifier that was returned upon invoice creation.\n","type":"text/plain"},"url":{"path":["invoices",":invoiceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"invoiceId","disabled":false,"description":{"content":"(Required) The ID of the invoice to retrieve.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"62de5884-e95f-4593-a52e-cd0bc15b458c","name":"The invoice details","originalRequest":{"url":{"path":["invoices",":invoiceId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"number\": \"<string>\",\n  \"issueAt\": \"<dateTime>\",\n  \"issuedAt\": \"<date>\",\n  \"dueDate\": \"<date>\",\n  \"currency\": \"<string>\",\n  \"metaData\": {\n    \"aliqua117\": \"<string>\",\n    \"officia6a_\": \"<string>\"\n  },\n  \"lineItems\": [\n    {\n      \"id\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    }\n  ],\n  \"subtotal\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"vatTotals\": [\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"ReverseCharge\"\n      }\n    },\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"Exempt\"\n      }\n    }\n  ],\n  \"total\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"isOverdue\": \"<boolean>\",\n  \"autoAdvance\": \"<boolean>\",\n  \"status\": \"Paid\",\n  \"deliveryStatus\": {\n    \"culpa32\": \"<string>\",\n    \"veniam1fc\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f402446b-3498-49fc-8748-5bba746b1dae","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["invoices",":invoiceId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c2910d34-552f-4a8d-b040-1ee39ee384f9","name":"Update invoice","request":{"name":"Update invoice","description":{"content":"Updates an invoice in your account.\n","type":"text/plain"},"url":{"path":["invoices",":invoiceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"invoiceId","disabled":false,"description":{"content":"(Required) The ID of the invoice to update.","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"autoAdvance\": \"<boolean>\",\n  \"dueDate\": \"<date>\",\n  \"metaData\": {\n    \"dolor_1cf\": \"<string>\"\n  },\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"6fe9ce71-68f0-469e-b7e0-6a277e955b51","name":"The updated invoice","originalRequest":{"url":{"path":["invoices",":invoiceId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"autoAdvance\": \"<boolean>\",\n  \"dueDate\": \"<date>\",\n  \"metaData\": {\n    \"dolor_1cf\": \"<string>\"\n  },\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"number\": \"<string>\",\n  \"issueAt\": \"<dateTime>\",\n  \"issuedAt\": \"<date>\",\n  \"dueDate\": \"<date>\",\n  \"currency\": \"<string>\",\n  \"metaData\": {\n    \"aliqua117\": \"<string>\",\n    \"officia6a_\": \"<string>\"\n  },\n  \"lineItems\": [\n    {\n      \"id\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    }\n  ],\n  \"subtotal\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"vatTotals\": [\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"ReverseCharge\"\n      }\n    },\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"Exempt\"\n      }\n    }\n  ],\n  \"total\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"isOverdue\": \"<boolean>\",\n  \"autoAdvance\": \"<boolean>\",\n  \"status\": \"Paid\",\n  \"deliveryStatus\": {\n    \"culpa32\": \"<string>\",\n    \"veniam1fc\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2d4bc1e6-d03e-4790-8daf-e2fd6e8be322","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["invoices",":invoiceId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"autoAdvance\": \"<boolean>\",\n  \"dueDate\": \"<date>\",\n  \"metaData\": {\n    \"dolor_1cf\": \"<string>\"\n  },\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ebd02d2f-b5ea-4f82-bd7b-78b9d5b6127c","name":"Delete draft invoice","request":{"name":"Delete draft invoice","description":{"content":"Deletes a draft invoice. You need to supply the unique invoice identifier.\n","type":"text/plain"},"url":{"path":["invoices",":invoiceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"invoiceId","disabled":false,"description":{"content":"(Required) The ID of the invoice to delete.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"7a82c079-7c5b-42e0-bba1-2bac71b75b90","name":"A blank json object","originalRequest":{"url":{"path":["invoices",":invoiceId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"19a8d273-71b7-48e4-8f95-b04b1b2a6ddb","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["invoices",":invoiceId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"754a6414-92c7-4599-ba2c-45dbc68ca5cc","name":"Issue invoice","request":{"name":"Issue invoice","description":{"content":"Issues an invoice immediately.\n","type":"text/plain"},"url":{"path":["invoices",":invoiceId","issue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"invoiceId","disabled":false,"description":{"content":"(Required) The ID of the invoice to issue.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{},"auth":null},"response":[{"id":"fa10068d-44af-4008-904e-ba3fb3bd6a9b","name":"The issued invoice","originalRequest":{"url":{"path":["invoices",":invoiceId","issue"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"number\": \"<string>\",\n  \"issueAt\": \"<dateTime>\",\n  \"issuedAt\": \"<date>\",\n  \"dueDate\": \"<date>\",\n  \"currency\": \"<string>\",\n  \"metaData\": {\n    \"aliqua117\": \"<string>\",\n    \"officia6a_\": \"<string>\"\n  },\n  \"lineItems\": [\n    {\n      \"id\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    }\n  ],\n  \"subtotal\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"vatTotals\": [\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"ReverseCharge\"\n      }\n    },\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"Exempt\"\n      }\n    }\n  ],\n  \"total\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"isOverdue\": \"<boolean>\",\n  \"autoAdvance\": \"<boolean>\",\n  \"status\": \"Paid\",\n  \"deliveryStatus\": {\n    \"culpa32\": \"<string>\",\n    \"veniam1fc\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6af1e1cf-8a85-4c0c-99d0-55b1d33611bd","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["invoices",":invoiceId","issue"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cf0d8933-71c3-4fcd-8690-e22501e5399e","name":"Add line item","request":{"name":"Add line item","description":{"content":"Add a line item to the invoice. This can only be done before the invoice has been issued.\n","type":"text/plain"},"url":{"path":["invoices",":invoiceId","line-items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"invoiceId","disabled":false,"description":{"content":"(Required) The ID of the invoice to update.","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"productId\": \"<string>\",\n  \"unitPrice\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\",\n  \"customDescription\": \"<string>\",\n  \"billingPeriod\": \"<string>\",\n  \"hideBillingPeriod\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"c5522f66-12ed-4dd7-9644-3893c350bdc6","name":"The updated invoice","originalRequest":{"url":{"path":["invoices",":invoiceId","line-items"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"productId\": \"<string>\",\n  \"unitPrice\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\",\n  \"customDescription\": \"<string>\",\n  \"billingPeriod\": \"<string>\",\n  \"hideBillingPeriod\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"number\": \"<string>\",\n  \"issueAt\": \"<dateTime>\",\n  \"issuedAt\": \"<date>\",\n  \"dueDate\": \"<date>\",\n  \"currency\": \"<string>\",\n  \"metaData\": {\n    \"aliqua117\": \"<string>\",\n    \"officia6a_\": \"<string>\"\n  },\n  \"lineItems\": [\n    {\n      \"id\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    }\n  ],\n  \"subtotal\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"vatTotals\": [\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"ReverseCharge\"\n      }\n    },\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"Exempt\"\n      }\n    }\n  ],\n  \"total\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"isOverdue\": \"<boolean>\",\n  \"autoAdvance\": \"<boolean>\",\n  \"status\": \"Paid\",\n  \"deliveryStatus\": {\n    \"culpa32\": \"<string>\",\n    \"veniam1fc\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b95c5585-dd9a-4bbd-94f3-4b256dc90495","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["invoices",":invoiceId","line-items"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"productId\": \"<string>\",\n  \"unitPrice\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\",\n  \"customDescription\": \"<string>\",\n  \"billingPeriod\": \"<string>\",\n  \"hideBillingPeriod\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e271ade8-9e91-4ceb-8c9d-53d87f3c2e91","name":"Update line item","request":{"name":"Update line item","description":{"content":"Update a line item in the invoice. This can only be done before the invoice has been issued.\n","type":"text/plain"},"url":{"path":["invoices",":invoiceId","line-items",":lineItemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"invoiceId","disabled":false,"description":{"content":"(Required) The ID of the invoice to update.","type":"text/plain"}},{"type":"any","value":"<string>","key":"lineItemId","disabled":false,"description":{"content":"(Required) The ID of the line item to update.","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"productId\": \"<string>\",\n  \"unitPrice\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\",\n  \"customDescription\": \"<string>\",\n  \"billingPeriod\": \"<string>\",\n  \"hideBillingPeriod\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"af131255-be52-4cb7-8ea1-9712d92ce09d","name":"The updated invoice","originalRequest":{"url":{"path":["invoices",":invoiceId","line-items",":lineItemId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"productId\": \"<string>\",\n  \"unitPrice\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\",\n  \"customDescription\": \"<string>\",\n  \"billingPeriod\": \"<string>\",\n  \"hideBillingPeriod\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"number\": \"<string>\",\n  \"issueAt\": \"<dateTime>\",\n  \"issuedAt\": \"<date>\",\n  \"dueDate\": \"<date>\",\n  \"currency\": \"<string>\",\n  \"metaData\": {\n    \"aliqua117\": \"<string>\",\n    \"officia6a_\": \"<string>\"\n  },\n  \"lineItems\": [\n    {\n      \"id\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    }\n  ],\n  \"subtotal\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"vatTotals\": [\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"ReverseCharge\"\n      }\n    },\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"Exempt\"\n      }\n    }\n  ],\n  \"total\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"isOverdue\": \"<boolean>\",\n  \"autoAdvance\": \"<boolean>\",\n  \"status\": \"Paid\",\n  \"deliveryStatus\": {\n    \"culpa32\": \"<string>\",\n    \"veniam1fc\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"926c64ab-cb1a-4dab-bd6b-2e224a51d792","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["invoices",":invoiceId","line-items",":lineItemId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"productId\": \"<string>\",\n  \"unitPrice\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"quantity\": \"<integer>\",\n  \"taxRateId\": \"<string>\",\n  \"customDescription\": \"<string>\",\n  \"billingPeriod\": \"<string>\",\n  \"hideBillingPeriod\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1b07a342-1f65-4b0b-a679-88ec53d437f0","name":"Delete line item","request":{"name":"Delete line item","description":{"content":"Delete the line item from the invoice. This can only be done before the invoice has been issued.\n","type":"text/plain"},"url":{"path":["invoices",":invoiceId","line-items",":lineItemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"invoiceId","disabled":false,"description":{"content":"(Required) The ID of the invoice to update.","type":"text/plain"}},{"type":"any","value":"<string>","key":"lineItemId","disabled":false,"description":{"content":"(Required) The ID of the line item to delete.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"b37bf3eb-c4f5-434c-9062-827323989eb4","name":"The updated invoice","originalRequest":{"url":{"path":["invoices",":invoiceId","line-items",":lineItemId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"number\": \"<string>\",\n  \"issueAt\": \"<dateTime>\",\n  \"issuedAt\": \"<date>\",\n  \"dueDate\": \"<date>\",\n  \"currency\": \"<string>\",\n  \"metaData\": {\n    \"aliqua117\": \"<string>\",\n    \"officia6a_\": \"<string>\"\n  },\n  \"lineItems\": [\n    {\n      \"id\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"productId\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"customDescription\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    }\n  ],\n  \"subtotal\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"vatTotals\": [\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"ReverseCharge\"\n      }\n    },\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"Exempt\"\n      }\n    }\n  ],\n  \"total\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"invoiceSettings\": {\n    \"customFields\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"customMemo\": \"<string>\",\n    \"customFooter\": \"<string>\"\n  },\n  \"isOverdue\": \"<boolean>\",\n  \"autoAdvance\": \"<boolean>\",\n  \"status\": \"Paid\",\n  \"deliveryStatus\": {\n    \"culpa32\": \"<string>\",\n    \"veniam1fc\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4f6f14a4-e568-4dd2-9cfa-5463323c1c5e","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["invoices",":invoiceId","line-items",":lineItemId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a19f7144-c752-49ac-8ab9-2071ac767684","name":"Register payment","request":{"name":"Register payment","description":{"content":"Register an external payment on the invoice.\n","type":"text/plain"},"url":{"path":["invoices",":invoiceId","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"invoiceId","disabled":false,"description":{"content":"(Required) The ID of the invoice to register the payment on.","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"paymentDate\": \"<date>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"note\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"ee1b5304-b6a2-4216-a44f-e0a9a8cf111e","name":"The transaction and payment created for the payment","originalRequest":{"url":{"path":["invoices",":invoiceId","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"paymentDate\": \"<date>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"note\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"transaction\": {\n    \"id\": \"<string>\",\n    \"accountId\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"agreementId\": \"<string>\",\n    \"amount\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"balance\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"transactionNumber\": \"<integer>\",\n    \"invoiceId\": \"<string>\",\n    \"creditNoteId\": \"<string>\",\n    \"paymentId\": \"<string>\",\n    \"issuedAt\": \"<dateTime>\",\n    \"dueDate\": \"<date>\",\n    \"paymentDate\": \"<date>\",\n    \"type\": \"CreditNoteIssued\"\n  },\n  \"payment\": {\n    \"id\": \"<string>\",\n    \"accountId\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"agreementId\": \"<string>\",\n    \"invoiceId\": \"<string>\",\n    \"paymentDate\": \"<date>\",\n    \"amount\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"handleBy\": \"External\",\n    \"note\": \"<string>\",\n    \"status\": \"Reversed\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"40837fa8-8065-4a8d-bb2b-d2261076ba3a","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["invoices",":invoiceId","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"paymentDate\": \"<date>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"note\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Products","description":"Operations related to products.\n","item":[{"id":"b07675c0-f589-43b2-8fd6-3d1a51aae2ba","name":"List products","request":{"name":"List products","description":{"content":"Retrieves a list of products available in your account. The products are returned sorted by creation date, with the most recent products appearing first.\n\nThis endpoint supports [pagination](https://docs.properpayments.io/get-started/api-setup/pagination).\n","type":"text/plain"},"url":{"path":["products"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"2578ea23-3acd-483a-9a7e-77c59cc4ba19","name":"A list of products","originalRequest":{"url":{"path":["products"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"products\": [\n    {\n      \"name\": \"<string>\",\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"metaData\": {\n        \"nonc\": \"<string>\",\n        \"id_605\": \"<string>\"\n      }\n    },\n    {\n      \"name\": \"<string>\",\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"metaData\": {\n        \"aute_5\": \"<string>\",\n        \"voluptate_f6\": \"<string>\",\n        \"irure7e7\": \"<string>\",\n        \"proident_3\": \"<string>\"\n      }\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"276e1f39-6c28-4fec-9e5e-c222143338ec","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["products"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4425bc03-f133-4b66-b7f6-69348c05c517","name":"Create product","request":{"name":"Create product","description":{"content":"Creates a new product in your account.\n","type":"text/plain"},"url":{"path":["products"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"metaData\": {\n    \"occaecat_c99\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"b1370ace-11c4-4df0-ba22-75f5ec1efe25","name":"The created product","originalRequest":{"url":{"path":["products"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"metaData\": {\n    \"occaecat_c99\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"metaData\": {\n    \"culpa_6\": \"<string>\",\n    \"dolor_2\": \"<string>\",\n    \"et_0b\": \"<string>\",\n    \"amet_90_\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6adabdf6-23f3-43db-8d82-b8edf16ba439","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["products"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"metaData\": {\n    \"occaecat_c99\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"32f95573-1cfc-4dff-b400-023da27e697e","name":"Get product","request":{"name":"Get product","description":{"content":"Retrieves the details of an existing product. You need to supply the unique product identifier that was returned upon product creation.\n","type":"text/plain"},"url":{"path":["products",":productId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"productId","disabled":false,"description":{"content":"(Required) The ID of the product to retrieve.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"bb3d8461-cb06-4e96-882b-e41d9775c468","name":"The product details","originalRequest":{"url":{"path":["products",":productId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"metaData\": {\n    \"culpa_6\": \"<string>\",\n    \"dolor_2\": \"<string>\",\n    \"et_0b\": \"<string>\",\n    \"amet_90_\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7aeb911d-e81a-4e70-944b-cd1b7774a4ea","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["products",":productId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f34a956e-2b36-42ea-9507-3e6469a5186a","name":"Update product","request":{"name":"Update product","description":{"content":"Update the details of an existing product. You need to supply the unique product identifier that was returned upon product creation.\n","type":"text/plain"},"url":{"path":["products",":productId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"productId","disabled":false,"description":{"content":"(Required) The ID of the product to update.","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"metaData\": {\n    \"culpa9_7\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"a475ff5f-6b52-4634-ae1b-576717001a51","name":"The product details","originalRequest":{"url":{"path":["products",":productId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"metaData\": {\n    \"culpa9_7\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"metaData\": {\n    \"culpa_6\": \"<string>\",\n    \"dolor_2\": \"<string>\",\n    \"et_0b\": \"<string>\",\n    \"amet_90_\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b7670981-8ad9-4dbf-9ecc-dd9d8c2ee125","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["products",":productId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"metaData\": {\n    \"culpa9_7\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Payments","description":"Operations related to payments.\n","item":[{"id":"c37205f0-0651-4285-ab44-0e5712574e8a","name":"List payments","request":{"name":"List payments","description":{"content":"Retrieves a list of payments made to the account.\n","type":"text/plain"},"url":{"path":["payments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Find payments coming from the given source","type":"text/plain"},"key":"source","value":"External"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"751d6408-79ca-48ad-9d8d-13363e6f9d6b","name":"A list of payments","originalRequest":{"url":{"path":["payments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Find payments coming from the given source","type":"text/plain"},"key":"source","value":"External"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"payments\": [\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"agreementId\": \"<string>\",\n      \"invoiceId\": \"<string>\",\n      \"paymentDate\": \"<date>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"handleBy\": \"External\",\n      \"note\": \"<string>\",\n      \"status\": \"Active\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"agreementId\": \"<string>\",\n      \"invoiceId\": \"<string>\",\n      \"paymentDate\": \"<date>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"handleBy\": \"Betalingsservice\",\n      \"note\": \"<string>\",\n      \"status\": \"Active\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3be328a5-7a70-4306-ae45-b47572bbdb6a","name":"Reverse payment","request":{"name":"Reverse payment","description":{"content":"Reverses an external payment by creating a reversal transaction. This action creates a new transaction with a negative amount to offset the original payment.\n\nOnly external payments can be reversed. The reversal will update the agreement balance accordingly.\n","type":"text/plain"},"url":{"path":["payments",":paymentId","reverse"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"paymentId","disabled":false,"description":{"content":"(Required) The ID of the payment to reverse","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"reason\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"4b3e3e8a-3a66-43ee-adaa-90d66886745c","name":"The reversal transaction and payment details","originalRequest":{"url":{"path":["payments",":paymentId","reverse"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"reason\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"transaction\": {\n    \"id\": \"<string>\",\n    \"accountId\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"agreementId\": \"<string>\",\n    \"amount\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"balance\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"transactionNumber\": \"<integer>\",\n    \"invoiceId\": \"<string>\",\n    \"creditNoteId\": \"<string>\",\n    \"paymentId\": \"<string>\",\n    \"issuedAt\": \"<dateTime>\",\n    \"dueDate\": \"<date>\",\n    \"paymentDate\": \"<date>\",\n    \"type\": \"CreditNoteIssued\"\n  },\n  \"payment\": {\n    \"id\": \"<string>\",\n    \"accountId\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"agreementId\": \"<string>\",\n    \"invoiceId\": \"<string>\",\n    \"paymentDate\": \"<date>\",\n    \"amount\": {\n      \"currency\": \"<string>\",\n      \"amount\": \"<number>\"\n    },\n    \"handleBy\": \"External\",\n    \"note\": \"<string>\",\n    \"status\": \"Reversed\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ed4affa8-5537-4528-9ee4-064e28580ee7","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["payments",":paymentId","reverse"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"reason\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1751f1b4-f4f7-462d-b179-239667857c09","name":"Payment not found","originalRequest":{"url":{"path":["payments",":paymentId","reverse"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"reason\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Credit notes","description":"Operations related to credit notes.\n","item":[{"id":"d45ba1fd-977d-436b-80b3-8b306f15edfd","name":"List credit notes","request":{"name":"List credit notes","description":{"content":"Retrieves a list of credit notes available in your account.\n","type":"text/plain"},"url":{"path":["credit-notes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the agreement of the credit note.","type":"text/plain"},"key":"agreementId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the credited invoice.","type":"text/plain"},"key":"invoiceId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the number of the credit note.","type":"text/plain"},"key":"number","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"7967ceb3-9978-465e-b857-333cb6128ca6","name":"A list of credit notes","originalRequest":{"url":{"path":["credit-notes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the agreement of the credit note.","type":"text/plain"},"key":"agreementId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the credited invoice.","type":"text/plain"},"key":"invoiceId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the number of the credit note.","type":"text/plain"},"key":"number","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"creditNotes\": [\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"agreementId\": \"<string>\",\n      \"invoiceId\": \"<string>\",\n      \"number\": \"<string>\",\n      \"issuedAt\": \"<dateTime>\",\n      \"currency\": \"<string>\",\n      \"metaData\": {\n        \"cillum_38\": \"<string>\",\n        \"minim_6\": \"<string>\"\n      },\n      \"customMemo\": \"<string>\",\n      \"creditNoteReason\": \"Other\",\n      \"creditNoteType\": \"Full\",\n      \"creditor\": {\n        \"name\": \"<string>\",\n        \"address\": {\n          \"line1\": \"<string>\",\n          \"postalCode\": \"<string>\",\n          \"city\": \"<string>\",\n          \"country\": \"<string>\",\n          \"line2\": \"<string>\"\n        },\n        \"vatId\": \"<string>\"\n      },\n      \"debtor\": {\n        \"name\": \"<string>\",\n        \"address\": {\n          \"line1\": \"<string>\",\n          \"postalCode\": \"<string>\",\n          \"city\": \"<string>\",\n          \"country\": \"<string>\",\n          \"line2\": \"<string>\"\n        },\n        \"vatId\": \"<string>\"\n      },\n      \"lineItems\": [\n        {\n          \"productId\": \"<string>\",\n          \"productName\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subtotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"taxRateName\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"productId\": \"<string>\",\n          \"productName\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subtotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"taxRateName\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ],\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vatTotals\": [\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Inclusive\"\n          }\n        },\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"ReverseCharge\"\n          }\n        }\n      ],\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"deliveryStatus\": {}\n    },\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"agreementId\": \"<string>\",\n      \"invoiceId\": \"<string>\",\n      \"number\": \"<string>\",\n      \"issuedAt\": \"<dateTime>\",\n      \"currency\": \"<string>\",\n      \"metaData\": {\n        \"minim_f5\": \"<string>\"\n      },\n      \"customMemo\": \"<string>\",\n      \"creditNoteReason\": \"OrderChange\",\n      \"creditNoteType\": \"Full\",\n      \"creditor\": {\n        \"name\": \"<string>\",\n        \"address\": {\n          \"line1\": \"<string>\",\n          \"postalCode\": \"<string>\",\n          \"city\": \"<string>\",\n          \"country\": \"<string>\",\n          \"line2\": \"<string>\"\n        },\n        \"vatId\": \"<string>\"\n      },\n      \"debtor\": {\n        \"name\": \"<string>\",\n        \"address\": {\n          \"line1\": \"<string>\",\n          \"postalCode\": \"<string>\",\n          \"city\": \"<string>\",\n          \"country\": \"<string>\",\n          \"line2\": \"<string>\"\n        },\n        \"vatId\": \"<string>\"\n      },\n      \"lineItems\": [\n        {\n          \"productId\": \"<string>\",\n          \"productName\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subtotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"taxRateName\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        },\n        {\n          \"productId\": \"<string>\",\n          \"productName\": \"<string>\",\n          \"unitPrice\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"quantity\": \"<integer>\",\n          \"price\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"subtotal\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"taxRateId\": \"<string>\",\n          \"taxRateName\": \"<string>\",\n          \"billingPeriod\": \"<string>\",\n          \"appliedPeriod\": \"<string>\",\n          \"hideBillingPeriod\": \"<boolean>\"\n        }\n      ],\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vatTotals\": [\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"Exclusive\"\n          }\n        },\n        {\n          \"total\": {\n            \"currency\": \"<string>\",\n            \"amount\": \"<number>\"\n          },\n          \"vat\": {\n            \"rate\": \"<number>\",\n            \"taxRateId\": \"<string>\",\n            \"taxMode\": \"ReverseCharge\"\n          }\n        }\n      ],\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"deliveryStatus\": {}\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5633a067-c370-4b95-ba0e-2bf7313ccb5c","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["credit-notes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the agreement of the credit note.","type":"text/plain"},"key":"agreementId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the credited invoice.","type":"text/plain"},"key":"invoiceId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the number of the credit note.","type":"text/plain"},"key":"number","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"616648ab-cac3-4313-925b-9d889bbfc8e0","name":"Create credit note","request":{"name":"Create credit note","description":{"content":"Creates a new credit note.\n","type":"text/plain"},"url":{"path":["credit-notes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"invoiceId\": \"<string>\",\n  \"reason\": \"Unsatisfied\",\n  \"metaData\": {\n    \"laboris_07b\": \"<string>\",\n    \"id_fec\": \"<string>\"\n  },\n  \"effectiveDate\": \"<dateTime>\",\n  \"customMemo\": \"<string>\",\n  \"lineItems\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\"\n    }\n  ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"fa44f50f-3ba1-4e32-b47b-18f961bb740d","name":"The created credit note","originalRequest":{"url":{"path":["credit-notes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"invoiceId\": \"<string>\",\n  \"reason\": \"Unsatisfied\",\n  \"metaData\": {\n    \"laboris_07b\": \"<string>\",\n    \"id_fec\": \"<string>\"\n  },\n  \"effectiveDate\": \"<dateTime>\",\n  \"customMemo\": \"<string>\",\n  \"lineItems\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\"\n    }\n  ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"invoiceId\": \"<string>\",\n  \"number\": \"<string>\",\n  \"issuedAt\": \"<dateTime>\",\n  \"currency\": \"<string>\",\n  \"metaData\": {\n    \"occaecat9\": \"<string>\"\n  },\n  \"customMemo\": \"<string>\",\n  \"creditNoteReason\": \"Cancellation\",\n  \"creditNoteType\": \"Full\",\n  \"creditor\": {\n    \"name\": \"<string>\",\n    \"address\": {\n      \"line1\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"line2\": \"<string>\"\n    },\n    \"vatId\": \"<string>\"\n  },\n  \"debtor\": {\n    \"name\": \"<string>\",\n    \"address\": {\n      \"line1\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"line2\": \"<string>\"\n    },\n    \"vatId\": \"<string>\"\n  },\n  \"lineItems\": [\n    {\n      \"productId\": \"<string>\",\n      \"productName\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"taxRateName\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    },\n    {\n      \"productId\": \"<string>\",\n      \"productName\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"taxRateName\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    }\n  ],\n  \"subtotal\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"vatTotals\": [\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"Inclusive\"\n      }\n    },\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"ReverseCharge\"\n      }\n    }\n  ],\n  \"total\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"deliveryStatus\": {}\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ae7f83fe-a686-4f7e-a0ce-b89b7b4b840f","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["credit-notes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"invoiceId\": \"<string>\",\n  \"reason\": \"Unsatisfied\",\n  \"metaData\": {\n    \"laboris_07b\": \"<string>\",\n    \"id_fec\": \"<string>\"\n  },\n  \"effectiveDate\": \"<dateTime>\",\n  \"customMemo\": \"<string>\",\n  \"lineItems\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\"\n    }\n  ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a86ba88d-a42c-4cf7-8291-b3fd00959c4e","name":"Get credit note","request":{"name":"Get credit note","description":{"content":"Retrieves the details of an existing credit note. You need to supply the unique credit note identifier that was returned upon credit note creation.\n","type":"text/plain"},"url":{"path":["credit-notes",":creditNoteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"creditNoteId","disabled":false,"description":{"content":"(Required) The ID of the credit note to retrieve.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"2c98b74b-c096-41fd-ad8e-2462dfd5c62d","name":"The credit note details","originalRequest":{"url":{"path":["credit-notes",":creditNoteId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"invoiceId\": \"<string>\",\n  \"number\": \"<string>\",\n  \"issuedAt\": \"<dateTime>\",\n  \"currency\": \"<string>\",\n  \"metaData\": {\n    \"occaecat9\": \"<string>\"\n  },\n  \"customMemo\": \"<string>\",\n  \"creditNoteReason\": \"Cancellation\",\n  \"creditNoteType\": \"Full\",\n  \"creditor\": {\n    \"name\": \"<string>\",\n    \"address\": {\n      \"line1\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"line2\": \"<string>\"\n    },\n    \"vatId\": \"<string>\"\n  },\n  \"debtor\": {\n    \"name\": \"<string>\",\n    \"address\": {\n      \"line1\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"line2\": \"<string>\"\n    },\n    \"vatId\": \"<string>\"\n  },\n  \"lineItems\": [\n    {\n      \"productId\": \"<string>\",\n      \"productName\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"taxRateName\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    },\n    {\n      \"productId\": \"<string>\",\n      \"productName\": \"<string>\",\n      \"unitPrice\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"quantity\": \"<integer>\",\n      \"price\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"subtotal\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"taxRateId\": \"<string>\",\n      \"taxRateName\": \"<string>\",\n      \"billingPeriod\": \"<string>\",\n      \"appliedPeriod\": \"<string>\",\n      \"hideBillingPeriod\": \"<boolean>\"\n    }\n  ],\n  \"subtotal\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"vatTotals\": [\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"Inclusive\"\n      }\n    },\n    {\n      \"total\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"vat\": {\n        \"rate\": \"<number>\",\n        \"taxRateId\": \"<string>\",\n        \"taxMode\": \"ReverseCharge\"\n      }\n    }\n  ],\n  \"total\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"deliveryStatus\": {}\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"587d099b-5caf-4ca8-9633-baf98f4ec604","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["credit-notes",":creditNoteId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Transactions","description":"Operations related to transactions.\n","item":[{"id":"a6e65a66-7714-4484-a114-08f3cb148663","name":"List transactions","request":{"name":"List transactions","description":{"content":"Retrieves a list of transactions available in your account.\n","type":"text/plain"},"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the agreement of the transaction.","type":"text/plain"},"key":"agreementId","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"0e33ad38-d033-4ea3-8f40-b70f780980eb","name":"A list of transactions","originalRequest":{"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the agreement of the transaction.","type":"text/plain"},"key":"agreementId","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"transactions\": [\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"agreementId\": \"<string>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"balance\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"transactionNumber\": \"<integer>\",\n      \"invoiceId\": \"<string>\",\n      \"creditNoteId\": \"<string>\",\n      \"paymentId\": \"<string>\",\n      \"issuedAt\": \"<dateTime>\",\n      \"dueDate\": \"<date>\",\n      \"paymentDate\": \"<date>\",\n      \"type\": \"ExternalPaymentReceivedOnAgreement\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"agreementId\": \"<string>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"balance\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"transactionNumber\": \"<integer>\",\n      \"invoiceId\": \"<string>\",\n      \"creditNoteId\": \"<string>\",\n      \"paymentId\": \"<string>\",\n      \"issuedAt\": \"<dateTime>\",\n      \"dueDate\": \"<date>\",\n      \"paymentDate\": \"<date>\",\n      \"type\": \"CreditNoteIssued\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4cc717c9-0ae7-455e-8ae8-a68a133fd755","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the agreement of the transaction.","type":"text/plain"},"key":"agreementId","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"79d4daf8-11d5-4cf1-ba34-1fdb281a6128","name":"Get transaction","request":{"name":"Get transaction","description":{"content":"Retrieves the details of an existing transaction. You need to supply the unique transaction identifier that was returned upon transaction creation.\n","type":"text/plain"},"url":{"path":["transactions",":transactionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"transactionId","disabled":false,"description":{"content":"(Required) The ID of the transaction to retrieve.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"4073598c-6f76-4133-86e4-bf41ee592800","name":"The transaction details","originalRequest":{"url":{"path":["transactions",":transactionId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"balance\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"transactionNumber\": \"<integer>\",\n  \"invoiceId\": \"<string>\",\n  \"creditNoteId\": \"<string>\",\n  \"paymentId\": \"<string>\",\n  \"issuedAt\": \"<dateTime>\",\n  \"dueDate\": \"<date>\",\n  \"paymentDate\": \"<date>\",\n  \"type\": \"ExternalPaymentReversed\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0726c252-03d4-41da-8070-892fdef2b074","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["transactions",":transactionId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d27ef408-31dd-4baa-a878-8edb9e0da49e","name":"Link transaction to invoice","request":{"name":"Link transaction to invoice","description":{},"url":{"path":["transactions",":transactionId","invoice-link"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"transactionId","disabled":false,"description":{"content":"(Required) ","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"invoiceId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"fa84d086-948a-4ab5-a138-8be07f3ef061","name":"The updated transaction","originalRequest":{"url":{"path":["transactions",":transactionId","invoice-link"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"invoiceId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"balance\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"transactionNumber\": \"<integer>\",\n  \"invoiceId\": \"<string>\",\n  \"creditNoteId\": \"<string>\",\n  \"paymentId\": \"<string>\",\n  \"issuedAt\": \"<dateTime>\",\n  \"dueDate\": \"<date>\",\n  \"paymentDate\": \"<date>\",\n  \"type\": \"ExternalPaymentReversed\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"83ac24ad-8674-4d4e-ba51-51179523e0c1","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["transactions",":transactionId","invoice-link"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"invoiceId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e4d31758-f7e9-47e3-ad24-de8cedad792c","name":"Unlink transaction from invoice","request":{"name":"Unlink transaction from invoice","description":{},"url":{"path":["transactions",":transactionId","invoice-link"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"transactionId","disabled":false,"description":{"content":"(Required) ","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"54cb2cd8-7b6d-4088-a540-b483f13a533c","name":"The updated transaction","originalRequest":{"url":{"path":["transactions",":transactionId","invoice-link"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"balance\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  },\n  \"transactionNumber\": \"<integer>\",\n  \"invoiceId\": \"<string>\",\n  \"creditNoteId\": \"<string>\",\n  \"paymentId\": \"<string>\",\n  \"issuedAt\": \"<dateTime>\",\n  \"dueDate\": \"<date>\",\n  \"paymentDate\": \"<date>\",\n  \"type\": \"ExternalPaymentReversed\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f377feee-f0d0-4d72-b161-ee4c13ef671a","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["transactions",":transactionId","invoice-link"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Payouts","description":"Operations related to payouts.\n","item":[{"id":"76a4815d-610d-45cd-bb2b-ac290093a0db","name":"List payouts","request":{"name":"List payouts","description":{"content":"Retrieves a list of payouts made to the account.\n","type":"text/plain"},"url":{"path":["payouts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"dfbc529e-d1a6-4890-a790-8da791c5f3ad","name":"A list of payouts","originalRequest":{"url":{"path":["payouts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"payouts\": [\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"payoutDate\": {\n        \"format\": \"date-time\",\n        \"example\": \"2024-07-30T14:15:48.262748Z\"\n      },\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      }\n    },\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"payoutDate\": {\n        \"format\": \"date-time\",\n        \"example\": \"2024-07-30T14:15:48.262748Z\"\n      },\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      }\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1e4aad88-b0a3-4d45-a96a-4ad1e4e0230d","name":"Fetch payout","request":{"name":"Fetch payout","description":{"content":"Retrieves the payout with the given id.\n","type":"text/plain"},"url":{"path":["payouts",":payoutId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"payoutId","disabled":false,"description":{"content":"(Required) ","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"a96f1e08-8f22-4f03-8241-010181e82cf3","name":"The payout","originalRequest":{"url":{"path":["payouts",":payoutId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"payoutDate\": {\n    \"format\": \"date-time\",\n    \"example\": \"2024-07-30T14:15:48.262748Z\"\n  },\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"amount\": \"<number>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c56f193d-164a-4982-9e6c-0e70e56ec765","name":"List payments for payout","request":{"name":"List payments for payout","description":{"content":"Retrieves the list of payments that were included in the specified payout.\n","type":"text/plain"},"url":{"path":["payouts",":payoutId","payments"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"payoutId","disabled":false,"description":{"content":"(Required) ","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"608c8b05-8fef-4432-a887-b9ad07f3e127","name":"A list of payments included in the payout","originalRequest":{"url":{"path":["payouts",":payoutId","payments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"payments\": [\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"agreementId\": \"<string>\",\n      \"invoiceId\": \"<string>\",\n      \"paymentDate\": \"<date>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"handleBy\": \"External\",\n      \"note\": \"<string>\",\n      \"status\": \"Active\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"agreementId\": \"<string>\",\n      \"invoiceId\": \"<string>\",\n      \"paymentDate\": \"<date>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"amount\": \"<number>\"\n      },\n      \"handleBy\": \"Betalingsservice\",\n      \"note\": \"<string>\",\n      \"status\": \"Active\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"68f6515e-3749-4516-a38c-a1067d9b4a9f","name":"Payout not found","originalRequest":{"url":{"path":["payouts",":payoutId","payments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Tax rates","description":"Operations related to tax rates.\n","item":[{"id":"1d6bedc3-d1d7-4956-97de-3e26c1fa2a49","name":"List tax rates","request":{"name":"List tax rates","description":{"content":"Retrieves a list of tax rates available in your account. The tax rates are returned sorted by creation date, with the most recent tax rate appearing first.\n\nThis endpoint supports [pagination](https://docs.properpayments.io/get-started/api-setup/pagination).\n","type":"text/plain"},"url":{"path":["tax-rates"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"e551edf5-3925-43f2-9866-2f79ff9e1506","name":"A list of tax rates","originalRequest":{"url":{"path":["tax-rates"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"taxRates\": [\n    {\n      \"displayName\": \"<string>\",\n      \"rate\": \"<number>\",\n      \"taxMode\": \"Exclusive\",\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"description\": \"<string>\"\n    },\n    {\n      \"displayName\": \"<string>\",\n      \"rate\": \"<number>\",\n      \"taxMode\": \"Exclusive\",\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5929d697-586d-4bba-ba67-61838be06337","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["tax-rates"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f6331912-3809-4def-a6fe-6765c0ffac9f","name":"Create tax rate","request":{"name":"Create tax rate","description":{"content":"Creates a new tax rate in your account.\n","type":"text/plain"},"url":{"path":["tax-rates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"displayName\": \"<string>\",\n  \"rate\": \"<number>\",\n  \"taxMode\": \"Exclusive\",\n  \"description\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"45f62d6d-c87b-40e4-b55d-60236b335c84","name":"The created tax rate","originalRequest":{"url":{"path":["tax-rates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"displayName\": \"<string>\",\n  \"rate\": \"<number>\",\n  \"taxMode\": \"Exclusive\",\n  \"description\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"displayName\": \"<string>\",\n  \"rate\": \"<number>\",\n  \"taxMode\": \"Inclusive\",\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"description\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"03c4c58e-b32d-411d-a5cd-b380bd705fe7","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["tax-rates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"displayName\": \"<string>\",\n  \"rate\": \"<number>\",\n  \"taxMode\": \"Exclusive\",\n  \"description\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7730f66e-057f-4bf2-9c79-c75927c1c162","name":"Get tax rate","request":{"name":"Get tax rate","description":{"content":"Retrieves the details of an existing tax rate. You need to supply the unique product identifier that was returned upon tax rate creation.\n","type":"text/plain"},"url":{"path":["tax-rates",":taxRateId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"taxRateId","disabled":false,"description":{"content":"(Required) The ID of the tax rate to retrieve.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"4ae2643c-81de-422e-b43e-fde6e9753729","name":"The tax rate details","originalRequest":{"url":{"path":["tax-rates",":taxRateId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"displayName\": \"<string>\",\n  \"rate\": \"<number>\",\n  \"taxMode\": \"Inclusive\",\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"description\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ba5b52e3-576b-4c72-9388-35a42990f7e0","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["tax-rates",":taxRateId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"776d342f-8008-415e-9a70-dae958e3e07e","name":"Update tax rate","request":{"name":"Update tax rate","description":{"content":"Update an existing tax rate. You need to supply the unique product identifier that was returned upon tax rate creation.\n","type":"text/plain"},"url":{"path":["tax-rates",":taxRateId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"taxRateId","disabled":false,"description":{"content":"(Required) The ID of the tax rate to update.","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"6a651822-ff9f-4c82-83e5-fe070b93fa4b","name":"The tax rate details","originalRequest":{"url":{"path":["tax-rates",":taxRateId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"displayName\": \"<string>\",\n  \"rate\": \"<number>\",\n  \"taxMode\": \"Inclusive\",\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"description\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f7668c5f-13be-4bc2-a60c-8ea6b586373b","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["tax-rates",":taxRateId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Meter events","description":"Operations related to meter events.\n","item":[{"id":"de3789a3-4068-4823-918e-11a7b4dd2dbf","name":"List meter events for a subscription","request":{"name":"List meter events for a subscription","description":{"content":"Retrieves a list of meter events for a specific subscription.\n","type":"text/plain"},"url":{"path":["meter-events"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the subscription of the meter event.","type":"text/plain"},"key":"subscriptionId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the state of the event.","type":"text/plain"},"key":"state","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"fc38b738-b434-4d28-afc6-8cd657210799","name":"A list of meter events","originalRequest":{"url":{"path":["meter-events"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the subscription of the meter event.","type":"text/plain"},"key":"subscriptionId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the state of the event.","type":"text/plain"},"key":"state","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"meterEvents\": [\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"agreementId\": \"<string>\",\n      \"subscriptionId\": \"<string>\",\n      \"quantity\": \"<integer>\",\n      \"timestamp\": \"<dateTime>\",\n      \"invoiceId\": \"<string>\",\n      \"invoiceLineItemId\": \"<string>\",\n      \"state\": \"Pending\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"customerId\": \"<string>\",\n      \"agreementId\": \"<string>\",\n      \"subscriptionId\": \"<string>\",\n      \"quantity\": \"<integer>\",\n      \"timestamp\": \"<dateTime>\",\n      \"invoiceId\": \"<string>\",\n      \"invoiceLineItemId\": \"<string>\",\n      \"state\": \"Pending\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"30cc7b92-1711-4317-bf21-804b8a9d41b3","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["meter-events"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the subscription of the meter event.","type":"text/plain"},"key":"subscriptionId","value":"<string>"},{"disabled":false,"description":{"content":"Filter on the state of the event.","type":"text/plain"},"key":"state","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b59a9fe5-06d4-4fbd-87e6-0aabe272da8b","name":"Create meter event for a subscription","request":{"name":"Create meter event for a subscription","description":{"content":"Creates a new meter event for a specific subscription.\n","type":"text/plain"},"url":{"path":["meter-events"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"subscriptionId\": \"<string>\",\n  \"quantity\": \"<integer>\",\n  \"timestamp\": \"<dateTime>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"083a1e55-56e9-4b72-aae5-1067e263d232","name":"The created meter event","originalRequest":{"url":{"path":["meter-events"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"subscriptionId\": \"<string>\",\n  \"quantity\": \"<integer>\",\n  \"timestamp\": \"<dateTime>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"subscriptionId\": \"<string>\",\n  \"quantity\": \"<integer>\",\n  \"timestamp\": \"<dateTime>\",\n  \"invoiceId\": \"<string>\",\n  \"invoiceLineItemId\": \"<string>\",\n  \"state\": \"Pending\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9798df5c-45e7-4174-83a7-fb3f34a82af0","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["meter-events"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"subscriptionId\": \"<string>\",\n  \"quantity\": \"<integer>\",\n  \"timestamp\": \"<dateTime>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"687cbb74-5cde-4b0f-a0fe-71c013fd1a1c","name":"Get meter event","request":{"name":"Get meter event","description":{"content":"Retrieves the details of an existing meter event. You need to supply the unique meter event identifier that was returned upon meter event creation.\n","type":"text/plain"},"url":{"path":["meter-events",":meterEventId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"meterEventId","disabled":false,"description":{"content":"(Required) The ID of the meter event to retrieve.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"4d62cce4-3741-406f-9e66-fb4c20d5edfc","name":"The meter event details","originalRequest":{"url":{"path":["meter-events",":meterEventId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"agreementId\": \"<string>\",\n  \"subscriptionId\": \"<string>\",\n  \"quantity\": \"<integer>\",\n  \"timestamp\": \"<dateTime>\",\n  \"invoiceId\": \"<string>\",\n  \"invoiceLineItemId\": \"<string>\",\n  \"state\": \"Pending\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7c687ad5-3f90-4704-83da-3ab92cd37fd4","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["meter-events",":meterEventId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ee68cffb-0017-49b8-90b1-5cbde81b8384","name":"Delete meter event","request":{"name":"Delete meter event","description":{"content":"Delete the given pending meter event.\n","type":"text/plain"},"url":{"path":["meter-events",":meterEventId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"meterEventId","disabled":false,"description":{"content":"(Required) The ID of the meter event to delete.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"8148ff5c-5c8d-4cbe-8226-c62783d0d94c","name":"A blank json object","originalRequest":{"url":{"path":["meter-events",":meterEventId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1a2dcf08-784a-43af-9164-a6cee7a0d408","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["meter-events",":meterEventId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Reminder flows","description":"Operations related to reminder flows for automated invoice reminders.\n","item":[{"id":"51eb559b-c7ab-44a1-9f80-d6cd0659ef54","name":"List reminder flows","request":{"name":"List reminder flows","description":{"content":"Retrieves a list of reminder flows for the account.","type":"text/plain"},"url":{"path":["reminder-flows"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of items to return (max 100)","type":"text/plain"},"key":"limit","value":"20"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to start after","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to end before","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"4d8dddf6-d710-495a-b7ce-c83fbb72548b","name":"A list of reminder flows","originalRequest":{"url":{"path":["reminder-flows"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of items to return (max 100)","type":"text/plain"},"key":"limit","value":"20"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to start after","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to end before","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"reminderFlows\": [\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"steps\": [\n        {\n          \"daysAfter\": \"<integer>\",\n          \"emailSubject\": \"<string>\",\n          \"emailContent\": \"<string>\"\n        },\n        {\n          \"daysAfter\": \"<integer>\",\n          \"emailSubject\": \"<string>\",\n          \"emailContent\": \"<string>\"\n        }\n      ],\n      \"conditions\": [\n        {\n          \"field\": \"AGREEMENT_CURRENCY\",\n          \"operator\": \"GREATER_THAN\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"INVOICE_AMOUNT\",\n          \"operator\": \"ON_OR_BEFORE\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"metaData\": {\n        \"dolor433\": \"<string>\"\n      },\n      \"createdAt\": \"<dateTime>\",\n      \"modifiedAt\": \"<dateTime>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"steps\": [\n        {\n          \"daysAfter\": \"<integer>\",\n          \"emailSubject\": \"<string>\",\n          \"emailContent\": \"<string>\"\n        },\n        {\n          \"daysAfter\": \"<integer>\",\n          \"emailSubject\": \"<string>\",\n          \"emailContent\": \"<string>\"\n        }\n      ],\n      \"conditions\": [\n        {\n          \"field\": \"INVOICE_AMOUNT\",\n          \"operator\": \"LESS_THAN\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"INVOICE_DUE_DATE\",\n          \"operator\": \"IS_NOT_EMPTY\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"metaData\": {\n        \"in_93\": \"<string>\",\n        \"velit_9\": \"<string>\"\n      },\n      \"createdAt\": \"<dateTime>\",\n      \"modifiedAt\": \"<dateTime>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ff17cdeb-494d-4d71-be1b-d6a0da14cf1a","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["reminder-flows"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of items to return (max 100)","type":"text/plain"},"key":"limit","value":"20"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to start after","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to end before","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e66f811a-cd9b-4bca-a289-45c7fdab83af","name":"Create reminder flow","request":{"name":"Create reminder flow","description":{"content":"Creates a new reminder flow for automated invoice reminders.","type":"text/plain"},"url":{"path":["reminder-flows"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    }\n  ],\n  \"conditions\": [\n    {\n      \"field\": \"INVOICE_ISSUE_DATE\",\n      \"operator\": \"STARTS_WITH\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"INVOICE_DUE_DATE\",\n      \"operator\": \"LESS_THAN\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"metaData\": {\n    \"magna_9\": \"<string>\",\n    \"fugiat36\": \"<string>\",\n    \"fugiat__3\": \"<string>\",\n    \"consequat2ab\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"af79f085-4b19-4b05-b76e-15f0b1ead2f3","name":"The created reminder flow","originalRequest":{"url":{"path":["reminder-flows"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    }\n  ],\n  \"conditions\": [\n    {\n      \"field\": \"INVOICE_ISSUE_DATE\",\n      \"operator\": \"STARTS_WITH\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"INVOICE_DUE_DATE\",\n      \"operator\": \"LESS_THAN\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"metaData\": {\n    \"magna_9\": \"<string>\",\n    \"fugiat36\": \"<string>\",\n    \"fugiat__3\": \"<string>\",\n    \"consequat2ab\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"active\": \"<boolean>\",\n  \"steps\": [\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    },\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    }\n  ],\n  \"conditions\": [\n    {\n      \"field\": \"AGREEMENT_CURRENCY\",\n      \"operator\": \"GREATER_THAN\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"INVOICE_ISSUE_DATE\",\n      \"operator\": \"LESS_THAN\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"metaData\": {\n    \"eiusmodd\": \"<string>\",\n    \"deserunt3\": \"<string>\",\n    \"anim984\": \"<string>\",\n    \"quis_ba\": \"<string>\"\n  },\n  \"createdAt\": \"<dateTime>\",\n  \"modifiedAt\": \"<dateTime>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e25659bc-13b4-4a81-ba57-afaa7e17a42a","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["reminder-flows"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    }\n  ],\n  \"conditions\": [\n    {\n      \"field\": \"INVOICE_ISSUE_DATE\",\n      \"operator\": \"STARTS_WITH\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"INVOICE_DUE_DATE\",\n      \"operator\": \"LESS_THAN\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"metaData\": {\n    \"magna_9\": \"<string>\",\n    \"fugiat36\": \"<string>\",\n    \"fugiat__3\": \"<string>\",\n    \"consequat2ab\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1c2ac5b8-1ceb-4a7f-a870-9c8d4b6f3cba","name":"Get reminder flow","request":{"name":"Get reminder flow","description":{"content":"Retrieves a specific reminder flow.","type":"text/plain"},"url":{"path":["reminder-flows",":reminderFlowId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"reminderFlowId","disabled":false,"description":{"content":"(Required) The reminder flow ID","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"8930ebd8-a4df-447c-8a21-681e33d1dc60","name":"The reminder flow","originalRequest":{"url":{"path":["reminder-flows",":reminderFlowId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"active\": \"<boolean>\",\n  \"steps\": [\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    },\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    }\n  ],\n  \"conditions\": [\n    {\n      \"field\": \"AGREEMENT_CURRENCY\",\n      \"operator\": \"GREATER_THAN\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"INVOICE_ISSUE_DATE\",\n      \"operator\": \"LESS_THAN\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"metaData\": {\n    \"eiusmodd\": \"<string>\",\n    \"deserunt3\": \"<string>\",\n    \"anim984\": \"<string>\",\n    \"quis_ba\": \"<string>\"\n  },\n  \"createdAt\": \"<dateTime>\",\n  \"modifiedAt\": \"<dateTime>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"98fe5a12-0131-4f7e-9f89-a690b5cb988d","name":"404 response","originalRequest":{"url":{"path":["reminder-flows",":reminderFlowId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[],"cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"aa302296-39bb-4a13-be4e-fe59081d76ef","name":"Update reminder flow","request":{"name":"Update reminder flow","description":{"content":"Updates an existing reminder flow.","type":"text/plain"},"url":{"path":["reminder-flows",":reminderFlowId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"reminderFlowId","disabled":false,"description":{"content":"(Required) The reminder flow ID","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"active\": \"<boolean>\",\n  \"conditions\": [\n    {\n      \"field\": \"AGREEMENT_CURRENCY\",\n      \"operator\": \"IS_NOT_EMPTY\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"CUSTOMER_COUNTRY\",\n      \"operator\": \"ON_OR_BEFORE\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"steps\": [\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    },\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    }\n  ],\n  \"metaData\": {\n    \"aliquip_7\": \"<string>\",\n    \"commodo_c79\": \"<string>\",\n    \"enim4\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"485cb68b-73a9-42e6-a1f1-18f763dffa66","name":"The updated reminder flow","originalRequest":{"url":{"path":["reminder-flows",":reminderFlowId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"active\": \"<boolean>\",\n  \"conditions\": [\n    {\n      \"field\": \"AGREEMENT_CURRENCY\",\n      \"operator\": \"IS_NOT_EMPTY\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"CUSTOMER_COUNTRY\",\n      \"operator\": \"ON_OR_BEFORE\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"steps\": [\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    },\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    }\n  ],\n  \"metaData\": {\n    \"aliquip_7\": \"<string>\",\n    \"commodo_c79\": \"<string>\",\n    \"enim4\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"active\": \"<boolean>\",\n  \"steps\": [\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    },\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    }\n  ],\n  \"conditions\": [\n    {\n      \"field\": \"AGREEMENT_CURRENCY\",\n      \"operator\": \"GREATER_THAN\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"INVOICE_ISSUE_DATE\",\n      \"operator\": \"LESS_THAN\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"metaData\": {\n    \"eiusmodd\": \"<string>\",\n    \"deserunt3\": \"<string>\",\n    \"anim984\": \"<string>\",\n    \"quis_ba\": \"<string>\"\n  },\n  \"createdAt\": \"<dateTime>\",\n  \"modifiedAt\": \"<dateTime>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ca25e717-5c97-4eeb-a14d-fbd7d87f07b9","name":"404 response","originalRequest":{"url":{"path":["reminder-flows",":reminderFlowId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"active\": \"<boolean>\",\n  \"conditions\": [\n    {\n      \"field\": \"AGREEMENT_CURRENCY\",\n      \"operator\": \"IS_NOT_EMPTY\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"CUSTOMER_COUNTRY\",\n      \"operator\": \"ON_OR_BEFORE\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"steps\": [\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    },\n    {\n      \"daysAfter\": \"<integer>\",\n      \"emailSubject\": \"<string>\",\n      \"emailContent\": \"<string>\"\n    }\n  ],\n  \"metaData\": {\n    \"aliquip_7\": \"<string>\",\n    \"commodo_c79\": \"<string>\",\n    \"enim4\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Not Found","code":404,"header":[],"cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5d56996a-468b-4d99-bfff-683ec687827f","name":"Delete reminder flow","request":{"name":"Delete reminder flow","description":{"content":"Deletes a reminder flow. This will not affect existing executions.","type":"text/plain"},"url":{"path":["reminder-flows",":reminderFlowId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"reminderFlowId","disabled":false,"description":{"content":"(Required) The reminder flow ID","type":"text/plain"}}]},"method":"DELETE","body":{},"auth":null},"response":[{"id":"60d21f84-bdfa-496f-8856-e6fe98a9d2a1","name":"Reminder flow deleted successfully","originalRequest":{"url":{"path":["reminder-flows",":reminderFlowId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[],"cookie":[],"_postman_previewlanguage":"text"},{"id":"f07f173e-fb05-44de-a3c7-1c9bf655e5f0","name":"404 response","originalRequest":{"url":{"path":["reminder-flows",":reminderFlowId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[],"cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b2454def-d95c-43f4-bf6a-e93a306d4b75","name":"List reminder flow runs","request":{"name":"List reminder flow runs","description":{"content":"Retrieves run history for a specific reminder flow.","type":"text/plain"},"url":{"path":["reminder-flows",":reminderFlowId","runs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of items to return (max 100)","type":"text/plain"},"key":"limit","value":"20"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to start after","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to end before","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[{"type":"any","value":"<string>","key":"reminderFlowId","disabled":false,"description":{"content":"(Required) The reminder flow ID","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"ad6b5c75-6461-4a59-851c-8fe4f8cc29d4","name":"A list of reminder flow runs","originalRequest":{"url":{"path":["reminder-flows",":reminderFlowId","runs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of items to return (max 100)","type":"text/plain"},"key":"limit","value":"20"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to start after","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to end before","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"runs\": [\n    {\n      \"id\": \"<string>\",\n      \"reminderFlowId\": \"<string>\",\n      \"invoiceId\": \"<string>\",\n      \"status\": \"Completed\",\n      \"stepExecutions\": [\n        {\n          \"stepIndex\": \"<integer>\",\n          \"scheduledAt\": \"<dateTime>\",\n          \"executedAt\": \"<dateTime>\",\n          \"emailSubject\": \"<string>\",\n          \"emailContent\": \"<string>\",\n          \"recipientEmails\": [\n            \"<string>\",\n            \"<string>\"\n          ]\n        },\n        {\n          \"stepIndex\": \"<integer>\",\n          \"scheduledAt\": \"<dateTime>\",\n          \"executedAt\": \"<dateTime>\",\n          \"emailSubject\": \"<string>\",\n          \"emailContent\": \"<string>\",\n          \"recipientEmails\": [\n            \"<string>\",\n            \"<string>\"\n          ]\n        }\n      ],\n      \"createdAt\": \"<dateTime>\",\n      \"nextStepIndex\": \"<integer>\",\n      \"nextExecutionAt\": \"<dateTime>\",\n      \"invoice\": {\n        \"id\": \"<string>\",\n        \"fullInvoiceNumber\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"total\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"dueDate\": \"<date>\",\n        \"isOverdue\": \"<boolean>\"\n      }\n    },\n    {\n      \"id\": \"<string>\",\n      \"reminderFlowId\": \"<string>\",\n      \"invoiceId\": \"<string>\",\n      \"status\": \"Completed\",\n      \"stepExecutions\": [\n        {\n          \"stepIndex\": \"<integer>\",\n          \"scheduledAt\": \"<dateTime>\",\n          \"executedAt\": \"<dateTime>\",\n          \"emailSubject\": \"<string>\",\n          \"emailContent\": \"<string>\",\n          \"recipientEmails\": [\n            \"<string>\",\n            \"<string>\"\n          ]\n        },\n        {\n          \"stepIndex\": \"<integer>\",\n          \"scheduledAt\": \"<dateTime>\",\n          \"executedAt\": \"<dateTime>\",\n          \"emailSubject\": \"<string>\",\n          \"emailContent\": \"<string>\",\n          \"recipientEmails\": [\n            \"<string>\",\n            \"<string>\"\n          ]\n        }\n      ],\n      \"createdAt\": \"<dateTime>\",\n      \"nextStepIndex\": \"<integer>\",\n      \"nextExecutionAt\": \"<dateTime>\",\n      \"invoice\": {\n        \"id\": \"<string>\",\n        \"fullInvoiceNumber\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"total\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"dueDate\": \"<date>\",\n        \"isOverdue\": \"<boolean>\"\n      }\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"901eb5e6-a1fd-48cc-ac47-6e9a44ddeaaa","name":"404 response","originalRequest":{"url":{"path":["reminder-flows",":reminderFlowId","runs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of items to return (max 100)","type":"text/plain"},"key":"limit","value":"20"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to start after","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to end before","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[],"cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"57c7bbc3-9fc7-4c84-9c59-05cc3cf7d099","name":"List all reminder flow runs","request":{"name":"List all reminder flow runs","description":{"content":"Retrieves all reminder flow runs across all flows for the account, with optional filtering.","type":"text/plain"},"url":{"path":["reminder-flow-runs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of items to return (max 100)","type":"text/plain"},"key":"limit","value":"20"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to start after","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to end before","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter runs by specific reminder flow","type":"text/plain"},"key":"reminderFlowId","value":"<string>"},{"disabled":false,"description":{"content":"Filter runs by status","type":"text/plain"},"key":"status","value":"Completed"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"7856634b-a2ca-447f-81e2-12fc4887be59","name":"A list of reminder flow runs","originalRequest":{"url":{"path":["reminder-flow-runs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of items to return (max 100)","type":"text/plain"},"key":"limit","value":"20"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to start after","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to end before","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter runs by specific reminder flow","type":"text/plain"},"key":"reminderFlowId","value":"<string>"},{"disabled":false,"description":{"content":"Filter runs by status","type":"text/plain"},"key":"status","value":"Completed"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"totalCount\": \"<integer>\",\n  \"hasMore\": \"<boolean>\",\n  \"runs\": [\n    {\n      \"id\": \"<string>\",\n      \"reminderFlowId\": \"<string>\",\n      \"invoiceId\": \"<string>\",\n      \"status\": \"Active\",\n      \"stepExecutions\": [\n        {\n          \"stepIndex\": \"<integer>\",\n          \"scheduledAt\": \"<dateTime>\",\n          \"executedAt\": \"<dateTime>\",\n          \"emailSubject\": \"<string>\",\n          \"emailContent\": \"<string>\",\n          \"recipientEmails\": [\n            \"<string>\",\n            \"<string>\"\n          ]\n        },\n        {\n          \"stepIndex\": \"<integer>\",\n          \"scheduledAt\": \"<dateTime>\",\n          \"executedAt\": \"<dateTime>\",\n          \"emailSubject\": \"<string>\",\n          \"emailContent\": \"<string>\",\n          \"recipientEmails\": [\n            \"<string>\",\n            \"<string>\"\n          ]\n        }\n      ],\n      \"createdAt\": \"<dateTime>\",\n      \"nextStepIndex\": \"<integer>\",\n      \"nextExecutionAt\": \"<dateTime>\",\n      \"invoice\": {\n        \"id\": \"<string>\",\n        \"fullInvoiceNumber\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"total\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"dueDate\": \"<date>\",\n        \"isOverdue\": \"<boolean>\"\n      }\n    },\n    {\n      \"id\": \"<string>\",\n      \"reminderFlowId\": \"<string>\",\n      \"invoiceId\": \"<string>\",\n      \"status\": \"Active\",\n      \"stepExecutions\": [\n        {\n          \"stepIndex\": \"<integer>\",\n          \"scheduledAt\": \"<dateTime>\",\n          \"executedAt\": \"<dateTime>\",\n          \"emailSubject\": \"<string>\",\n          \"emailContent\": \"<string>\",\n          \"recipientEmails\": [\n            \"<string>\",\n            \"<string>\"\n          ]\n        },\n        {\n          \"stepIndex\": \"<integer>\",\n          \"scheduledAt\": \"<dateTime>\",\n          \"executedAt\": \"<dateTime>\",\n          \"emailSubject\": \"<string>\",\n          \"emailContent\": \"<string>\",\n          \"recipientEmails\": [\n            \"<string>\",\n            \"<string>\"\n          ]\n        }\n      ],\n      \"createdAt\": \"<dateTime>\",\n      \"nextStepIndex\": \"<integer>\",\n      \"nextExecutionAt\": \"<dateTime>\",\n      \"invoice\": {\n        \"id\": \"<string>\",\n        \"fullInvoiceNumber\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"total\": {\n          \"currency\": \"<string>\",\n          \"amount\": \"<number>\"\n        },\n        \"dueDate\": \"<date>\",\n        \"isOverdue\": \"<boolean>\"\n      }\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4e1f9b29-91db-4b58-9520-44a87befc4fb","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["reminder-flow-runs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of items to return (max 100)","type":"text/plain"},"key":"limit","value":"20"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to start after","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"Cursor for pagination - ID to end before","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter runs by specific reminder flow","type":"text/plain"},"key":"reminderFlowId","value":"<string>"},{"disabled":false,"description":{"content":"Filter runs by status","type":"text/plain"},"key":"status","value":"Completed"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Email templates","description":"Operations related to email templates for customizing invoice and credit note emails.\n","item":[]},{"name":"Webhooks","description":"Operations related to webhooks. Read more about [all available webhooks](https://docs.properpayments.io/get-started/webhooks#events).\n","item":[{"id":"3a181663-4b3b-49aa-a324-734043551e80","name":"List webhooks","request":{"name":"List webhooks","description":{"content":"Retrieves a list of webhooks available in your account. Read more about [all available webhooks](https://docs.properpayments.io/get-started/webhooks#events).\n","type":"text/plain"},"url":{"path":["webhooks"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"fe104ac1-e4b5-4f32-8b8c-1af1525682eb","name":"A list of webhooks","originalRequest":{"url":{"path":["webhooks"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"webhooks\": [\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"endpoint\": \"<string>\",\n      \"signingKey\": \"<string>\",\n      \"description\": \"<string>\",\n      \"events\": [\n        \"subscription.created\",\n        \"customer.settled\"\n      ]\n    },\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"endpoint\": \"<string>\",\n      \"signingKey\": \"<string>\",\n      \"description\": \"<string>\",\n      \"events\": [\n        \"invoice.overdue\",\n        \"payout.created\"\n      ]\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"da2859ee-c819-4e03-893f-e01f6f00958b","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["webhooks"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bbafdc26-13fc-4ed5-8464-2f403f449089","name":"Create webhook","request":{"name":"Create webhook","description":{"content":"Creates a new webhook.\n","type":"text/plain"},"url":{"path":["webhooks"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"endpoint\": \"<string>\",\n  \"description\": \"<string>\",\n  \"events\": [\n    \"invoice.updated\",\n    \"agreement.settled\"\n  ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"1e9a1ca3-3785-483a-a54f-590e044d20ed","name":"The created webhook","originalRequest":{"url":{"path":["webhooks"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"endpoint\": \"<string>\",\n  \"description\": \"<string>\",\n  \"events\": [\n    \"invoice.updated\",\n    \"agreement.settled\"\n  ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"signingKey\": \"<string>\",\n  \"description\": \"<string>\",\n  \"events\": [\n    \"subscription.created\",\n    \"invoice.finalised\"\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"28c306c7-f32f-4092-b1bb-f13cffebc492","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["webhooks"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"endpoint\": \"<string>\",\n  \"description\": \"<string>\",\n  \"events\": [\n    \"invoice.updated\",\n    \"agreement.settled\"\n  ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e502208d-275f-4264-9d99-7907c9d0c4bc","name":"Get webhook","request":{"name":"Get webhook","description":{"content":"Retrieves the details of an existing webhook. You need to supply the unique webhook identifier that was returned upon webhook creation.\n","type":"text/plain"},"url":{"path":["webhooks",":webhookId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"webhookId","disabled":false,"description":{"content":"(Required) The ID of the webhook to retrieve.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"07f7404d-dbef-4753-8487-c49088b6c08e","name":"The webhook details","originalRequest":{"url":{"path":["webhooks",":webhookId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"signingKey\": \"<string>\",\n  \"description\": \"<string>\",\n  \"events\": [\n    \"subscription.created\",\n    \"invoice.finalised\"\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"312a7abe-334b-439f-969b-fce79a48c429","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["webhooks",":webhookId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cfbd9347-addb-4237-a3c8-b4fe5f03c975","name":"Delete webhook","request":{"name":"Delete webhook","description":{"content":"Deletes the webhook. You need to supply the unique webhook identifier that was returned upon webhook creation.\n","type":"text/plain"},"url":{"path":["webhooks",":webhookId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"webhookId","disabled":false,"description":{"content":"(Required) The ID of the webhook to delete","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"806f6df2-e6ef-43ad-99eb-e1c1d5d4e572","name":"A blank json object","originalRequest":{"url":{"path":["webhooks",":webhookId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"43b65475-45ca-4d40-b8ec-123e50b904b5","name":"Update webhook","request":{"name":"Update webhook","description":{"content":"Update the webhook. You need to supply the unique webhook identifier that was returned upon webhook creation.\n","type":"text/plain"},"url":{"path":["webhooks",":webhookId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"webhookId","disabled":false,"description":{"content":"(Required) The ID of the webhook to retrieve.","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"endpoint\": \"<string>\",\n  \"description\": \"<string>\",\n  \"events\": [\n    \"invoice.created\",\n    \"customer.overdue\"\n  ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"77fbf921-09ce-4dd0-b75a-7b91dd6a1cd8","name":"The webhook details","originalRequest":{"url":{"path":["webhooks",":webhookId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"endpoint\": \"<string>\",\n  \"description\": \"<string>\",\n  \"events\": [\n    \"invoice.created\",\n    \"customer.overdue\"\n  ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"signingKey\": \"<string>\",\n  \"description\": \"<string>\",\n  \"events\": [\n    \"subscription.created\",\n    \"invoice.finalised\"\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eb939720-3077-44bd-bd5c-01fb97f5f6e3","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["webhooks",":webhookId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"endpoint\": \"<string>\",\n  \"description\": \"<string>\",\n  \"events\": [\n    \"invoice.created\",\n    \"customer.overdue\"\n  ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d22e07cc-fd1b-4151-b264-b570040a9087","name":"Test Webhook","request":{"name":"Test Webhook","description":{"content":"Trigger an execution of the Webhook simulating the provided event using test data.\n","type":"text/plain"},"url":{"path":["webhooks",":webhookId","test"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The name of the event to test (see [Webhook events](https://docs.properpayments.io/get-started/webhooks#webhook-events) for a list of available events).","type":"text/plain"},"key":"eventName","value":"<string>"}],"variable":[{"type":"any","value":"<string>","key":"webhookId","disabled":false,"description":{"content":"(Required) The ID of the webhook to test.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{},"auth":null},"response":[{"id":"fbb2003c-acd7-451d-9db3-ab448977c168","name":"The webhook event for the execution","originalRequest":{"url":{"path":["webhooks",":webhookId","test"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The name of the event to test (see [Webhook events](https://docs.properpayments.io/get-started/webhooks#webhook-events) for a list of available events).","type":"text/plain"},"key":"eventName","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"eventId\": \"<string>\",\n  \"webhookId\": \"<string>\",\n  \"eventName\": \"<string>\",\n  \"eventTime\": \"<dateTime>\",\n  \"event\": {\n    \"consecteturf\": \"irure dese\",\n    \"aliqua_3\": false\n  },\n  \"status\": \"Pending\",\n  \"responses\": [\n    {\n      \"timestamp\": \"<dateTime>\",\n      \"responseCode\": \"<integer>\",\n      \"responseMessage\": \"<string>\",\n      \"responseBody\": \"<string>\"\n    },\n    {\n      \"timestamp\": \"<dateTime>\",\n      \"responseCode\": \"<integer>\",\n      \"responseMessage\": \"<string>\",\n      \"responseBody\": \"<string>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d1247d54-46ab-4c4e-bef5-278d6945f4f0","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["webhooks",":webhookId","test"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The name of the event to test (see [Webhook events](https://docs.properpayments.io/get-started/webhooks#webhook-events) for a list of available events).","type":"text/plain"},"key":"eventName","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5e106012-afe5-491a-9fa6-0d6a3b302282","name":"Preview Webhook content","request":{"name":"Preview Webhook content","description":{"content":"Get a preview of the response that is sent back for the given webhook event.\n","type":"text/plain"},"url":{"path":["webhooks","preview"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The name of the event to preview (see [Webhook events](https://docs.properpayments.io/get-started/webhooks#webhook-events) for a list of available events).","type":"text/plain"},"key":"eventName","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{},"auth":null},"response":[{"id":"3d33ab79-44f9-40c5-bd70-f59b4a443593","name":"The same JSON that will be in the body of the webhook call","originalRequest":{"url":{"path":["webhooks","preview"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The name of the event to preview (see [Webhook events](https://docs.properpayments.io/get-started/webhooks#webhook-events) for a list of available events).","type":"text/plain"},"key":"eventName","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"cupidatat_87\": true,\n  \"Duis_f\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e18eb83a-d198-490f-bbc5-f5aaeac4f0e2","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["webhooks","preview"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The name of the event to preview (see [Webhook events](https://docs.properpayments.io/get-started/webhooks#webhook-events) for a list of available events).","type":"text/plain"},"key":"eventName","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b7a92701-8333-4c14-9bcc-f8ed487bbfba","name":"List webhook events","request":{"name":"List webhook events","description":{"content":"Retrieves a list of events for a specific webhook.\n","type":"text/plain"},"url":{"path":["webhook-events"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The ID of the webhook to retrieve events for.","type":"text/plain"},"key":"webhookId","value":"<string>"},{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"2fcb71fc-a75a-404f-b964-b2d679806fe3","name":"A list of webhook events","originalRequest":{"url":{"path":["webhook-events"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The ID of the webhook to retrieve events for.","type":"text/plain"},"key":"webhookId","value":"<string>"},{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"webhookEvents\": [\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"eventId\": \"<string>\",\n      \"webhookId\": \"<string>\",\n      \"eventName\": \"<string>\",\n      \"eventTime\": \"<dateTime>\",\n      \"event\": {\n        \"anim_7e\": \"elit adipisicing commodo dolor\",\n        \"irure77\": -87183072\n      },\n      \"status\": \"Pending\",\n      \"responses\": [\n        {\n          \"timestamp\": \"<dateTime>\",\n          \"responseCode\": \"<integer>\",\n          \"responseMessage\": \"<string>\",\n          \"responseBody\": \"<string>\"\n        },\n        {\n          \"timestamp\": \"<dateTime>\",\n          \"responseCode\": \"<integer>\",\n          \"responseMessage\": \"<string>\",\n          \"responseBody\": \"<string>\"\n        }\n      ]\n    },\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"eventId\": \"<string>\",\n      \"webhookId\": \"<string>\",\n      \"eventName\": \"<string>\",\n      \"eventTime\": \"<dateTime>\",\n      \"event\": {\n        \"esse_651\": -81738293.29108982\n      },\n      \"status\": \"Retrying\",\n      \"responses\": [\n        {\n          \"timestamp\": \"<dateTime>\",\n          \"responseCode\": \"<integer>\",\n          \"responseMessage\": \"<string>\",\n          \"responseBody\": \"<string>\"\n        },\n        {\n          \"timestamp\": \"<dateTime>\",\n          \"responseCode\": \"<integer>\",\n          \"responseMessage\": \"<string>\",\n          \"responseBody\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"df901a4a-7b5f-40dd-82b2-c71491d66d11","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["webhook-events"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The ID of the webhook to retrieve events for.","type":"text/plain"},"key":"webhookId","value":"<string>"},{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"40c9e5c3-f43e-420c-a8b5-dc5ac9d46174","name":"Get webhook event","request":{"name":"Get webhook event","description":{"content":"Retrieves the details of an existing webhook event. You need to supply the unique event identifier that was returned upon event creation.\n","type":"text/plain"},"url":{"path":["webhook-events",":eventId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"eventId","disabled":false,"description":{"content":"(Required) The ID of the event to retrieve.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"6daa679a-d664-4bfc-80fc-178acdb1cfa2","name":"The webhook event details","originalRequest":{"url":{"path":["webhook-events",":eventId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"eventId\": \"<string>\",\n  \"webhookId\": \"<string>\",\n  \"eventName\": \"<string>\",\n  \"eventTime\": \"<dateTime>\",\n  \"event\": {\n    \"consecteturf\": \"irure dese\",\n    \"aliqua_3\": false\n  },\n  \"status\": \"Pending\",\n  \"responses\": [\n    {\n      \"timestamp\": \"<dateTime>\",\n      \"responseCode\": \"<integer>\",\n      \"responseMessage\": \"<string>\",\n      \"responseBody\": \"<string>\"\n    },\n    {\n      \"timestamp\": \"<dateTime>\",\n      \"responseCode\": \"<integer>\",\n      \"responseMessage\": \"<string>\",\n      \"responseBody\": \"<string>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d656bc26-707b-4bba-b653-69a5865383c9","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["webhook-events",":eventId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Activities","description":"Operations related to entity activities.\n","item":[{"id":"3ccb8e27-634b-4d29-893a-6aeb90f2cad3","name":"List activities","request":{"name":"List activities","description":{"content":"Retrieves a list of activities on an entity.","type":"text/plain"},"url":{"path":["activities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The ID of the entity to retrieve activities for.","type":"text/plain"},"key":"entityId","value":"<string>"},{"disabled":false,"description":{"content":"(Required) The type of entity to retrieve activities for.","type":"text/plain"},"key":"entityType","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"bc7b8399-9980-48dd-bf38-ab01504d8c17","name":"A list of activities","originalRequest":{"url":{"path":["activities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The ID of the entity to retrieve activities for.","type":"text/plain"},"key":"entityId","value":"<string>"},{"disabled":false,"description":{"content":"(Required) The type of entity to retrieve activities for.","type":"text/plain"},"key":"entityType","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"activities\": [\n    {\n      \"id\": \"<string>\",\n      \"entityType\": \"<string>\",\n      \"entityId\": \"<string>\",\n      \"action\": \"<string>\",\n      \"actor\": \"API\",\n      \"timestamp\": \"<dateTime>\",\n      \"actorId\": \"<string>\",\n      \"payload\": {}\n    },\n    {\n      \"id\": \"<string>\",\n      \"entityType\": \"<string>\",\n      \"entityId\": \"<string>\",\n      \"action\": \"<string>\",\n      \"actor\": \"User\",\n      \"timestamp\": \"<dateTime>\",\n      \"actorId\": \"<string>\",\n      \"payload\": {}\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fb2fa041-0c98-4638-afe3-05e8dd12a490","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["activities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The ID of the entity to retrieve activities for.","type":"text/plain"},"key":"entityId","value":"<string>"},{"disabled":false,"description":{"content":"(Required) The type of entity to retrieve activities for.","type":"text/plain"},"key":"entityType","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"96ea1cb1-0ce2-4cb4-8bc8-950809877643","name":"403 response","originalRequest":{"url":{"path":["activities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The ID of the entity to retrieve activities for.","type":"text/plain"},"key":"entityId","value":"<string>"},{"disabled":false,"description":{"content":"(Required) The type of entity to retrieve activities for.","type":"text/plain"},"key":"entityType","value":"<string>"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[],"cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Logs","description":"Operations related to logs.\n","item":[{"id":"dd83fe67-565c-4729-8214-860952c8df26","name":"List logs","request":{"name":"List logs","description":{"content":"Retrieves a list of logs of all calls made with the API key used to authentication the call.\n","type":"text/plain"},"url":{"path":["logs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"e3cb08a6-bc5f-4be5-abd5-7a6ccb491289","name":"A list of logs","originalRequest":{"url":{"path":["logs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"logs\": [\n    {\n      \"id\": \"<string>\",\n      \"createdAt\": \"<dateTime>\",\n      \"requestId\": \"<string>\",\n      \"path\": \"<string>\",\n      \"requestBody\": \"<string>\",\n      \"responseBody\": \"<string>\",\n      \"method\": \"<string>\",\n      \"statusCode\": \"<integer>\",\n      \"ipAddress\": \"<string>\",\n      \"queryString\": \"<string>\",\n      \"userAgent\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"createdAt\": \"<dateTime>\",\n      \"requestId\": \"<string>\",\n      \"path\": \"<string>\",\n      \"requestBody\": \"<string>\",\n      \"responseBody\": \"<string>\",\n      \"method\": \"<string>\",\n      \"statusCode\": \"<integer>\",\n      \"ipAddress\": \"<string>\",\n      \"queryString\": \"<string>\",\n      \"userAgent\": \"<string>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Alerts","description":"Operations related to alerts.\n","item":[{"id":"aec8ab22-e56b-493e-9d40-c36f3d68d026","name":"List alerts","request":{"name":"List alerts","description":{"content":"Retrieves a list of alerts that happened on the account.\n","type":"text/plain"},"url":{"path":["alerts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on alerts with the provided source.","type":"text/plain"},"key":"alertSource","value":"<string>"},{"disabled":false,"description":{"content":"Filter on alerts with the provided reason.","type":"text/plain"},"key":"alertReason","value":"<string>"},{"disabled":false,"description":{"content":"Filter on alerts with the provided contextName.","type":"text/plain"},"key":"alertContextName","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"88b1dfa6-e446-460b-94e8-718837c33456","name":"A list of alerts","originalRequest":{"url":{"path":["alerts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This specifies a limit on the number of objects to return, ranging between 1 and 100. Default value is 20.","type":"text/plain"},"key":"limit","value":"<integer>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `startingAfter` is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with `obj_abc`, your subsequent call can include `startingAfter=obj_abc` to fetch the next page of the list.","type":"text/plain"},"key":"startingAfter","value":"<string>"},{"disabled":false,"description":{"content":"A cursor to use in pagination. `endingBefore` is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects, the first with `obj_abc`, your subsequent call can include `endingBefore=obj_abc` to fetch the previous page of the list.","type":"text/plain"},"key":"endingBefore","value":"<string>"},{"disabled":false,"description":{"content":"Filter on alerts with the provided source.","type":"text/plain"},"key":"alertSource","value":"<string>"},{"disabled":false,"description":{"content":"Filter on alerts with the provided reason.","type":"text/plain"},"key":"alertReason","value":"<string>"},{"disabled":false,"description":{"content":"Filter on alerts with the provided contextName.","type":"text/plain"},"key":"alertContextName","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"alerts\": [\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"alertSource\": \"Webhook\",\n      \"alertReason\": \"<string>\",\n      \"alertTime\": \"<dateTime>\",\n      \"alertMessage\": \"<string>\",\n      \"alertContext\": {\n        \"contextName\": \"<string>\",\n        \"customerId\": \"<string>\",\n        \"agreementId\": \"<string>\",\n        \"subscriptionId\": \"<string>\",\n        \"invoiceId\": \"<string>\",\n        \"creditNoteId\": \"<string>\",\n        \"taxRateId\": \"<string>\",\n        \"productId\": \"<string>\",\n        \"webhookId\": \"<string>\"\n      }\n    },\n    {\n      \"id\": \"<string>\",\n      \"accountId\": \"<string>\",\n      \"alertSource\": \"Webhook\",\n      \"alertReason\": \"<string>\",\n      \"alertTime\": \"<dateTime>\",\n      \"alertMessage\": \"<string>\",\n      \"alertContext\": {\n        \"contextName\": \"<string>\",\n        \"customerId\": \"<string>\",\n        \"agreementId\": \"<string>\",\n        \"subscriptionId\": \"<string>\",\n        \"invoiceId\": \"<string>\",\n        \"creditNoteId\": \"<string>\",\n        \"taxRateId\": \"<string>\",\n        \"productId\": \"<string>\",\n        \"webhookId\": \"<string>\"\n      }\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"627c5845-360d-41c5-90e5-262b7deffc9b","name":"List alert","request":{"name":"List alert","description":{"content":"Retrieves the alert with the given id.\n","type":"text/plain"},"url":{"path":["alerts",":alertId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"alertId","disabled":false,"description":{"content":"(Required) ","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"2acdf653-15fd-4e8f-b8a8-1eb1e2211421","name":"The alert","originalRequest":{"url":{"path":["alerts",":alertId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"alertSource\": \"Economic\",\n  \"alertReason\": \"<string>\",\n  \"alertTime\": \"<dateTime>\",\n  \"alertMessage\": \"<string>\",\n  \"alertContext\": {\n    \"contextName\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"agreementId\": \"<string>\",\n    \"subscriptionId\": \"<string>\",\n    \"invoiceId\": \"<string>\",\n    \"creditNoteId\": \"<string>\",\n    \"taxRateId\": \"<string>\",\n    \"productId\": \"<string>\",\n    \"webhookId\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Account settings","description":"Operations related to settings on the account.\n","item":[{"id":"914679d8-fadf-4c67-baf7-97b2fc88e2f7","name":"Get account settings","request":{"name":"Get account settings","description":{"content":"Retrieves the settings for the account\n","type":"text/plain"},"url":{"path":["accounts","settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"57af7172-9cb4-4660-a1fa-09e9d098287d","name":"The settings","originalRequest":{"url":{"path":["accounts","settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"nextInvoiceNumber\": \"<integer>\",\n  \"invoiceNumberPrefix\": \"<string>\",\n  \"currencies\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2a8263d8-20d9-4941-8f9a-216c689549d8","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["accounts","settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"17a542f0-4610-4113-bddc-97875ddfead7","name":"Update account settings","request":{"name":"Update account settings","description":{"content":"Update the account settings\n","type":"text/plain"},"url":{"path":["accounts","settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"invoiceStartNumber\": \"<integer>\",\n  \"invoiceNumberPrefix\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"1f782813-62f5-42d9-b667-55840d813bc7","name":"The settings","originalRequest":{"url":{"path":["accounts","settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"invoiceStartNumber\": \"<integer>\",\n  \"invoiceNumberPrefix\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"nextInvoiceNumber\": \"<integer>\",\n  \"invoiceNumberPrefix\": \"<string>\",\n  \"currencies\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"53004006-88bf-449c-b9bf-8475c9b04fdb","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["accounts","settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"invoiceStartNumber\": \"<integer>\",\n  \"invoiceNumberPrefix\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Integrations","description":"Operations related to integrations.\n","item":[{"id":"0fb39028-4faa-455f-a2ae-a0dcdacd0154","name":"Get Visma e-conomic","request":{"name":"Get Visma e-conomic","description":{"content":"Show the current Visma e-conomic integration.\n","type":"text/plain"},"url":{"path":["integrations","e-conomic"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"1b7119f8-6bc8-45b1-b8f4-be927c366989","name":"The configuration","originalRequest":{"url":{"path":["integrations","e-conomic"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"agreementGrantTokenHint\": \"<string>\",\n  \"active\": \"<boolean>\",\n  \"layoutNumber\": \"<integer>\",\n  \"paymentTermNumber\": \"<integer>\",\n  \"bankAccountNumbers\": {\n    \"consequat_211\": \"<integer>\",\n    \"dolore_a\": \"<integer>\",\n    \"ullamco_cf\": \"<integer>\",\n    \"pariatur_a\": \"<integer>\"\n  },\n  \"journalNumber\": \"<integer>\",\n  \"registerExternalPayments\": \"<boolean>\",\n  \"accrualEnabled\": \"<boolean>\",\n  \"skipAccrualForSameMonthInvoices\": false,\n  \"customerGroupMappings\": {\n    \"defaultCustomerGroup\": \"<integer>\"\n  },\n  \"vatZoneMappings\": {\n    \"mappings\": [\n      {\n        \"region\": \"EU\",\n        \"legalEntity\": \"Company\",\n        \"vatZone\": \"<integer>\"\n      },\n      {\n        \"region\": \"DK\",\n        \"legalEntity\": \"Company\",\n        \"vatZone\": \"<integer>\"\n      }\n    ]\n  },\n  \"products\": [\n    {\n      \"productId\": \"<string>\",\n      \"accrualEnabled\": \"<boolean>\",\n      \"taxRateMappings\": [\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        },\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        }\n      ]\n    },\n    {\n      \"productId\": \"<string>\",\n      \"accrualEnabled\": \"<boolean>\",\n      \"taxRateMappings\": [\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        },\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"customers\": [\n    {\n      \"customerId\": \"<string>\",\n      \"customerNumber\": \"<integer>\"\n    },\n    {\n      \"customerId\": \"<string>\",\n      \"customerNumber\": \"<integer>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1b4b4eaa-e262-4df8-b681-e34091c831d7","name":"Create Visma e-conomic","request":{"name":"Create Visma e-conomic","description":{"content":"Create an integration to Visma e-conomic\n","type":"text/plain"},"url":{"path":["integrations","e-conomic"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"agreementGrantToken\": \"<string>\",\n  \"active\": \"<boolean>\",\n  \"layoutNumber\": \"<integer>\",\n  \"paymentTermsNumber\": \"<integer>\",\n  \"accrualEnabled\": \"<boolean>\",\n  \"skipAccrualForSameMonthInvoices\": false,\n  \"bankAccountNumbers\": {\n    \"ex_150\": \"<integer>\",\n    \"Duis3eb\": \"<integer>\"\n  },\n  \"journalNumber\": \"<integer>\",\n  \"registerExternalPayments\": \"<boolean>\",\n  \"customerGroupMappings\": {\n    \"defaultCustomerGroup\": \"<integer>\"\n  },\n  \"vatZoneMappings\": {\n    \"mappings\": [\n      {\n        \"region\": \"EU\",\n        \"legalEntity\": \"Company\",\n        \"vatZone\": \"<integer>\"\n      },\n      {\n        \"region\": \"DK\",\n        \"legalEntity\": \"Company\",\n        \"vatZone\": \"<integer>\"\n      }\n    ]\n  },\n  \"products\": [\n    {\n      \"productId\": \"<string>\",\n      \"accrualEnabled\": \"<boolean>\",\n      \"taxRateMappings\": [\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        },\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        }\n      ]\n    },\n    {\n      \"productId\": \"<string>\",\n      \"accrualEnabled\": \"<boolean>\",\n      \"taxRateMappings\": [\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        },\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"customers\": [\n    {\n      \"customerId\": \"<string>\",\n      \"customerNumber\": \"<integer>\"\n    },\n    {\n      \"customerId\": \"<string>\",\n      \"customerNumber\": \"<integer>\"\n    }\n  ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"ae3e3901-988a-4dcd-9f06-f8692655054e","name":"The configuration","originalRequest":{"url":{"path":["integrations","e-conomic"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"agreementGrantToken\": \"<string>\",\n  \"active\": \"<boolean>\",\n  \"layoutNumber\": \"<integer>\",\n  \"paymentTermsNumber\": \"<integer>\",\n  \"accrualEnabled\": \"<boolean>\",\n  \"skipAccrualForSameMonthInvoices\": false,\n  \"bankAccountNumbers\": {\n    \"ex_150\": \"<integer>\",\n    \"Duis3eb\": \"<integer>\"\n  },\n  \"journalNumber\": \"<integer>\",\n  \"registerExternalPayments\": \"<boolean>\",\n  \"customerGroupMappings\": {\n    \"defaultCustomerGroup\": \"<integer>\"\n  },\n  \"vatZoneMappings\": {\n    \"mappings\": [\n      {\n        \"region\": \"EU\",\n        \"legalEntity\": \"Company\",\n        \"vatZone\": \"<integer>\"\n      },\n      {\n        \"region\": \"DK\",\n        \"legalEntity\": \"Company\",\n        \"vatZone\": \"<integer>\"\n      }\n    ]\n  },\n  \"products\": [\n    {\n      \"productId\": \"<string>\",\n      \"accrualEnabled\": \"<boolean>\",\n      \"taxRateMappings\": [\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        },\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        }\n      ]\n    },\n    {\n      \"productId\": \"<string>\",\n      \"accrualEnabled\": \"<boolean>\",\n      \"taxRateMappings\": [\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        },\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"customers\": [\n    {\n      \"customerId\": \"<string>\",\n      \"customerNumber\": \"<integer>\"\n    },\n    {\n      \"customerId\": \"<string>\",\n      \"customerNumber\": \"<integer>\"\n    }\n  ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"agreementGrantTokenHint\": \"<string>\",\n  \"active\": \"<boolean>\",\n  \"layoutNumber\": \"<integer>\",\n  \"paymentTermNumber\": \"<integer>\",\n  \"bankAccountNumbers\": {\n    \"consequat_211\": \"<integer>\",\n    \"dolore_a\": \"<integer>\",\n    \"ullamco_cf\": \"<integer>\",\n    \"pariatur_a\": \"<integer>\"\n  },\n  \"journalNumber\": \"<integer>\",\n  \"registerExternalPayments\": \"<boolean>\",\n  \"accrualEnabled\": \"<boolean>\",\n  \"skipAccrualForSameMonthInvoices\": false,\n  \"customerGroupMappings\": {\n    \"defaultCustomerGroup\": \"<integer>\"\n  },\n  \"vatZoneMappings\": {\n    \"mappings\": [\n      {\n        \"region\": \"EU\",\n        \"legalEntity\": \"Company\",\n        \"vatZone\": \"<integer>\"\n      },\n      {\n        \"region\": \"DK\",\n        \"legalEntity\": \"Company\",\n        \"vatZone\": \"<integer>\"\n      }\n    ]\n  },\n  \"products\": [\n    {\n      \"productId\": \"<string>\",\n      \"accrualEnabled\": \"<boolean>\",\n      \"taxRateMappings\": [\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        },\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        }\n      ]\n    },\n    {\n      \"productId\": \"<string>\",\n      \"accrualEnabled\": \"<boolean>\",\n      \"taxRateMappings\": [\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        },\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"customers\": [\n    {\n      \"customerId\": \"<string>\",\n      \"customerNumber\": \"<integer>\"\n    },\n    {\n      \"customerId\": \"<string>\",\n      \"customerNumber\": \"<integer>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c7d16120-7b6f-4e9b-8794-311b60df5488","name":"Update Visma e-conomic","request":{"name":"Update Visma e-conomic","description":{"content":"Update the current Visma e-conomic integration\n","type":"text/plain"},"url":{"path":["integrations","e-conomic"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"agreementGrantToken\": \"<string>\",\n  \"active\": \"<boolean>\",\n  \"layoutNumber\": \"<integer>\",\n  \"paymentTermsNumber\": \"<integer>\",\n  \"accrualEnabled\": \"<boolean>\",\n  \"skipAccrualForSameMonthInvoices\": false,\n  \"bankAccountNumbers\": {\n    \"proident8c\": \"<integer>\",\n    \"aliquip_4d\": \"<integer>\",\n    \"dolore_4\": \"<integer>\"\n  },\n  \"journalNumber\": \"<integer>\",\n  \"registerExternalPayments\": \"<boolean>\",\n  \"customerGroupMappings\": {\n    \"defaultCustomerGroup\": \"<integer>\"\n  },\n  \"vatZoneMappings\": {\n    \"mappings\": [\n      {\n        \"region\": \"EU\",\n        \"legalEntity\": \"Individual\",\n        \"vatZone\": \"<integer>\"\n      },\n      {\n        \"region\": \"Abroad\",\n        \"legalEntity\": \"Company\",\n        \"vatZone\": \"<integer>\"\n      }\n    ]\n  },\n  \"products\": {\n    \"updateType\": \"Delete\",\n    \"products\": [\n      {\n        \"productId\": \"<string>\",\n        \"accrualEnabled\": \"<boolean>\",\n        \"taxRateMappings\": [\n          {\n            \"taxRateId\": \"<string>\",\n            \"productNumber\": \"<string>\"\n          },\n          {\n            \"taxRateId\": \"<string>\",\n            \"productNumber\": \"<string>\"\n          }\n        ]\n      },\n      {\n        \"productId\": \"<string>\",\n        \"accrualEnabled\": \"<boolean>\",\n        \"taxRateMappings\": [\n          {\n            \"taxRateId\": \"<string>\",\n            \"productNumber\": \"<string>\"\n          },\n          {\n            \"taxRateId\": \"<string>\",\n            \"productNumber\": \"<string>\"\n          }\n        ]\n      }\n    ]\n  },\n  \"customers\": {\n    \"updateType\": \"Update\",\n    \"customers\": [\n      {\n        \"customerId\": \"<string>\",\n        \"customerNumber\": \"<integer>\"\n      },\n      {\n        \"customerId\": \"<string>\",\n        \"customerNumber\": \"<integer>\"\n      }\n    ]\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"cc031209-799e-4aab-a2b1-df28f5da3716","name":"The configuration","originalRequest":{"url":{"path":["integrations","e-conomic"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"agreementGrantToken\": \"<string>\",\n  \"active\": \"<boolean>\",\n  \"layoutNumber\": \"<integer>\",\n  \"paymentTermsNumber\": \"<integer>\",\n  \"accrualEnabled\": \"<boolean>\",\n  \"skipAccrualForSameMonthInvoices\": false,\n  \"bankAccountNumbers\": {\n    \"proident8c\": \"<integer>\",\n    \"aliquip_4d\": \"<integer>\",\n    \"dolore_4\": \"<integer>\"\n  },\n  \"journalNumber\": \"<integer>\",\n  \"registerExternalPayments\": \"<boolean>\",\n  \"customerGroupMappings\": {\n    \"defaultCustomerGroup\": \"<integer>\"\n  },\n  \"vatZoneMappings\": {\n    \"mappings\": [\n      {\n        \"region\": \"EU\",\n        \"legalEntity\": \"Individual\",\n        \"vatZone\": \"<integer>\"\n      },\n      {\n        \"region\": \"Abroad\",\n        \"legalEntity\": \"Company\",\n        \"vatZone\": \"<integer>\"\n      }\n    ]\n  },\n  \"products\": {\n    \"updateType\": \"Delete\",\n    \"products\": [\n      {\n        \"productId\": \"<string>\",\n        \"accrualEnabled\": \"<boolean>\",\n        \"taxRateMappings\": [\n          {\n            \"taxRateId\": \"<string>\",\n            \"productNumber\": \"<string>\"\n          },\n          {\n            \"taxRateId\": \"<string>\",\n            \"productNumber\": \"<string>\"\n          }\n        ]\n      },\n      {\n        \"productId\": \"<string>\",\n        \"accrualEnabled\": \"<boolean>\",\n        \"taxRateMappings\": [\n          {\n            \"taxRateId\": \"<string>\",\n            \"productNumber\": \"<string>\"\n          },\n          {\n            \"taxRateId\": \"<string>\",\n            \"productNumber\": \"<string>\"\n          }\n        ]\n      }\n    ]\n  },\n  \"customers\": {\n    \"updateType\": \"Update\",\n    \"customers\": [\n      {\n        \"customerId\": \"<string>\",\n        \"customerNumber\": \"<integer>\"\n      },\n      {\n        \"customerId\": \"<string>\",\n        \"customerNumber\": \"<integer>\"\n      }\n    ]\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"agreementGrantTokenHint\": \"<string>\",\n  \"active\": \"<boolean>\",\n  \"layoutNumber\": \"<integer>\",\n  \"paymentTermNumber\": \"<integer>\",\n  \"bankAccountNumbers\": {\n    \"consequat_211\": \"<integer>\",\n    \"dolore_a\": \"<integer>\",\n    \"ullamco_cf\": \"<integer>\",\n    \"pariatur_a\": \"<integer>\"\n  },\n  \"journalNumber\": \"<integer>\",\n  \"registerExternalPayments\": \"<boolean>\",\n  \"accrualEnabled\": \"<boolean>\",\n  \"skipAccrualForSameMonthInvoices\": false,\n  \"customerGroupMappings\": {\n    \"defaultCustomerGroup\": \"<integer>\"\n  },\n  \"vatZoneMappings\": {\n    \"mappings\": [\n      {\n        \"region\": \"EU\",\n        \"legalEntity\": \"Company\",\n        \"vatZone\": \"<integer>\"\n      },\n      {\n        \"region\": \"DK\",\n        \"legalEntity\": \"Company\",\n        \"vatZone\": \"<integer>\"\n      }\n    ]\n  },\n  \"products\": [\n    {\n      \"productId\": \"<string>\",\n      \"accrualEnabled\": \"<boolean>\",\n      \"taxRateMappings\": [\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        },\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        }\n      ]\n    },\n    {\n      \"productId\": \"<string>\",\n      \"accrualEnabled\": \"<boolean>\",\n      \"taxRateMappings\": [\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        },\n        {\n          \"taxRateId\": \"<string>\",\n          \"productNumber\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"customers\": [\n    {\n      \"customerId\": \"<string>\",\n      \"customerNumber\": \"<integer>\"\n    },\n    {\n      \"customerId\": \"<string>\",\n      \"customerNumber\": \"<integer>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Connection","description":"Checking connection to the api.\n","item":[{"id":"fe26c833-c2cd-4405-bf76-72c234f43f25","name":"Check that there is a connection","request":{"name":"Check that there is a connection","description":{"content":"Call this endpoint to verify that your api key is valid. This call requires no permissions.\n","type":"text/plain"},"url":{"path":["me"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"4163d2cb-b415-4eec-a39e-c9bc471ff722","name":"Simple liveness","originalRequest":{"url":{"path":["me"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"accountId\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Search","description":"","item":[{"id":"fd9c17e8-9365-458f-876d-5cc899af0caa","name":"Search globally","request":{"name":"Search globally","description":{"content":"Searches globally across all entities in the account. The query must be at least three characters\n","type":"text/plain"},"url":{"path":["search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"query","value":"<string>"},{"disabled":false,"description":{"content":"The hits per page you want to see.","type":"text/plain"},"key":"hitsPerPage","value":"10"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"261fa6bc-61d7-4d77-a4d3-f7ab3474a5e6","name":"The search results","originalRequest":{"url":{"path":["search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"query","value":"<string>"},{"disabled":false,"description":{"content":"The hits per page you want to see.","type":"text/plain"},"key":"hitsPerPage","value":"10"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"totalCount\": \"<integer>\",\n  \"customers\": {\n    \"index\": \"<string>\",\n    \"query\": \"<string>\",\n    \"params\": \"<string>\",\n    \"count\": \"<integer>\",\n    \"hits\": [\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"name\": \"<string>\",\n        \"vatId\": \"<string>\",\n        \"address\": \"<string>\",\n        \"overdue\": \"<boolean>\",\n        \"requirements\": {\n          \"missingFields\": [\n            \"<string>\",\n            \"<string>\"\n          ]\n        }\n      },\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"name\": \"<string>\",\n        \"vatId\": \"<string>\",\n        \"address\": \"<string>\",\n        \"overdue\": \"<boolean>\",\n        \"requirements\": {\n          \"missingFields\": [\n            \"<string>\",\n            \"<string>\"\n          ]\n        }\n      }\n    ]\n  },\n  \"agreements\": {\n    \"index\": \"<string>\",\n    \"query\": \"<string>\",\n    \"params\": \"<string>\",\n    \"count\": \"<integer>\",\n    \"hits\": [\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"customerId\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"name\": \"<string>\",\n        \"invoiceEmail\": \"<string>\",\n        \"ean\": \"<string>\",\n        \"overdue\": \"<boolean>\",\n        \"balance\": \"<string>\"\n      },\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"customerId\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"name\": \"<string>\",\n        \"invoiceEmail\": \"<string>\",\n        \"ean\": \"<string>\",\n        \"overdue\": \"<boolean>\",\n        \"balance\": \"<string>\"\n      }\n    ]\n  },\n  \"subscriptions\": {\n    \"index\": \"<string>\",\n    \"query\": \"<string>\",\n    \"params\": \"<string>\",\n    \"count\": \"<integer>\",\n    \"hits\": [\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"customerId\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"agreementId\": \"<string>\",\n        \"agreementName\": \"<string>\",\n        \"productId\": \"<string>\",\n        \"productName\": \"<string>\",\n        \"status\": \"<string>\",\n        \"startDate\": \"<string>\",\n        \"pendingBillingPeriodIssueDate\": \"<string>\",\n        \"billingScheme\": \"<string>\",\n        \"billingFrequency\": {\n          \"interval\": \"Year\",\n          \"intervalCount\": \"<integer>\"\n        }\n      },\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"customerId\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"agreementId\": \"<string>\",\n        \"agreementName\": \"<string>\",\n        \"productId\": \"<string>\",\n        \"productName\": \"<string>\",\n        \"status\": \"<string>\",\n        \"startDate\": \"<string>\",\n        \"pendingBillingPeriodIssueDate\": \"<string>\",\n        \"billingScheme\": \"<string>\",\n        \"billingFrequency\": {\n          \"interval\": \"Year\",\n          \"intervalCount\": \"<integer>\"\n        }\n      }\n    ]\n  },\n  \"invoices\": {\n    \"index\": \"<string>\",\n    \"query\": \"<string>\",\n    \"params\": \"<string>\",\n    \"count\": \"<integer>\",\n    \"hits\": [\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"customerId\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"agreementId\": \"<string>\",\n        \"agreementName\": \"<string>\",\n        \"internalInvoiceNumberCounter\": \"<string>\",\n        \"fullInvoiceNumber\": \"<string>\",\n        \"total\": \"<string>\",\n        \"issuedAt\": \"<string>\",\n        \"status\": \"<string>\",\n        \"overdue\": \"<boolean>\",\n        \"dueDate\": \"<string>\",\n        \"documentId\": \"<string>\"\n      },\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"customerId\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"agreementId\": \"<string>\",\n        \"agreementName\": \"<string>\",\n        \"internalInvoiceNumberCounter\": \"<string>\",\n        \"fullInvoiceNumber\": \"<string>\",\n        \"total\": \"<string>\",\n        \"issuedAt\": \"<string>\",\n        \"status\": \"<string>\",\n        \"overdue\": \"<boolean>\",\n        \"dueDate\": \"<string>\",\n        \"documentId\": \"<string>\"\n      }\n    ]\n  },\n  \"creditNotes\": {\n    \"index\": \"<string>\",\n    \"query\": \"<string>\",\n    \"params\": \"<string>\",\n    \"count\": \"<integer>\",\n    \"hits\": [\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"customerId\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"agreementId\": \"<string>\",\n        \"agreementName\": \"<string>\",\n        \"internalInvoiceNumberCounter\": \"<string>\",\n        \"fullInvoiceNumber\": \"<string>\",\n        \"total\": \"<string>\",\n        \"issuedAt\": \"<string>\",\n        \"documentId\": \"<string>\"\n      },\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"customerId\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"agreementId\": \"<string>\",\n        \"agreementName\": \"<string>\",\n        \"internalInvoiceNumberCounter\": \"<string>\",\n        \"fullInvoiceNumber\": \"<string>\",\n        \"total\": \"<string>\",\n        \"issuedAt\": \"<string>\",\n        \"documentId\": \"<string>\"\n      }\n    ]\n  },\n  \"taxRates\": {\n    \"index\": \"<string>\",\n    \"query\": \"<string>\",\n    \"params\": \"<string>\",\n    \"count\": \"<integer>\",\n    \"hits\": [\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"displayName\": \"<string>\",\n        \"description\": \"<string>\",\n        \"rate\": \"<string>\"\n      },\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"displayName\": \"<string>\",\n        \"description\": \"<string>\",\n        \"rate\": \"<string>\"\n      }\n    ]\n  },\n  \"products\": {\n    \"index\": \"<string>\",\n    \"query\": \"<string>\",\n    \"params\": \"<string>\",\n    \"count\": \"<integer>\",\n    \"hits\": [\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"name\": \"<string>\"\n      },\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ]\n  },\n  \"payments\": {\n    \"index\": \"<string>\",\n    \"query\": \"<string>\",\n    \"params\": \"<string>\",\n    \"count\": \"<integer>\",\n    \"hits\": [\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"customerId\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"agreementId\": \"<string>\",\n        \"agreementName\": \"<string>\",\n        \"invoiceId\": \"<string>\",\n        \"invoiceNumber\": \"<string>\",\n        \"amount\": \"<string>\",\n        \"paymentDate\": \"<string>\",\n        \"handledBy\": \"<string>\"\n      },\n      {\n        \"id\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"accountId\": \"<string>\",\n        \"customerId\": \"<string>\",\n        \"customerName\": \"<string>\",\n        \"agreementId\": \"<string>\",\n        \"agreementName\": \"<string>\",\n        \"invoiceId\": \"<string>\",\n        \"invoiceNumber\": \"<string>\",\n        \"amount\": \"<string>\",\n        \"paymentDate\": \"<string>\",\n        \"handledBy\": \"<string>\"\n      }\n    ]\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"Email Templates","description":"","item":[{"id":"5454fe98-5076-413f-8bf6-1704262ec7bc","name":"List email templates","request":{"name":"List email templates","description":{"content":"Retrieves a list of email templates for your account.","type":"text/plain"},"url":{"path":["email-templates"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter by template type","type":"text/plain"},"key":"templateType","value":"CreditNote"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"cb355f34-3358-43da-997e-c6b2aa78df00","name":"List of email templates","originalRequest":{"url":{"path":["email-templates"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter by template type","type":"text/plain"},"key":"templateType","value":"CreditNote"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n  {\n    \"id\": \"<string>\",\n    \"accountId\": \"<string>\",\n    \"templateType\": \"Invoice\",\n    \"language\": \"<string>\",\n    \"subject\": \"<string>\",\n    \"content\": \"<string>\",\n    \"createdAt\": \"<dateTime>\",\n    \"modifiedAt\": \"<dateTime>\",\n    \"status\": \"Active\"\n  },\n  {\n    \"id\": \"<string>\",\n    \"accountId\": \"<string>\",\n    \"templateType\": \"Invoice\",\n    \"language\": \"<string>\",\n    \"subject\": \"<string>\",\n    \"content\": \"<string>\",\n    \"createdAt\": \"<dateTime>\",\n    \"modifiedAt\": \"<dateTime>\",\n    \"status\": \"Active\"\n  }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"bc156f34-3f42-44f7-b3c0-5f9b001c6018","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["email-templates"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter by template type","type":"text/plain"},"key":"templateType","value":"CreditNote"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bad4b073-12b1-4e10-9bef-7c2370e2272e","name":"Create email template","request":{"name":"Create email template","description":{"content":"Creates a new email template.","type":"text/plain"},"url":{"path":["email-templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"templateType\": \"Invoice\",\n  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"content\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"465f3952-385c-458a-badd-1f08139e22d5","name":"Created email template","originalRequest":{"url":{"path":["email-templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"templateType\": \"Invoice\",\n  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"content\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"templateType\": \"Invoice\",\n  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"content\": \"<string>\",\n  \"createdAt\": \"<dateTime>\",\n  \"modifiedAt\": \"<dateTime>\",\n  \"status\": \"Active\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1fd99edf-28e9-4786-b891-557769c927ab","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["email-templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"templateType\": \"Invoice\",\n  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"content\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fabe0fd8-aca4-41b8-b3d0-19b7cc68ee8e","name":"Retrieve email template","request":{"name":"Retrieve email template","description":{"content":"Retrieves the details of an existing email template.","type":"text/plain"},"url":{"path":["email-templates",":templateId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"templateId","disabled":false,"description":{"content":"(Required) The ID of the email template","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"41ee400c-c115-4ca6-92a0-83623119a401","name":"Email template details","originalRequest":{"url":{"path":["email-templates",":templateId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"templateType\": \"Invoice\",\n  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"content\": \"<string>\",\n  \"createdAt\": \"<dateTime>\",\n  \"modifiedAt\": \"<dateTime>\",\n  \"status\": \"Active\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b87f0a69-61d3-4935-8209-66c0da66daad","name":"Email template not found","originalRequest":{"url":{"path":["email-templates",":templateId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[],"cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"568e8991-b5e2-4c2a-afcc-d9bea68607f8","name":"Update email template","request":{"name":"Update email template","description":{"content":"Updates an existing email template.","type":"text/plain"},"url":{"path":["email-templates",":templateId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"templateId","disabled":false,"description":{"content":"(Required) The ID of the email template","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"content\": \"<string>\",\n  \"status\": \"Active\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"f476d8ce-d6c4-43fa-8c51-28e558baa5e7","name":"Updated email template","originalRequest":{"url":{"path":["email-templates",":templateId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PUT","body":{"mode":"raw","raw":"{\n  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"content\": \"<string>\",\n  \"status\": \"Active\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"id\": \"<string>\",\n  \"accountId\": \"<string>\",\n  \"templateType\": \"Invoice\",\n  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"content\": \"<string>\",\n  \"createdAt\": \"<dateTime>\",\n  \"modifiedAt\": \"<dateTime>\",\n  \"status\": \"Active\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8e4d44a8-18ef-4c8a-b137-ad700b79fd94","name":"The request was unacceptable, often due to missing a required parameter.","originalRequest":{"url":{"path":["email-templates",":templateId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PUT","body":{"mode":"raw","raw":"{\n  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"content\": \"<string>\",\n  \"status\": \"Active\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1fa5ff65-2012-449f-94a5-b112adbafb63","name":"Email template not found","originalRequest":{"url":{"path":["email-templates",":templateId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PUT","body":{"mode":"raw","raw":"{\n  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"content\": \"<string>\",\n  \"status\": \"Active\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Not Found","code":404,"header":[],"cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9ce875ff-8243-4d72-a7bc-1d8ffc3deb67","name":"Delete email template","request":{"name":"Delete email template","description":{"content":"Deletes an email template. This deactivates the template rather than permanently removing it.","type":"text/plain"},"url":{"path":["email-templates",":templateId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"templateId","disabled":false,"description":{"content":"(Required) The ID of the email template","type":"text/plain"}}]},"method":"DELETE","body":{},"auth":null},"response":[{"id":"9888d0a5-1b72-4d8d-ad8d-b7ea86086a9e","name":"Email template deleted","originalRequest":{"url":{"path":["email-templates",":templateId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[],"cookie":[],"_postman_previewlanguage":"text"},{"id":"b9f3d6f3-9436-4e8d-8ad0-2f398ddb330e","name":"Email template not found","originalRequest":{"url":{"path":["email-templates",":templateId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[],"cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}],"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"{{apiKey}}","key":"value"},{"type":"any","value":"header","key":"in"}]},"event":[],"variable":[{"key":"baseUrl","value":"https://api.properpayments.io"}],"info":{"_postman_id":"dc85fa22-5552-49ce-bb5f-5db64bc6a08b","name":"Proper Payments API","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","description":{"content":"Welcome to the Proper Payments API reference. Here you will find all the information you need to interact with our API, manage payments, customers, and more.\n\nThe Proper Payments API is organised around REST. Our API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, [authentication](https://docs.properpayments.io/get-started/api-setup/api-access), and verbs.\n\nCheck out our [quickstart guides](https://docs.properpayments.io).\n","type":"text/plain"}}}