Rebillia - API Public
\nAn API Key is required to be sent as part of every request to the Rebillia API Public, in the form of an X-AUTH-TOKEN request header.
An API Key tells our API server that the request it received came from you. Everything that you have access to in Rebillia is accessible with an API Key that is generated by you.
\nIf an API Key is missing, malformed, or invalid, you will receive a 401 Unauthorized response code and the following JSON response:
{\n \"error\": { \n \"message\": \"Authentication Required.\"\n }\n}\nContact Support:\n Email: hello@rebillia.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"}],"owner":"10015811","collectionId":"4f7a3bda-9b68-4b24-962a-e098e6d14e0b","publishedId":"UV5WCdCU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2026-02-27T11:23:51.000Z"},"item":[{"name":"Bill Runs","item":[{"name":"Get All Bill Runs","id":"f0b0061f-41f9-4a71-9f2f-65a65099c404","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get All Bill Runs collection.
\n","urlObject":{"path":["bill-run"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include invoice relation.
\n","type":"text/plain"},"key":"include","value":"invoice"},{"disabled":true,"description":{"content":"Filter by status.
\n","type":"text/plain"},"key":"query","value":"completed"},{"disabled":true,"description":{"content":"Order by
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"Sort by
\n","type":"text/plain"},"key":"sortBy","value":"asc"}],"variable":[]}},"response":[{"id":"3f5ed1b2-8718-4d9d-b401-d23fc9d1de36","name":"Bill Run collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/bill-run?include=invoice&query=completed&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["bill-run"],"query":[{"key":"include","value":"invoice"},{"key":"query","value":"completed"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"amount\": 1,\n \"completedOn\": \"2021-04-01 14:46:03\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"executedOn\": \"2021-04-01 13:00:39\",\n \"id\": 49,\n \"invoiceCount\": 1,\n \"limit\": null,\n \"repeatType\": \"daily\",\n \"status\": \"completed\",\n \"subscriptionCount\": 1,\n \"targetDate\": \"2021-04-01\",\n \"type\": null,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n]"},{"id":"1c0ab226-5d14-4b8b-b7f8-e259b8f2ac57","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/bill-run?include=invoice&query=completed&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["bill-run"],"query":[{"key":"include","value":"invoice"},{"key":"query","value":"completed"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"f0b0061f-41f9-4a71-9f2f-65a65099c404"},{"name":"Get a Bill Run","id":"523811e2-eef7-4e5d-9834-6febc8a0777f","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get bill run by ID.
\n","urlObject":{"path":["bill-run",":bill_run_id"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include invoice relation.
\n","type":"text/plain"},"key":"include","value":"invoice"}],"variable":[{"description":{"content":"(Required) Bill Run Id
\n","type":"text/plain"},"type":"any","value":"49","key":"bill_run_id"}]}},"response":[{"id":"f9dc8767-5229-43bd-964f-790e0c8a4130","name":"Bill Run resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/bill-run/:bill_run_id?include=invoice","host":["{{host}}/{{version}}"],"path":["bill-run",":bill_run_id"],"query":[{"key":"include","value":"invoice"}],"variable":[{"key":"bill_run_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"amount\": 1,\n \"completedOn\": \"2021-04-01 14:46:03\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"executedOn\": \"2021-04-01 13:00:39\",\n \"id\": 49,\n \"invoiceCount\": 1,\n \"limit\": null,\n \"repeatType\": \"daily\",\n \"status\": \"completed\",\n \"subscriptionCount\": 1,\n \"targetDate\": \"2021-04-01\",\n \"type\": null,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"59febe33-e2cb-4715-a89a-141ae3db6f88","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/bill-run/:bill_run_id?include=invoice","host":["{{host}}/{{version}}"],"path":["bill-run",":bill_run_id"],"query":[{"key":"include","value":"invoice"}],"variable":[{"key":"bill_run_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"aa3f9fd2-fb39-4c52-9178-eec639189fb8","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/bill-run/:bill_run_id?include=invoice","host":["{{host}}/{{version}}"],"path":["bill-run",":bill_run_id"],"query":[{"key":"include","value":"invoice"}],"variable":[{"key":"bill_run_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"523811e2-eef7-4e5d-9834-6febc8a0777f"},{"name":"Update a Bill Run","id":"1af0a912-57ef-49c7-9791-9d6b7b285924","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update bill run by ID.
\n","urlObject":{"path":["bill-run",":bill_run_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Bill Run Id
\n","type":"text/plain"},"type":"any","value":"18599","key":"bill_run_id"}]}},"response":[{"id":"13fa3e2d-1421-4b9e-861e-b32f0841e6ee","name":"A Bill Run updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"targetDate\": \"2021-04-01\",\n \"timeOfDate\": \"07:00:00\"\n}"},"url":{"raw":"{{host}}/{{version}}/bill-run/:bill_run_id","host":["{{host}}/{{version}}"],"path":["bill-run",":bill_run_id"],"variable":[{"key":"bill_run_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"completedOn\": \"2021-04-01 14:46:03\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"executedOn\": \"2021-04-01 13:00:39\",\n \"id\": 49,\n \"invoiceCount\": 1,\n \"limit\": null,\n \"pid\": null,\n \"repeatType\": \"daily\",\n \"status\": \"completed\",\n \"subscriptionCount\": 0,\n \"targetDate\": \"2021-04-01\",\n \"timeOfDate\": \"07:00:00\",\n \"type\": null,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"171fdb9d-936c-4f2f-a123-72b0a69047e8","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"targetDate\": \"2021-04-01\",\n \"timeOfDate\": \"07:00:00\"\n}"},"url":{"raw":"{{host}}/{{version}}/bill-run/:bill_run_id","host":["{{host}}/{{version}}"],"path":["bill-run",":bill_run_id"],"variable":[{"key":"bill_run_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"696c28c5-ca32-4dc4-8425-46f97de1e48a","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"targetDate\": \"2021-04-01\",\n \"timeOfDate\": \"07:00:00\"\n}"},"url":{"raw":"{{host}}/{{version}}/bill-run/:bill_run_id","host":["{{host}}/{{version}}"],"path":["bill-run",":bill_run_id"],"variable":[{"key":"bill_run_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"b484dff4-0a45-4963-b641-1bd765582bc7","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"targetDate\": \"2021-04-01\",\n \"timeOfDate\": \"07:00:00\"\n}"},"url":{"raw":"{{host}}/{{version}}/bill-run/:bill_run_id","host":["{{host}}/{{version}}"],"path":["bill-run",":bill_run_id"],"variable":[{"key":"bill_run_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"1af0a912-57ef-49c7-9791-9d6b7b285924"},{"name":"Get Bill Run Invoices","id":"c39d7cd7-0e25-4b65-93be-d9340a2fd4a4","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get bill run invoices.
\n","urlObject":{"path":["bill-run",":bill_run_id","invoices"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Bill Run Id
\n","type":"text/plain"},"type":"any","value":"49","key":"bill_run_id"}]}},"response":[{"id":"aa5458ac-4e16-4645-a0d5-77fc5ea0b782","name":"Bill Run invoices response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/bill-run/:bill_run_id/invoices","host":["{{host}}/{{version}}"],"path":["bill-run",":bill_run_id","invoices"],"variable":[{"key":"bill_run_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"invoiceId\": 610,\n \"status\": \"completed\",\n \"subscriptionId\": 23\n }\n]"},{"id":"42a8d11d-d5e3-443e-9a67-08be10d484e5","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/bill-run/:bill_run_id/invoices","host":["{{host}}/{{version}}"],"path":["bill-run",":bill_run_id","invoices"],"variable":[{"key":"bill_run_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"201942a0-9a95-42ee-87d4-0a47734ee742","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/bill-run/:bill_run_id/invoices","host":["{{host}}/{{version}}"],"path":["bill-run",":bill_run_id","invoices"],"variable":[{"key":"bill_run_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"c39d7cd7-0e25-4b65-93be-d9340a2fd4a4"}],"id":"80ceaedc-73c5-4e93-b4bb-b73310de9058","description":"Returns a list of Charges Credits. Optional filter parameters can be passed in.
\n","urlObject":{"path":["customers",":customer_id","charges_credits"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Status of the entity
\n","type":"text/plain"},"key":"status","value":"unassigned"},{"disabled":true,"description":{"content":"Type of the entity
\n","type":"text/plain"},"key":"type","value":"credit"}],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"}]}},"response":[{"id":"85ce2bc8-33f7-4f35-90cf-bc3f7f274b54","name":"Charges Credits collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/charges_credits?status=unassigned&type=credit","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","charges_credits"],"query":[{"key":"status","value":"unassigned"},{"key":"type","value":"credit"}],"variable":[{"key":"customer_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"amount\": 100,\n \"category\": \"physical\",\n \"companyCurrency\": {\n \"companyGateway\": [\n {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n }\n ],\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"conversionRate\": 80.8857,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currencyAmount\": \"1.2363\",\n \"currencyTotal\": \"1.2363\",\n \"depth\": null,\n \"description\": \"Payment subscription\",\n \"dimensionalRule\": null,\n \"height\": null,\n \"id\": 52,\n \"isFreeShipping\": true,\n \"originLocation\": null,\n \"qty\": 1,\n \"shippingGroup\": null,\n \"taxable\": false,\n \"taxClass\": null,\n \"total\": 100,\n \"type\": \"credit\",\n \"weight\": 0.21,\n \"width\": null\n }\n]"},{"id":"de167cea-1a7e-4f36-a766-6271ce2a8b25","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/charges_credits?status=unassigned&type=credit","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","charges_credits"],"query":[{"key":"status","value":"unassigned"},{"key":"type","value":"credit"}],"variable":[{"key":"customer_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"cbfb2dae-9a1a-4a85-a92a-3ba4cc1dffa2","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/charges_credits?status=unassigned&type=credit","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","charges_credits"],"query":[{"key":"status","value":"unassigned"},{"key":"type","value":"credit"}],"variable":[{"key":"customer_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"ed76d99d-dde7-4d27-9607-83bffd8c2ec5"},{"name":"Create a Charge/Credit","id":"2e689cc1-00f0-4e73-b587-5dce1b3b494f","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create a new charge credit record.
\n","urlObject":{"path":["customers",":customer_id","charges_credits"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"}]}},"response":[{"id":"39793718-0750-46a6-8b6b-3a61c1f4383f","name":"A charge credit was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 10000,\n \"description\": \"Payment subscription\",\n \"category\": \"physical\",\n \"companyCurrencyId\": 1,\n \"qty\": 1,\n \"isFreeShipping\": true,\n \"taxable\": false,\n \"type\": \"credit\",\n \"weight\": 21\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/charges_credits","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","charges_credits"],"variable":[{"key":"customer_id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"amount\": 100,\n \"category\": \"physical\",\n \"companyCurrency\": {\n \"companyGateway\": [\n {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n }\n ],\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"conversionRate\": 80.8857,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currencyAmount\": \"1.2363\",\n \"currencyTotal\": \"1.2363\",\n \"depth\": null,\n \"description\": \"Payment subscription\",\n \"dimensionalRule\": null,\n \"height\": null,\n \"id\": 52,\n \"isFreeShipping\": true,\n \"originLocation\": null,\n \"qty\": 1,\n \"shippingGroup\": null,\n \"taxable\": false,\n \"taxClass\": null,\n \"total\": 100,\n \"type\": \"credit\",\n \"weight\": 0.21,\n \"width\": null\n}"},{"id":"2d8656af-71aa-4cc4-9b00-14d4f2dd2000","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 10000,\n \"description\": \"Payment subscription\",\n \"category\": \"physical\",\n \"companyCurrencyId\": 1,\n \"qty\": 1,\n \"isFreeShipping\": true,\n \"taxable\": false,\n \"type\": \"credit\",\n \"weight\": 21\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/charges_credits","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","charges_credits"],"variable":[{"key":"customer_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"23c72a1d-a627-432e-a540-11169e469c12","name":"Resource not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 10000,\n \"description\": \"Payment subscription\",\n \"category\": \"physical\",\n \"companyCurrencyId\": 1,\n \"qty\": 1,\n \"isFreeShipping\": true,\n \"taxable\": false,\n \"type\": \"credit\",\n \"weight\": 21\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/charges_credits","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","charges_credits"],"variable":[{"key":"customer_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"a4b02131-e9c5-4bef-ba96-e88652f91771","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 10000,\n \"description\": \"Payment subscription\",\n \"category\": \"physical\",\n \"companyCurrencyId\": 1,\n \"qty\": 1,\n \"isFreeShipping\": true,\n \"taxable\": false,\n \"type\": \"credit\",\n \"weight\": 21\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/charges_credits","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","charges_credits"],"variable":[{"key":"customer_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"2e689cc1-00f0-4e73-b587-5dce1b3b494f"},{"name":"Delete a Charge/Credit","id":"59262811-dd5b-4845-9db0-7e0d2e19a52b","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete a charge credit record. This will delete all sub-data associated with the account, such as subscriptions, payment methods, credit balance etc.
\n","urlObject":{"path":["customers",":customer_id","charges_credits",":charge_credit_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"},{"description":{"content":"(Required) Charge Credit Id
\n","type":"text/plain"},"type":"any","value":"52","key":"charge_credit_id"}]}},"response":[{"id":"c930aab0-cae4-4497-ae9e-d99d0d4a4e34","name":"Charge Credit deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/charges_credits/:charge_credit_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","charges_credits",":charge_credit_id"],"variable":[{"key":"customer_id"},{"key":"charge_credit_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"0c49b99f-2dba-4968-b268-cb1642ec48dd","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/charges_credits/:charge_credit_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","charges_credits",":charge_credit_id"],"variable":[{"key":"customer_id"},{"key":"charge_credit_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"d8aca762-91ef-4644-8e46-6ce14417c975","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/charges_credits/:charge_credit_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","charges_credits",":charge_credit_id"],"variable":[{"key":"customer_id"},{"key":"charge_credit_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"59262811-dd5b-4845-9db0-7e0d2e19a52b"}],"id":"ee084901-8d5c-4db9-ac8c-9589af21fa8f","description":"Returns a list of Company Currencies.
\n","urlObject":{"path":["currencies"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"19e39f27-1858-4656-b9ba-44a90caa0eca","name":"Company Currency collection response","originalRequest":{"method":"GET","header":[],"url":"{{host}}/{{version}}/currencies"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"companyGateway\": [\n {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n }\n ],\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n]"},{"id":"1695d7e1-ef5c-4142-8002-c55554aa3bb6","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"{{host}}/{{version}}/currencies"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"5acc8832-9689-4af9-ac2a-231554464191"},{"name":"Get a Company Currency","id":"3d0f5332-1a08-42c1-bdd9-3f1e44c04141","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get company currency by ID.
\n","urlObject":{"path":["currencies",":company_currency_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Company Currency Id
\n","type":"text/plain"},"type":"any","value":"44","key":"company_currency_id"}]}},"response":[{"id":"caf7ffbe-5b0f-4aa6-bd2b-021e860b2607","name":"Company Currency resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/currencies/:company_currency_id","host":["{{host}}/{{version}}"],"path":["currencies",":company_currency_id"],"variable":[{"key":"company_currency_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"companyGateway\": [\n {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n }\n ],\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"5cb78c89-3167-4703-a00b-2f374b11a02c","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/currencies/:company_currency_id","host":["{{host}}/{{version}}"],"path":["currencies",":company_currency_id"],"variable":[{"key":"company_currency_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"4d3c2a09-cd64-466b-8b0a-8e8b717ce9a9","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/currencies/:company_currency_id","host":["{{host}}/{{version}}"],"path":["currencies",":company_currency_id"],"variable":[{"key":"company_currency_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"3d0f5332-1a08-42c1-bdd9-3f1e44c04141"},{"name":"Create a Company Currency","id":"766125e9-d463-4204-8994-7d6a9c0c67d2","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create a new company currency record.
\n","urlObject":{"path":["currencies"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"35dc57fa-12b3-4031-a761-990a82af544f","name":"A company currency was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"currencyId\": 124,\n \"conversionRate\": 1,\n \"fixedRate\": true\n}"},"url":"{{host}}/{{version}}/currencies"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"companyGateway\": [\n {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n }\n ],\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"e22553e9-181d-41d5-9ba8-f1fe9787422d","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"currencyId\": 124,\n \"conversionRate\": 1,\n \"fixedRate\": true\n}"},"url":"{{host}}/{{version}}/currencies"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"a188ee9e-91dd-451f-ba95-b1598b108a26","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"currencyId\": 124,\n \"conversionRate\": 1,\n \"fixedRate\": true\n}"},"url":"{{host}}/{{version}}/currencies"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"766125e9-d463-4204-8994-7d6a9c0c67d2"},{"name":"Update a Company Currency","id":"71a5d8c8-29b4-434f-8426-b4bf260e52ff","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update company currency by ID.
\n","urlObject":{"path":["currencies",":company_currency_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Company Currency Id
\n","type":"text/plain"},"type":"any","value":"44","key":"company_currency_id"}]}},"response":[{"id":"95507110-7e35-4ee1-a1d3-ebde0b925c35","name":"A Company Currency updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"conversionRate\": 1,\n \"fixedRate\": true\n}"},"url":{"raw":"{{host}}/{{version}}/currencies/:company_currency_id","host":["{{host}}/{{version}}"],"path":["currencies",":company_currency_id"],"variable":[{"key":"company_currency_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"companyGateway\": [\n {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n }\n ],\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"151400ac-6a65-452b-a6ab-8d4e982e93e0","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"conversionRate\": 1,\n \"fixedRate\": true\n}"},"url":{"raw":"{{host}}/{{version}}/currencies/:company_currency_id","host":["{{host}}/{{version}}"],"path":["currencies",":company_currency_id"],"variable":[{"key":"company_currency_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"0c1d54b3-3a68-4024-8b58-6b69d43511e1","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"conversionRate\": 1,\n \"fixedRate\": true\n}"},"url":{"raw":"{{host}}/{{version}}/currencies/:company_currency_id","host":["{{host}}/{{version}}"],"path":["currencies",":company_currency_id"],"variable":[{"key":"company_currency_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"eb21c97a-5cb8-4a56-97da-285fd05d3e1c","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"conversionRate\": 1,\n \"fixedRate\": true\n}"},"url":{"raw":"{{host}}/{{version}}/currencies/:company_currency_id","host":["{{host}}/{{version}}"],"path":["currencies",":company_currency_id"],"variable":[{"key":"company_currency_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"71a5d8c8-29b4-434f-8426-b4bf260e52ff"},{"name":"Delete a Company Currency","id":"0e3c244d-e0ad-41b2-9b09-ea2d4ad3bc84","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete a company currency record.
\n","urlObject":{"path":["currencies",":company_currency_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Company Currency Id
\n","type":"text/plain"},"type":"any","value":"44","key":"company_currency_id"}]}},"response":[{"id":"5e8e14c8-c11d-48ca-8dbc-2f1dcc702204","name":"Company Currency deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/currencies/:company_currency_id","host":["{{host}}/{{version}}"],"path":["currencies",":company_currency_id"],"variable":[{"key":"company_currency_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"c589ed73-9755-4b6b-a8d8-0ab90fc93ab4","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/currencies/:company_currency_id","host":["{{host}}/{{version}}"],"path":["currencies",":company_currency_id"],"variable":[{"key":"company_currency_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"a0f60d40-26b7-43b2-8382-78534069f9c2","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/currencies/:company_currency_id","host":["{{host}}/{{version}}"],"path":["currencies",":company_currency_id"],"variable":[{"key":"company_currency_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"0e3c244d-e0ad-41b2-9b09-ea2d4ad3bc84"},{"name":"Get default Company Currency","id":"fb7ebf43-d839-41f0-b66a-ca5f26e1b5f1","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Returns the default Company Currency.
\n","urlObject":{"path":["currencies","default"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"7b21044a-72f6-4644-84ce-ae63f0270822","name":"Company Currency resource response","originalRequest":{"method":"GET","header":[],"url":"{{host}}/{{version}}/currencies/default"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"companyGateway\": [\n {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n }\n ],\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"0c84bcbb-718f-427a-bd90-8831acbd094d","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"{{host}}/{{version}}/currencies/default"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"fb7ebf43-d839-41f0-b66a-ca5f26e1b5f1"},{"name":"Set a Company Currency as default","id":"5ab5fa61-0449-4e1d-840d-038862d8cb2e","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Set a company currency as default.
\n","urlObject":{"path":["currencies","default"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"ad80eb5f-d49f-41c9-b568-e3dbf2f0647c","name":"A currency was set as default","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"currencyId\": 124\n}"},"url":"{{host}}/{{version}}/currencies/default"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"companyGateway\": [\n {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n }\n ],\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"5ebffa9a-5df8-44ab-b860-8c34ceb1c37a","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"currencyId\": 124\n}"},"url":"{{host}}/{{version}}/currencies/default"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"593e1b90-314a-4a0e-bbb3-8ceb279d0d84","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"currencyId\": 124\n}"},"url":"{{host}}/{{version}}/currencies/default"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"5ab5fa61-0449-4e1d-840d-038862d8cb2e"}],"id":"6db9b6e7-72ef-4483-b72b-88b15ef2f37f","description":"Returns a list of Company Gateways. Optional filter parameters can be passed in.
\n","urlObject":{"path":["gateways"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Company Gateway Status
\n","type":"text/plain"},"key":"status","value":"active"}],"variable":[]}},"response":[{"id":"868c8043-eefb-4ed4-8cac-b27fc6bdfd18","name":"Company Gateway collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/gateways?status=active","host":["{{host}}/{{version}}"],"path":["gateways"],"query":[{"key":"status","value":"active"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n }\n]"},{"id":"b5d87e11-3f48-4bb8-9f4b-6b2ba82ac02a","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/gateways?status=active","host":["{{host}}/{{version}}"],"path":["gateways"],"query":[{"key":"status","value":"active"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"e3c3cfa3-114e-4212-ac0e-338fa3dba0dd"},{"name":"Get a Company Gateway","id":"ac3a9cd3-d79e-4716-8159-7c253d34d915","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get company gateway by ID.
\n","urlObject":{"path":["gateways",":company_gateway_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Company Gateway Id
\n","type":"text/plain"},"type":"any","value":"3412","key":"company_gateway_id"}]}},"response":[{"id":"6fbd06cf-66a4-4413-860b-e79ebb48d07e","name":"Company Gateway resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/gateways/:company_gateway_id","host":["{{host}}/{{version}}"],"path":["gateways",":company_gateway_id"],"variable":[{"key":"company_gateway_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n}"},{"id":"d7632e92-9d7b-40d6-a6de-3ec34977f791","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/gateways/:company_gateway_id","host":["{{host}}/{{version}}"],"path":["gateways",":company_gateway_id"],"variable":[{"key":"company_gateway_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"facbc79d-177d-4c3c-a8d7-685bf16d6aad","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/gateways/:company_gateway_id","host":["{{host}}/{{version}}"],"path":["gateways",":company_gateway_id"],"variable":[{"key":"company_gateway_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"ac3a9cd3-d79e-4716-8159-7c253d34d915"},{"name":"Create a Company Gateway","id":"326bf954-a9a6-4062-9e1f-599585056475","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create a new company gateway record.
\n","urlObject":{"path":["gateways"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"11b163f4-a5e3-4795-9283-9dff78cc83f3","name":"A company gateway was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"gblGatewayId\": 2,\n \"displayName\": \"Pay in store\",\n \"setting\": {\n \"publicKey\": \"merchantId\",\n \"transactionKey\": \"transactionKey\",\n \"privateKey\": \"privateKey\",\n \"merchantId\": \"sandbox\"\n },\n \"card\": [\n 2\n ]\n}"},"url":"{{host}}/{{version}}/gateways"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n}"},{"id":"6aee5426-040d-456d-90e8-d5444a3b938f","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"gblGatewayId\": 2,\n \"displayName\": \"Pay in store\",\n \"setting\": {\n \"publicKey\": \"merchantId\",\n \"transactionKey\": \"transactionKey\",\n \"privateKey\": \"privateKey\",\n \"merchantId\": \"sandbox\"\n },\n \"card\": [\n 2\n ]\n}"},"url":"{{host}}/{{version}}/gateways"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"62cb63df-c9c8-481b-9922-d55c223c46fc","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"gblGatewayId\": 2,\n \"displayName\": \"Pay in store\",\n \"setting\": {\n \"publicKey\": \"merchantId\",\n \"transactionKey\": \"transactionKey\",\n \"privateKey\": \"privateKey\",\n \"merchantId\": \"sandbox\"\n },\n \"card\": [\n 2\n ]\n}"},"url":"{{host}}/{{version}}/gateways"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"326bf954-a9a6-4062-9e1f-599585056475"},{"name":"Update a Company Gateway","id":"65ec988c-cd9b-431c-a765-e8062e56735b","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update company gateway by ID.
\n","urlObject":{"path":["gateways",":company_gateway_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Company Gateway Id
\n","type":"text/plain"},"type":"any","value":"3412","key":"company_gateway_id"}]}},"response":[{"id":"9799ea55-a79e-4096-b617-4369f2d7f421","name":"A Company Gateway updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"displayName\": \"Pay in store\",\n \"setting\": {\n \"publicKey\": \"merchantId\",\n \"transactionKey\": \"transactionKey\",\n \"privateKey\": \"privateKey\",\n \"merchantId\": \"sandbox\"\n },\n \"card\": [\n 2\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/gateways/:company_gateway_id","host":["{{host}}/{{version}}"],"path":["gateways",":company_gateway_id"],"variable":[{"key":"company_gateway_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n}"},{"id":"e89eda34-a298-4c84-aba7-74c250aa5ee3","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"displayName\": \"Pay in store\",\n \"setting\": {\n \"publicKey\": \"merchantId\",\n \"transactionKey\": \"transactionKey\",\n \"privateKey\": \"privateKey\",\n \"merchantId\": \"sandbox\"\n },\n \"card\": [\n 2\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/gateways/:company_gateway_id","host":["{{host}}/{{version}}"],"path":["gateways",":company_gateway_id"],"variable":[{"key":"company_gateway_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"f0deedb6-b06b-40c4-bd95-b27ef459ffdd","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"displayName\": \"Pay in store\",\n \"setting\": {\n \"publicKey\": \"merchantId\",\n \"transactionKey\": \"transactionKey\",\n \"privateKey\": \"privateKey\",\n \"merchantId\": \"sandbox\"\n },\n \"card\": [\n 2\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/gateways/:company_gateway_id","host":["{{host}}/{{version}}"],"path":["gateways",":company_gateway_id"],"variable":[{"key":"company_gateway_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"928755fc-0d48-4209-a3bf-ae2fc0bbfd1c","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"displayName\": \"Pay in store\",\n \"setting\": {\n \"publicKey\": \"merchantId\",\n \"transactionKey\": \"transactionKey\",\n \"privateKey\": \"privateKey\",\n \"merchantId\": \"sandbox\"\n },\n \"card\": [\n 2\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/gateways/:company_gateway_id","host":["{{host}}/{{version}}"],"path":["gateways",":company_gateway_id"],"variable":[{"key":"company_gateway_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"65ec988c-cd9b-431c-a765-e8062e56735b"},{"name":"Delete a Company Gateway","id":"95b1024c-a022-4e8a-b22b-a0af185cc674","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete a company gateway record.
\n","urlObject":{"path":["gateways",":company_gateway_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Company Gateway Id
\n","type":"text/plain"},"type":"any","value":"3412","key":"company_gateway_id"}]}},"response":[{"id":"7f32c204-1ea0-42b6-bd8e-aaeffc73c978","name":"Company Gateway deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/gateways/:company_gateway_id","host":["{{host}}/{{version}}"],"path":["gateways",":company_gateway_id"],"variable":[{"key":"company_gateway_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"f77b21c3-74fd-4392-8f41-ec1f66b6c724","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/gateways/:company_gateway_id","host":["{{host}}/{{version}}"],"path":["gateways",":company_gateway_id"],"variable":[{"key":"company_gateway_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"36654851-5c8c-4695-bb16-cb3d0e2805b8","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/gateways/:company_gateway_id","host":["{{host}}/{{version}}"],"path":["gateways",":company_gateway_id"],"variable":[{"key":"company_gateway_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"95b1024c-a022-4e8a-b22b-a0af185cc674"},{"name":"Test a Company Gateway","id":"1ae79ca0-f760-4378-a0e3-0081352271ee","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Test a company gateway.
\n","urlObject":{"path":["gateways",":company_gateway_id","test"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Company Gateway Id
\n","type":"text/plain"},"type":"any","value":"3412","key":"company_gateway_id"}]}},"response":[{"id":"1fdf37c6-2587-4963-a839-7ed372d443b3","name":"Company Gateway resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/gateways/:company_gateway_id/test","host":["{{host}}/{{version}}"],"path":["gateways",":company_gateway_id","test"],"variable":[{"key":"company_gateway_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n}"},{"id":"b892fba2-6f50-47d3-b842-5f12d6738780","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/gateways/:company_gateway_id/test","host":["{{host}}/{{version}}"],"path":["gateways",":company_gateway_id","test"],"variable":[{"key":"company_gateway_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"1e877b7f-a898-4a23-bde7-7d71c8fbfdfa","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/gateways/:company_gateway_id/test","host":["{{host}}/{{version}}"],"path":["gateways",":company_gateway_id","test"],"variable":[{"key":"company_gateway_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"1ae79ca0-f760-4378-a0e3-0081352271ee"}],"id":"5aa90953-955f-44ac-a7ba-9c7aacf39ce0","description":"Returns a list of External Products by Company Integration.
\n","urlObject":{"path":["integrations",":company_integration_id","products"],"host":["{{host}}/{{version}}"],"query":[{"description":{"content":"(Required) Product Name
\n","type":"text/plain"},"key":"name","value":"bag"}],"variable":[{"description":{"content":"(Required) Company Integration Id
\n","type":"text/plain"},"type":"any","value":"8","key":"company_integration_id"}]}},"response":[{"id":"c70af72a-391f-44eb-a8e6-fc60a37cb1d3","name":"External Products collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations/:company_integration_id/products","host":["{{host}}/{{version}}"],"path":["integrations",":company_integration_id","products"],"variable":[{"key":"company_integration_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1460,\n \"image\": \"\",\n \"name\": \"Sample Product\",\n \"price\": \"35\",\n \"sku\": \"\",\n \"url\": 74948929,\n \"options\": [\n {\n \"displayName\": \"Subscribe & Save\",\n \"values\": [\n \"Send every month\"\n ]\n }\n ],\n \"variants\": [\n {\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": []\n }\n ]\n }\n]"},{"id":"34054476-8f22-4f26-8c40-5038d5d9082f","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations/:company_integration_id/products","host":["{{host}}/{{version}}"],"path":["integrations",":company_integration_id","products"],"variable":[{"key":"company_integration_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"5eecc103-086e-4f0e-a08a-71bfe3571b22"},{"name":"Get an External Products","id":"0d8dc6e8-8d8f-4b9b-9a1c-b2125d20c8bc","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get an External Products by Company Integration.
\n","urlObject":{"path":["integrations",":company_integration_id","products",":external_product_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Company Integration Id
\n","type":"text/plain"},"type":"any","value":"8","key":"company_integration_id"},{"description":{"content":"(Required) External Product Id
\n","type":"text/plain"},"type":"any","value":"1460","key":"external_product_id"}]}},"response":[{"id":"15f65df5-7367-4b54-941a-538e774e6551","name":"External Product resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations/:company_integration_id/products/:external_product_id","host":["{{host}}/{{version}}"],"path":["integrations",":company_integration_id","products",":external_product_id"],"variable":[{"key":"company_integration_id"},{"key":"external_product_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1460,\n \"image\": \"\",\n \"name\": \"Sample Product\",\n \"price\": \"35\",\n \"sku\": \"\",\n \"url\": -93195874,\n \"options\": [\n {\n \"displayName\": \"Subscribe & Save\",\n \"values\": [\n \"Send every month\"\n ]\n }\n ],\n \"variants\": [\n {\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": []\n }\n ]\n}"},{"id":"5020cbc5-8861-41e5-94c7-618314676267","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations/:company_integration_id/products/:external_product_id","host":["{{host}}/{{version}}"],"path":["integrations",":company_integration_id","products",":external_product_id"],"variable":[{"key":"company_integration_id"},{"key":"external_product_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"0d8dc6e8-8d8f-4b9b-9a1c-b2125d20c8bc"},{"name":"List All Order statuses","id":"6d046557-83d5-4da1-9d24-c066f2ec6e56","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"List Order statuses by Company Integration.
\n","urlObject":{"path":["integrations",":company_integration_id","orders","statuses"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Company Integration Id
\n","type":"text/plain"},"type":"any","value":"8","key":"company_integration_id"}]}},"response":[{"id":"25652bb8-6d95-490f-b442-dec5d6f11ceb","name":"Order statuses collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations/:company_integration_id/orders/statuses","host":["{{host}}/{{version}}"],"path":["integrations",":company_integration_id","orders","statuses"],"variable":[{"key":"company_integration_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Shipped\",\n \"system_label\": \"Shipped\",\n \"custom_label\": \"Shipped\",\n \"system_description\": \"Order has been shipped, but receipt has not been confirmed; seller has used the Ship Items action.\",\n \"order\": 8\n }\n]"},{"id":"94618db3-3136-4035-8d55-20cbcd41cf13","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations/:company_integration_id/orders/statuses","host":["{{host}}/{{version}}"],"path":["integrations",":company_integration_id","orders","statuses"],"variable":[{"key":"company_integration_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"6d046557-83d5-4da1-9d24-c066f2ec6e56"}],"id":"c488150c-792a-4325-9973-587b295e796b","_postman_id":"c488150c-792a-4325-9973-587b295e796b","description":""},{"name":"Shipping","item":[{"name":"Get All Company Shippings","id":"f806b04d-0c7f-4313-9139-abced25596d8","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Returns a list of Shippings.
\n","urlObject":{"path":["shipping","services"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"3be035ed-6de0-4227-9a2e-bb8fe9aad693","name":"Company Shippings collection response","originalRequest":{"method":"GET","header":[],"url":"{{host}}/{{version}}/shipping/services"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"companyIntegrationId\": 10,\n \"carrierName\": \"USD\",\n \"serviceId\": \"02\",\n \"serviceName\": \"Service Name\"\n }\n]"},{"id":"27bdba52-0254-4048-acae-9553b97e487a","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"{{host}}/{{version}}/shipping/services"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"f806b04d-0c7f-4313-9139-abced25596d8"},{"name":"Calculate a shipping","id":"5b119d80-237f-4de6-a10d-8443816c5825","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Calculate a shipping.
\n","urlObject":{"path":["shipping","calculate"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"753f2123-117b-43f9-917f-3d6716abfe00","name":"Calculated shipping","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"street1\": \"\",\n \"street2\": \"\",\n \"street3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"fromZip\": \"30071\",\n \"fromCountry\": \"US\",\n \"zip\": \"30071\",\n \"country\": \"US\",\n \"residential\": true,\n \"weight\": 150,\n \"services\": \"\",\n \"packagingType\": \"\",\n \"orderAmount\": 20,\n \"itemCount\": \"5\"\n}"},"url":"{{host}}/{{version}}/shipping/calculate"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"amount\": \"10.22\",\n \"companyIntegrationId\": 10,\n \"currency\": \"USD\",\n \"integrationName\": \"ups\",\n \"serviceId\": \"02\",\n \"serviceName\": \"Service Name\"\n }\n]"},{"id":"7f7bc960-924f-42aa-b473-fe7302bc17f5","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"street1\": \"\",\n \"street2\": \"\",\n \"street3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"fromZip\": \"30071\",\n \"fromCountry\": \"US\",\n \"zip\": \"30071\",\n \"country\": \"US\",\n \"residential\": true,\n \"weight\": 150,\n \"services\": \"\",\n \"packagingType\": \"\",\n \"orderAmount\": 20,\n \"itemCount\": \"5\"\n}"},"url":"{{host}}/{{version}}/shipping/calculate"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"2f8ae7e6-679b-4a97-9aaa-b20f2c49a2ae","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"street1\": \"\",\n \"street2\": \"\",\n \"street3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"fromZip\": \"30071\",\n \"fromCountry\": \"US\",\n \"zip\": \"30071\",\n \"country\": \"US\",\n \"residential\": true,\n \"weight\": 150,\n \"services\": \"\",\n \"packagingType\": \"\",\n \"orderAmount\": 20,\n \"itemCount\": \"5\"\n}"},"url":"{{host}}/{{version}}/shipping/calculate"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"5b119d80-237f-4de6-a10d-8443816c5825"}],"id":"3bf5c19f-02b1-4ac3-b251-1652814aa23e","_postman_id":"3bf5c19f-02b1-4ac3-b251-1652814aa23e","description":""},{"name":"Get All Company Integrations","id":"8aad1453-b3cf-4c6a-aed4-dab69e2ab9b7","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Returns a list of Company Integrations. Optional filter parameters can be passed in.
\n","urlObject":{"path":["integrations"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Type of integrations.
\n","type":"text/plain"},"key":"type","value":"shipping"}],"variable":[]}},"response":[{"id":"8e994947-3172-4e1e-84ed-b7e0496c8ef6","name":"Company Integration collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations?type=shipping","host":["{{host}}/{{version}}"],"path":["integrations"],"query":[{"key":"type","value":"shipping"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"UPS\",\n \"id\": 17,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n]"},{"id":"d03fc685-d37f-4822-b47b-328cdc2e541f","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations?type=shipping","host":["{{host}}/{{version}}"],"path":["integrations"],"query":[{"key":"type","value":"shipping"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"8aad1453-b3cf-4c6a-aed4-dab69e2ab9b7"},{"name":"Get a company integration by ID","id":"9403469c-a516-4616-946a-20ec2acda250","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get a company integration by ID.
\n","urlObject":{"path":["integrations",":company_integration_id","config"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Company Integration Id
\n","type":"text/plain"},"type":"any","value":"8","key":"company_integration_id"}]}},"response":[{"id":"4415be1e-391f-4604-beb6-f11748c08bdc","name":"Company Integration collection resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations/:company_integration_id/config","host":["{{host}}/{{version}}"],"path":["integrations",":company_integration_id","config"],"variable":[{"key":"company_integration_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"826f12a1-787d-4684-bb06-7bef31bc1e50","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations/:company_integration_id/config","host":["{{host}}/{{version}}"],"path":["integrations",":company_integration_id","config"],"variable":[{"key":"company_integration_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"9403469c-a516-4616-946a-20ec2acda250"},{"name":"Get an Integration by key name","id":"26aaa5da-5042-4225-90cf-ec74e3938592","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get an Integration by key name.
\n","urlObject":{"path":["integrations",":integration_key_name","get"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Integration key name
\n","type":"text/plain"},"type":"any","value":"bigcommerce","key":"integration_key_name"}]}},"response":[{"id":"0790370d-5e0c-45b3-b974-7131ded06aad","name":"Integration resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations/:integration_key_name/get","host":["{{host}}/{{version}}"],"path":["integrations",":integration_key_name","get"],"variable":[{"key":"integration_key_name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"name\": \"Bigcommerce\",\n \"type\": \"ecommerce\",\n \"status\": \"active\"\n}"},{"id":"48545d43-c37f-4905-af8b-59ac26edcdb5","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations/:integration_key_name/get","host":["{{host}}/{{version}}"],"path":["integrations",":integration_key_name","get"],"variable":[{"key":"integration_key_name"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"26aaa5da-5042-4225-90cf-ec74e3938592"},{"name":"Get All Company Integrations by key name.","id":"f23f7380-9cb3-4747-a43d-12ca6cf23616","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Returns a list of Company Integrations by key name.
\n","urlObject":{"path":["integrations",":integration_key_name","list"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Company Integration key name
\n","type":"text/plain"},"type":"any","value":"bigcommerce","key":"integration_key_name"}]}},"response":[{"id":"3770f715-aacb-40ad-9c8a-fa10302f9b96","name":"Company Integration collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations/:integration_key_name/list","host":["{{host}}/{{version}}"],"path":["integrations",":integration_key_name","list"],"variable":[{"key":"integration_key_name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n]"},{"id":"9134274a-d9b0-4f5f-9fd2-1a40ec051094","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations/:integration_key_name/list","host":["{{host}}/{{version}}"],"path":["integrations",":integration_key_name","list"],"variable":[{"key":"integration_key_name"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"f23f7380-9cb3-4747-a43d-12ca6cf23616"},{"name":"Get All External Invoices","id":"576bc138-a488-4431-8b78-082da28758f2","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Returns a list of External Invoices by Company Integration. Optional filter parameters can be passed in.
\n","urlObject":{"path":["integrations",":company_integration_id","external-invoices"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"invoice,subscription"},{"disabled":true,"description":{"content":"Filter by external id
\n","type":"text/plain"},"key":"externalId","value":"12091"},{"disabled":true,"description":{"content":"Order by
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"Sort by
\n","type":"text/plain"},"key":"sortBy","value":"asc"}],"variable":[{"description":{"content":"(Required) Company Integration Id
\n","type":"text/plain"},"type":"any","value":"4","key":"company_integration_id"}]}},"response":[{"id":"c0040b1b-c604-416d-aa0d-dc158cb18f38","name":"External Invoice collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations/:company_integration_id/external-invoices?include=invoice,subscription&externalId=12091&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["integrations",":company_integration_id","external-invoices"],"query":[{"key":"include","value":"invoice,subscription"},{"key":"externalId","value":"12091"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"company_integration_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"createdAt\": \"2021-04-01 00:00:00\",\n \"externalDetail\": {\n \"order\": {\n \"id\": 12091,\n \"status\": \"Complete\",\n \"cart_id\": \"5cvfdsb16-91fb-4336-85fb-d24326453gtb78ea\",\n \"coupons\": {\n \"url\": \"https://api.bigcommerce.com/stores/test/v2/orders/12091/coupons\",\n \"resource\": \"/orders/12091/coupons\"\n },\n \"products\": {\n \"url\": \"https://api.bigcommerce.com/stores/test/v2/orders/12091/products\",\n \"resource\": \"/orders/12091/products\"\n },\n \"status_id\": 0,\n \"total_tax\": \"7.7100\",\n \"channel_id\": 1,\n \"ip_address\": \"\",\n \"is_deleted\": false,\n \"currency_id\": 1,\n \"customer_id\": 7,\n \"external_id\": null,\n \"items_total\": 2,\n \"staff_notes\": \"\",\n \"date_created\": \"Thu, 01 Apr 2021 13:30:33 +0000\",\n \"date_shipped\": \"\",\n \"order_source\": \"checkout_api\",\n \"subtotal_tax\": \"6.9100\",\n \"total_ex_tax\": \"77.0700\",\n \"currency_code\": \"USD\",\n \"custom_status\": \"Incomplete\",\n \"date_modified\": \"Thu, 01 Apr 2021 13:30:33 +0000\",\n \"ebay_order_id\": \"0\",\n \"geoip_country\": \"\",\n \"items_shipped\": 0,\n \"total_inc_tax\": \"84.7800\",\n \"payment_method\": \"\",\n \"payment_status\": \"\",\n \"billing_address\": {\n \"zip\": \"22923\",\n \"city\": \"Barboursville\",\n \"email\": \"jonh.doe@example.com\",\n \"phone\": \"\",\n \"state\": \"Virginia\",\n \"company\": \"\",\n \"country\": \"United States\",\n \"street_1\": \"123 Main St\",\n \"street_2\": \"\",\n \"last_name\": \"Jonh\",\n \"first_name\": \"Doe\",\n \"form_fields\": [],\n \"country_iso2\": \"US\"\n },\n \"coupon_discount\": \"0.0000\",\n \"customer_locale\": \"en\",\n \"discount_amount\": \"0.0000\",\n \"external_source\": null,\n \"is_email_opt_in\": false,\n \"refunded_amount\": \"0.0000\",\n \"subtotal_ex_tax\": \"69.1200\",\n \"tax_provider_id\": \"FixedTaxProvider\",\n \"credit_card_type\": null,\n \"customer_message\": \"\",\n \"order_is_digital\": false,\n \"subtotal_inc_tax\": \"76.0300\",\n \"handling_cost_tax\": \"0.0000\",\n \"shipping_cost_tax\": \"0.8000\",\n \"wrapping_cost_tax\": \"0.0000\",\n \"base_handling_cost\": \"0.0000\",\n \"base_shipping_cost\": \"7.9500\",\n \"base_wrapping_cost\": \"0.0000\",\n \"geoip_country_iso2\": \"\",\n \"shipping_addresses\": {\n \"url\": \"https://api.bigcommerce.com/stores/test/v2/orders/12091/shipping_addresses\",\n \"resource\": \"/orders/12091/shipping_addresses\"\n },\n \"default_currency_id\": 1,\n \"payment_provider_id\": null,\n \"store_credit_amount\": \"0.0000\",\n \"external_merchant_id\": null,\n \"handling_cost_ex_tax\": \"0.0000\",\n \"shipping_cost_ex_tax\": \"7.9500\",\n \"wrapping_cost_ex_tax\": \"0.0000\",\n \"default_currency_code\": \"USD\",\n \"handling_cost_inc_tax\": \"0.0000\",\n \"shipping_cost_inc_tax\": \"8.7500\",\n \"wrapping_cost_inc_tax\": \"0.0000\",\n \"currency_exchange_rate\": \"1.0000000000\",\n \"shipping_address_count\": 1,\n \"gift_certificate_amount\": \"0.0000\",\n \"handling_cost_tax_class_id\": 2,\n \"shipping_cost_tax_class_id\": 2,\n \"wrapping_cost_tax_class_id\": 3,\n \"store_default_currency_code\": \"USD\",\n \"store_default_to_transactional_exchange_rate\": \"1.0000000000\"\n },\n \"orderProducts\": [\n {\n \"id\": 2003,\n \"sku\": \"\",\n \"upc\": \"\",\n \"name\": \"Prod 1\",\n \"type\": \"physical\",\n \"depth\": \"0.0000\",\n \"width\": \"0.0000\",\n \"height\": \"0.0000\",\n \"weight\": \"1.0000\",\n \"order_id\": 12091,\n \"quantity\": 1,\n \"price_tax\": \"1.2300\",\n \"return_id\": 0,\n \"total_tax\": \"1.2300\",\n \"base_price\": \"12.3400\",\n \"base_total\": \"12.3400\",\n \"event_date\": \"\",\n \"event_name\": null,\n \"product_id\": 1464,\n \"variant_id\": 1773,\n \"external_id\": null,\n \"is_refunded\": false,\n \"ebay_item_id\": \"\",\n \"price_ex_tax\": \"12.3400\",\n \"total_ex_tax\": \"12.3400\",\n \"name_customer\": \"Prod 1\",\n \"name_merchant\": \"Prod 1\",\n \"option_set_id\": 160,\n \"price_inc_tax\": \"13.5700\",\n \"refund_amount\": \"0.0000\",\n \"total_inc_tax\": \"13.5700\",\n \"wrapping_name\": \"\",\n \"cost_price_tax\": \"0.0000\",\n \"base_cost_price\": \"0.0000\",\n \"product_options\": [\n {\n \"id\": 2994,\n \"name\": \"Save-in-subscription1616158689-1464\",\n \"type\": \"Multiple choice\",\n \"value\": \"965\",\n \"option_id\": 372,\n \"display_name\": \"Save in subscription\",\n \"display_style\": \"Dropdown\",\n \"display_value\": \"Monthly\",\n \"order_product_id\": 2003,\n \"product_option_id\": 458,\n \"display_name_customer\": \"Save in subscription\",\n \"display_name_merchant\": \"Save in subscription\",\n \"display_value_customer\": \"Monthly\",\n \"display_value_merchant\": \"Monthly\"\n }\n ],\n \"order_address_id\": 11592,\n \"quantity_shipped\": 0,\n \"wrapping_message\": \"\",\n \"applied_discounts\": [],\n \"cost_price_ex_tax\": \"0.0000\",\n \"quantity_refunded\": 0,\n \"wrapping_cost_tax\": \"0.0000\",\n \"base_wrapping_cost\": \"0.0000\",\n \"bin_picking_number\": \"\",\n \"cost_price_inc_tax\": \"0.0000\",\n \"fulfillment_source\": \"\",\n \"is_bundled_product\": false,\n \"configurable_fields\": [],\n \"ebay_transaction_id\": \"\",\n \"fixed_shipping_cost\": \"0.0000\",\n \"wrapping_cost_ex_tax\": \"0.0000\",\n \"wrapping_cost_inc_tax\": \"0.0000\",\n \"parent_order_product_id\": null\n }\n ]\n },\n \"externalId\": \"12091\",\n \"id\": 1,\n \"invoiceId\": 1,\n \"status\": \"success\",\n \"updatedAt\": \"2021-04-01 00:00:00\",\n \"externalSubscriptionLogs\": [\n {\n \"createdAt\": \"2021-04-01 13:30:42\",\n \"externalInvoiceId\": 1,\n \"id\": 1,\n \"status\": \"success\",\n \"updatedAt\": \"2021-04-01 13:30:42\",\n \"subscription\": {\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"detail\": null,\n \"id\": 1,\n \"lastBillRun\": null,\n \"lastCharge\": null,\n \"name\": \"Subscription name\",\n \"nextCharge\": \"2021-07-06 00:00:00\",\n \"offlinePaymentId\": null,\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"recurringChargeAmount\": 1843.139,\n \"recurringChargeQty\": 1,\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": null,\n \"shippingCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"UPS\",\n \"id\": 17,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"shippingServiceId\": \"02\",\n \"source\": \"publicApi\",\n \"sourceCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n }\n ],\n \"invoice\": {\n \"autoCollection\": true,\n \"balanceDue\": \"13.6000\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"comments\": \"comments\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerEmail\": \"jonh.doe@example.com\",\n \"customerName\": \"Jonh Doe\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"customerPhone\": \"404 55 4444\",\n \"dateDue\": \"2021-04-01 00:00:00\",\n \"dateFrom\": \"2021-04-01 00:00:00\",\n \"datePaid\": \"2021-04-01 13:30:36\",\n \"datePaymentRetry\": null,\n \"dateRefund\": null,\n \"dateTo\": \"2021-04-01 13:30:36\",\n \"dateVoid\": null,\n \"detail\": [],\n \"id\": 1,\n \"invoiceNo\": \"1406\",\n \"offlinePaymentId\": \"\",\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"refundAmount\": \"0.0000\",\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": \"12.0000\",\n \"shippingCompanyIntegration\": null,\n \"shippingServiceId\": \"A01\",\n \"shippingServiceName\": \"\",\n \"status\": \"cancel\",\n \"subtotalTaxExc\": \"69.1200\",\n \"subtotalTaxInc\": \"76.8300\",\n \"taxAmount\": \"7.7100\",\n \"taxCompanyIntegration\": null,\n \"taxRate\": \"0.0000\",\n \"terms\": \"\",\n \"total\": \"84.7800\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n }\n]"},{"id":"60bc8c9a-0461-4d06-a7e9-a4ae40a21847","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/integrations/:company_integration_id/external-invoices?include=invoice,subscription&externalId=12091&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["integrations",":company_integration_id","external-invoices"],"query":[{"key":"include","value":"invoice,subscription"},{"key":"externalId","value":"12091"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"company_integration_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"576bc138-a488-4431-8b78-082da28758f2"}],"id":"33c4e47f-76eb-4ab2-bc92-fa92e4f3e1d9","description":"Returns a list of Customer Address Book. Optional filter parameters can be passed in.
\n","urlObject":{"path":["customers",":customer_id","addressbooks"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Amount of item per page
\n","type":"text/plain"},"key":"itemPerPage","value":"7"}],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"}]}},"response":[{"id":"afc03105-8c70-4098-a2e5-d58abf8c6c23","name":"Customer Address Book collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks?itemPerPage=7","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks"],"query":[{"key":"itemPerPage","value":"7"}],"variable":[{"key":"customer_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n }\n]"},{"id":"32786229-eb16-4ac2-a6ef-80517e958d37","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks?itemPerPage=7","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks"],"query":[{"key":"itemPerPage","value":"7"}],"variable":[{"key":"customer_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"926e528d-ace1-4b8a-bbc3-f84bfc2b29cb","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks?itemPerPage=7","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks"],"query":[{"key":"itemPerPage","value":"7"}],"variable":[{"key":"customer_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"95d4c3dc-bfbc-4e11-b2d8-bbf6bc7cdb72"},{"name":"Get a Customer Address","id":"d4f37023-f537-4492-aa25-df18108b1edb","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get Customer Address Book by ID. Optional filter parameters can be passed in.
\n","urlObject":{"path":["customers",":customer_id","addressbooks",":customer_address_book_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"},{"description":{"content":"(Required) Customer Address Book Id
\n","type":"text/plain"},"type":"any","value":"1","key":"customer_address_book_id"}]}},"response":[{"id":"c6e1d650-a4f8-40b3-ac97-b4319edc4303","name":"Customer Address Book resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks/:customer_address_book_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks",":customer_address_book_id"],"variable":[{"key":"customer_id"},{"key":"customer_address_book_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n}"},{"id":"bb6609ab-d9b3-4101-ab68-80d291c13e38","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks/:customer_address_book_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks",":customer_address_book_id"],"variable":[{"key":"customer_id"},{"key":"customer_address_book_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"d95a5b12-699a-48df-a24c-5bcccfc4959d","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks/:customer_address_book_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks",":customer_address_book_id"],"variable":[{"key":"customer_id"},{"key":"customer_address_book_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"d4f37023-f537-4492-aa25-df18108b1edb"},{"name":"Create a Customer Address","id":"3998492a-7e76-44af-988d-20b086a3e663","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create a new customer address book record.
\n","urlObject":{"path":["customers",":customer_id","addressbooks"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"}]}},"response":[{"id":"e945f3b2-9358-4770-b138-980e60df27b7","name":"A customer address book was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"city\": \"Barboursville\",\n \"company\": \"\",\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"countryId\": 240,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\",\n \"type\": \"residential\"\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks"],"variable":[{"key":"customer_id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n}"},{"id":"71454685-ca9d-458b-8039-f79998375957","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"city\": \"Barboursville\",\n \"company\": \"\",\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"countryId\": 240,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\",\n \"type\": \"residential\"\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks"],"variable":[{"key":"customer_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"5724cb1e-5502-42af-a3fa-1f271563fdfb","name":"Resource not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"city\": \"Barboursville\",\n \"company\": \"\",\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"countryId\": 240,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\",\n \"type\": \"residential\"\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks"],"variable":[{"key":"customer_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"3a1014bc-f54a-4285-9244-4c5bbfa10d44","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"city\": \"Barboursville\",\n \"company\": \"\",\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"countryId\": 240,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\",\n \"type\": \"residential\"\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks"],"variable":[{"key":"customer_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"3998492a-7e76-44af-988d-20b086a3e663"},{"name":"Update a Customer Address","id":"a86b5b5c-0a6e-4515-9dca-2240699d25ee","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update customer address book by ID.
\n","urlObject":{"path":["customers",":customer_id","addressbooks",":customer_address_book_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"},{"description":{"content":"(Required) Customer Address Book Id
\n","type":"text/plain"},"type":"any","value":"1","key":"customer_address_book_id"}]}},"response":[{"id":"a6e779cb-b64a-489b-86f2-3e6b2ff54039","name":"A Customer Address Book updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"city\": \"Barboursville\",\n \"company\": \"\",\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"countryId\": 240,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\",\n \"type\": \"residential\"\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks/:customer_address_book_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks",":customer_address_book_id"],"variable":[{"key":"customer_id"},{"key":"customer_address_book_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n}"},{"id":"9bbab15a-f82d-49a4-b43b-0c473d4d1185","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"city\": \"Barboursville\",\n \"company\": \"\",\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"countryId\": 240,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\",\n \"type\": \"residential\"\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks/:customer_address_book_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks",":customer_address_book_id"],"variable":[{"key":"customer_id"},{"key":"customer_address_book_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"e61f775a-acc3-4644-9b0b-cd1d6d279ffe","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"city\": \"Barboursville\",\n \"company\": \"\",\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"countryId\": 240,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\",\n \"type\": \"residential\"\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks/:customer_address_book_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks",":customer_address_book_id"],"variable":[{"key":"customer_id"},{"key":"customer_address_book_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"3f9061e8-7151-484f-b8b5-44dc2bce4398","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"city\": \"Barboursville\",\n \"company\": \"\",\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"countryId\": 240,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\",\n \"type\": \"residential\"\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks/:customer_address_book_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks",":customer_address_book_id"],"variable":[{"key":"customer_id"},{"key":"customer_address_book_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"a86b5b5c-0a6e-4515-9dca-2240699d25ee"},{"name":"Delete a Customer Address","id":"fcc413a5-502f-482a-b45b-9a9b4061b868","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete a customer address book record. This will delete all sub-data associated with the account, such as subscriptions, payment methods, credit balance etc.
\n","urlObject":{"path":["customers",":customer_id","addressbooks",":customer_address_book_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"},{"description":{"content":"(Required) Customer Address Book Id
\n","type":"text/plain"},"type":"any","value":"1","key":"customer_address_book_id"}]}},"response":[{"id":"04231338-f23b-4e31-8b02-7fbc8d537076","name":"Customer Address Book deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks/:customer_address_book_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks",":customer_address_book_id"],"variable":[{"key":"customer_id"},{"key":"customer_address_book_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"7d56a388-76fb-4042-b73c-f4fda00a1724","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks/:customer_address_book_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks",":customer_address_book_id"],"variable":[{"key":"customer_id"},{"key":"customer_address_book_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"7571c864-5b34-4e5c-a67a-9e8bb5e7b83c","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/addressbooks/:customer_address_book_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","addressbooks",":customer_address_book_id"],"variable":[{"key":"customer_id"},{"key":"customer_address_book_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"fcc413a5-502f-482a-b45b-9a9b4061b868"}],"id":"53c9461e-6dac-4d72-ae69-1e3e85ed2e95","description":"Get Customer Payment Method collection.
\n","urlObject":{"path":["customers",":customer_id","paymentmethods"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Order by
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"Sort by
\n","type":"text/plain"},"key":"sortBy","value":"asc"}],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"}]}},"response":[{"id":"8ebd8f1e-a585-4ff8-8c8e-79be38174f68","name":"Customer Payment Method collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods?orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods"],"query":[{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"customer_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n }\n]"},{"id":"dd6d8754-1cf4-4280-99c2-d705979c507b","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods?orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods"],"query":[{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"customer_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"caad4f39-9995-43ce-9e04-27e34c15cfe8","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods?orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods"],"query":[{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"customer_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"87cd3c95-6492-4d6f-9b42-78e73ca51a74"},{"name":"Get a Customer Payment Method","id":"eb0e6d2c-2de4-4928-966c-78ed55af3781","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get Customer Payment Method by ID.
\n","urlObject":{"path":["customers",":customer_id","paymentmethods",":customer_payment_method_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"},{"description":{"content":"(Required) Customer Payment Method Id
\n","type":"text/plain"},"type":"any","value":"44","key":"customer_payment_method_id"}]}},"response":[{"id":"c70ebcb9-0c52-44b0-9166-80769a2b814a","name":"Customer Payment Method resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/:customer_payment_method_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_id"},{"key":"customer_payment_method_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n}"},{"id":"82b92237-d737-4fa1-8c35-1cd5dac53546","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/:customer_payment_method_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_id"},{"key":"customer_payment_method_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"b7c4bdce-b894-44ab-b94a-aeefe8422788","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/:customer_payment_method_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_id"},{"key":"customer_payment_method_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"eb0e6d2c-2de4-4928-966c-78ed55af3781"},{"name":"Create a Customer Payment Method","id":"11ee9cf0-e972-473b-a19d-88ec92552e41","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create customer.
\n","urlObject":{"path":["customers",":customer_id","paymentmethods"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"}]}},"response":[{"id":"e0bca229-9974-4ee8-b588-bf5d11b0c5ce","name":"A customer payment method was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyGatewayId\": 3412,\n \"type\": \"card\",\n \"accountType\": \"checking\",\n \"accountKind\": \"business\",\n \"accountName\": \"Marta Morales\",\n \"paymentMethod\": {\n \"nonce\": \"tok_visa\"\n },\n \"billingAddress\": {\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n }\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods"],"variable":[{"key":"customer_id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n}"},{"id":"868abc28-4519-4a5f-a2eb-8fdaabcb3fb4","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyGatewayId\": 3412,\n \"type\": \"card\",\n \"accountType\": \"checking\",\n \"accountKind\": \"business\",\n \"accountName\": \"Marta Morales\",\n \"paymentMethod\": {\n \"nonce\": \"tok_visa\"\n },\n \"billingAddress\": {\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n }\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods"],"variable":[{"key":"customer_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"0e46b210-f626-4aeb-a36d-8d0036e1a36a","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyGatewayId\": 3412,\n \"type\": \"card\",\n \"accountType\": \"checking\",\n \"accountKind\": \"business\",\n \"accountName\": \"Marta Morales\",\n \"paymentMethod\": {\n \"nonce\": \"tok_visa\"\n },\n \"billingAddress\": {\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n }\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods"],"variable":[{"key":"customer_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"11ee9cf0-e972-473b-a19d-88ec92552e41"},{"name":"Create a Customer Gateway Profile","id":"84b9f039-4114-4f3a-bf70-3dac097dd143","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create customer.
\n","urlObject":{"path":["customers",":customer_id","paymentmethods","customer-gateway-profile"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"1","key":"customer_id"}]}},"response":[{"id":"97142778-c953-45e8-94d7-2b240079ade7","name":"A customer gateway profile was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"companyGatewayId\": 1,\n\t\"profile\": \"profile\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/customer-gateway-profile","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods","customer-gateway-profile"],"variable":[{"key":"customer_id","value":"1"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"customer_id\": 1,\n\t\"company_gateway_id\": 1,\n\t\"profile_id\": 1\n}"},{"id":"266b27c7-e8fa-4043-aba6-f13b97a687b6","name":"Bad request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"companyGatewayId\": 1,\n\t\"profil\": \"profile\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/customer-gateway-profile","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods","customer-gateway-profile"],"variable":[{"key":"customer_id","value":"1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"5ba4692f-0bf6-438c-b4ec-a1c3d9ec2fb4","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"companyGatewayId\": 1,\n\t\"profile\": \"profile\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/customer-gateway-profile","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods","customer-gateway-profile"],"variable":[{"key":"customer_id","value":"1"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"84b9f039-4114-4f3a-bf70-3dac097dd143"},{"name":"Insert Customer Payment Method","id":"004debb1-59c4-45a8-a89d-a6fa7b26eb6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create customer.
\n","urlObject":{"path":["customers",":customer_id","paymentmethods","insert"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"1","key":"customer_id"}]}},"response":[{"id":"45652511-7ffc-4afb-8996-fdec7fa07bc4","name":"A customer payment method was inserted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"token\",\n\t\"type\": \"card\",\n\t\"accountNumber\": \"4242\",\n\t\"accountName\": \"Marta Morales\",\n\t\"expMonth\": 3,\n\t\"expYear\": 2022,\n\t\"accountType\": \"Visa\",\n\t\"accountKind\": \"business\",\n\t\"bankName\": \"Bank Name\",\n\t\"customerGatewayProfileId\": 1,\n \"customerAddressBookId\": 1\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/insert","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods","insert"],"variable":[{"key":"customer_id","value":"1"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n}"},{"id":"d2683864-697e-434b-9e08-39cddf0164e6","name":"Bad request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"token\",\n\t\"type\": \"card\",\n\t\"accountNumber\": \"4242\",\n\t\"accountName\": \"Marta Morales\",\n\t\"expMonth\": 3,\n\t\"expYear\": 2022,\n\t\"accountType\": \"Visa\",\n\t\"accountKind\": \"business\",\n\t\"bankName\": \"Bank Name\",\n \"customerAddressBookId\": 1\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/insert","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods","insert"],"variable":[{"key":"customer_id","value":"1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"e3177dc7-aa3a-437a-92df-30623971b429","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"token\",\n\t\"type\": \"card\",\n\t\"accountNumber\": \"4242\",\n\t\"accountName\": \"Marta Morales\",\n\t\"expMonth\": 3,\n\t\"expYear\": 2022,\n\t\"accountType\": \"Visa\",\n\t\"accountKind\": \"business\",\n\t\"bankName\": \"Bank Name\",\n\t\"customerGatewayProfileId\": 1,\n \"customerAddressBookId\": 1\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/insert","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods","insert"],"variable":[{"key":"customer_id","value":"1"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"004debb1-59c4-45a8-a89d-a6fa7b26eb6e"},{"name":"Update a Customer Payment Method","id":"62e3b4f9-eb1e-4f1c-b816-ae09d1cfda4c","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update customer payment method by ID.
\n","urlObject":{"path":["customers",":customer_id","paymentmethods",":customer_payment_method_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"},{"description":{"content":"(Required) Customer Payment Method Id
\n","type":"text/plain"},"type":"any","value":"44","key":"customer_payment_method_id"}]}},"response":[{"id":"b88118ea-79ae-43d9-9628-d0b21c7c1794","name":"A Customer updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billingAddress\": {\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n }\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/:customer_payment_method_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_id"},{"key":"customer_payment_method_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n}"},{"id":"48734a39-3254-481a-990b-e46767317bec","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billingAddress\": {\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n }\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/:customer_payment_method_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_id"},{"key":"customer_payment_method_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"5d96449c-269d-4160-90e7-7461d65b5d9f","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billingAddress\": {\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n }\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/:customer_payment_method_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_id"},{"key":"customer_payment_method_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"3e269983-03f2-44dc-a908-51f58cf7b178","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billingAddress\": {\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n }\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/:customer_payment_method_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_id"},{"key":"customer_payment_method_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"62e3b4f9-eb1e-4f1c-b816-ae09d1cfda4c"},{"name":"Delete a Customer Payment Method","id":"908e77e5-6ee7-4be0-a665-aac8558c4324","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete customer payment method.
\n","urlObject":{"path":["customers",":customer_id","paymentmethods",":customer_payment_method_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"},{"description":{"content":"(Required) Customer Payment Method Id
\n","type":"text/plain"},"type":"any","value":"44","key":"customer_payment_method_id"}]}},"response":[{"id":"97a723f0-0370-4042-bfef-40d35b3170c5","name":"Customer Payment Method deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/:customer_payment_method_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_id"},{"key":"customer_payment_method_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"d9735f1b-a61a-4652-98bf-95be00cca850","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/:customer_payment_method_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_id"},{"key":"customer_payment_method_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"29e5711f-e2dd-417a-875f-3555c63c8bf0","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/paymentmethods/:customer_payment_method_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_id"},{"key":"customer_payment_method_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"908e77e5-6ee7-4be0-a665-aac8558c4324"}],"id":"48a6dac4-82be-4059-a3b8-ca0e01200750","description":"The payment method refers to the form of payment customers are using. For online purchases, they usually take the form of electronic payments like credit cards, debit cards or bank transfers.
\nThe customer's method of payment can be created and edited in the customer account. You must have the Change Payment Methods and Delete Payment Methods permissions to create, edit, reset, and delete payment methods. These permissions are enabled by default. When these permissions are disabled, you can only view and download payment methods. An error message is returned if you try to perform actions for which you do not have permission.
\nReturns a list of Customers. Optional filter parameters can be passed in.
\n","urlObject":{"path":["customers"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"addressbook,paymentmethod,lastInvoice,unpaidInvoices,subscriptions,externalCustomers"},{"disabled":true,"description":{"content":"Order by
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"Sort by
\n","type":"text/plain"},"key":"sortBy","value":"asc"},{"disabled":true,"description":{"content":"Filter ID
\n","type":"text/plain"},"key":"filterId","value":"23"},{"key":"query","value":"Alan-Rodriguez-Senesey@rebillia.com"}],"variable":[]}},"response":[{"id":"fdefcf28-ac47-4ddd-b11d-99d805db4141","name":"Customer collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers?include=addressbook,paymentmethod,lastInvoice,unpaidInvoices,subscriptions,externalCustomers&orderBy=id&sortBy=asc&filterId=23","host":["{{host}}/{{version}}"],"path":["customers"],"query":[{"key":"include","value":"addressbook,paymentmethod,lastInvoice,unpaidInvoices,subscriptions,externalCustomers"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"},{"key":"filterId","value":"23"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"addressBook\": [\n {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n }\n ],\n \"paymentMethods\": [\n {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n }\n ],\n \"unpaidInvoice\": [\n {\n \"balanceDue\": \"13.6000\",\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2020-06-18 21:29:35\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 144,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 4,\n \"updatedAt\": \"2020-06-18 21:29:35\"\n },\n \"dateDue\": \"2021-01-11 00:00:00\",\n \"dateFrom\": \"2021-01-11 00:00:00\",\n \"dateTo\": \"2021-01-11 00:00:00\",\n \"id\": 1,\n \"total\": \"13.6000\"\n }\n ],\n \"subscriptions\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"id\": 1,\n \"name\": \"Subscription name\",\n \"shippingAmount\": null,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"lastInvoice\": {\n \"total\": 13.6,\n \"date\": \"2021-04-20\",\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2020-06-18 21:29:35\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 144,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 4,\n \"updatedAt\": \"2020-06-18 21:29:35\"\n }\n },\n \"externalCustomer\": [\n {\n \"externalId\": 7,\n \"type\": \"normal\",\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n }\n ]\n }\n]"},{"id":"7896a052-2b90-4843-ba90-212dd79861a8","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers?include=addressbook,paymentmethod,lastInvoice,unpaidInvoices,subscriptions,externalCustomers&orderBy=id&sortBy=asc&filterId=23","host":["{{host}}/{{version}}"],"path":["customers"],"query":[{"key":"include","value":"addressbook,paymentmethod,lastInvoice,unpaidInvoices,subscriptions,externalCustomers"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"},{"key":"filterId","value":"23"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"1cbff88b-c3e9-423b-b1cc-7fe43e667b08"},{"name":"Get a Customer","id":"6ef73b1a-3dd8-4984-ab1a-e8c9511846ce","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get customer by ID. Optional filter parameters can be passed in.
\n","urlObject":{"path":["customers",":customer_id"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"addressbook,paymentmethod,subscriptions,unpaidInvoices,lastInvoice,externalCustomers"}],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"}]}},"response":[{"id":"2bedc1dd-5127-4644-802f-9a92b56cb787","name":"Customer resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id?include=addressbook,paymentmethod,subscriptions,unpaidInvoices,lastInvoice,externalCustomers","host":["{{host}}/{{version}}"],"path":["customers",":customer_id"],"query":[{"key":"include","value":"addressbook,paymentmethod,subscriptions,unpaidInvoices,lastInvoice,externalCustomers"}],"variable":[{"key":"customer_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"addressBook\": [\n {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n }\n ],\n \"paymentMethods\": [\n {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n }\n ],\n \"unpaidInvoice\": [\n {\n \"balanceDue\": \"13.6000\",\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2020-06-18 21:29:35\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 144,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 4,\n \"updatedAt\": \"2020-06-18 21:29:35\"\n },\n \"dateDue\": \"2021-01-11 00:00:00\",\n \"dateFrom\": \"2021-01-11 00:00:00\",\n \"dateTo\": \"2021-01-11 00:00:00\",\n \"id\": 1,\n \"total\": \"13.6000\"\n }\n ],\n \"subscriptions\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"id\": 1,\n \"name\": \"Subscription name\",\n \"shippingAmount\": null,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"lastInvoice\": {\n \"total\": 13.6,\n \"date\": \"2021-04-20\",\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2020-06-18 21:29:35\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 144,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 4,\n \"updatedAt\": \"2020-06-18 21:29:35\"\n }\n },\n \"externalCustomer\": [\n {\n \"externalId\": 7,\n \"type\": \"normal\",\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n }\n ]\n}"},{"id":"3298eaf7-cb22-4285-83fd-94c11053acc9","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id?include=addressbook,paymentmethod,subscriptions,unpaidInvoices,lastInvoice,externalCustomers","host":["{{host}}/{{version}}"],"path":["customers",":customer_id"],"query":[{"key":"include","value":"addressbook,paymentmethod,subscriptions,unpaidInvoices,lastInvoice,externalCustomers"}],"variable":[{"key":"customer_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"1eb2d38b-0a43-4910-b4b2-0149b9cf87ef","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id?include=addressbook,paymentmethod,subscriptions,unpaidInvoices,lastInvoice,externalCustomers","host":["{{host}}/{{version}}"],"path":["customers",":customer_id"],"query":[{"key":"include","value":"addressbook,paymentmethod,subscriptions,unpaidInvoices,lastInvoice,externalCustomers"}],"variable":[{"key":"customer_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"6ef73b1a-3dd8-4984-ab1a-e8c9511846ce"},{"name":"Create a Customer","id":"ecd6254f-c97d-4a0a-8203-b1cf09f7fb61","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create a new customer record.
\n","urlObject":{"path":["customers"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"7b494527-a716-45b0-9ca3-77968683bcf7","name":"A customer was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"city\": \"Louisville\",\n \"contactName\": \"Zachary Taylor\",\n \"countryId\": 240,\n \"email\": \"zachary.taylor@rebillia.com\",\n \"firstName\": \"Zachary\",\n \"lastName\": \"Taylor\",\n \"state\": \"KY\",\n \"street1\": \"5608 Apache Rd\",\n \"type\": \"residential\",\n \"zip\": \"40207\"\n}"},"url":"{{host}}/{{version}}/customers"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"agent\": null,\n \"businessName\": null,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"zachary.taylor@rebillia.com\",\n \"firstName\": \"Zachary\",\n \"id\": 2,\n \"lastName\": \"Taylor\",\n \"locale\": \"us\",\n \"phoneExt\": null,\n \"phoneNum\": null,\n \"preferredCurrency\": null,\n \"status\": \"active\",\n \"taxExempt\": null,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"5dcb646f-6f5e-4033-85d0-fe48d82b9ac8","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"city\": \"Louisville\",\n \"contactName\": \"Zachary Taylor\",\n \"countryId\": 240,\n \"email\": \"zachary.taylor@rebillia.com\",\n \"firstName\": \"Zachary\",\n \"lastName\": \"Taylor\",\n \"state\": \"KY\",\n \"street1\": \"5608 Apache Rd\",\n \"type\": \"residential\",\n \"zip\": \"40207\"\n}"},"url":"{{host}}/{{version}}/customers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"d5a8c159-5607-43f9-8e85-9e40366126b8","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"city\": \"Louisville\",\n \"contactName\": \"Zachary Taylor\",\n \"countryId\": 240,\n \"email\": \"zachary.taylor@rebillia.com\",\n \"firstName\": \"Zachary\",\n \"lastName\": \"Taylor\",\n \"state\": \"KY\",\n \"street1\": \"5608 Apache Rd\",\n \"type\": \"residential\",\n \"zip\": \"40207\"\n}"},"url":"{{host}}/{{version}}/customers"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"ecd6254f-c97d-4a0a-8203-b1cf09f7fb61"},{"name":"Update a Customer","id":"fb3dd649-0396-4ce8-8789-21e864e73a98","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update customer by ID.
\n","urlObject":{"path":["customers",":customer_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"}]}},"response":[{"id":"ee55df0a-2f10-4d36-8f5f-c3ea3075a5af","name":"A Customer updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"zachary.taylor@rebillia.com\",\n \"firstName\": \"Zachary\",\n \"lastName\": \"Taylor\",\n \"locale\": \"us\"\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id"],"variable":[{"key":"customer_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"agent\": null,\n \"businessName\": null,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"zachary.taylor@rebillia.com\",\n \"firstName\": \"Zachary\",\n \"id\": 2,\n \"lastName\": \"Taylor\",\n \"locale\": \"us\",\n \"phoneExt\": null,\n \"phoneNum\": null,\n \"preferredCurrency\": null,\n \"status\": \"active\",\n \"taxExempt\": null,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"f5c6082b-bbce-4986-b0b6-ecbcea315bba","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"zachary.taylor@rebillia.com\",\n \"firstName\": \"Zachary\",\n \"lastName\": \"Taylor\",\n \"locale\": \"us\"\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id"],"variable":[{"key":"customer_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"d2a8b00c-e0fd-454c-afd8-ae89a0bf0508","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"zachary.taylor@rebillia.com\",\n \"firstName\": \"Zachary\",\n \"lastName\": \"Taylor\",\n \"locale\": \"us\"\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id"],"variable":[{"key":"customer_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"ece377ba-e40c-4159-8f52-1fe2cecfd7ae","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"zachary.taylor@rebillia.com\",\n \"firstName\": \"Zachary\",\n \"lastName\": \"Taylor\",\n \"locale\": \"us\"\n}"},"url":{"raw":"{{host}}/{{version}}/customers/:customer_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id"],"variable":[{"key":"customer_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"fb3dd649-0396-4ce8-8789-21e864e73a98"},{"name":"Delete a customer","id":"aad89545-f8b4-43a1-a0c2-37c73205e975","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete a customer record. This will delete all sub-data associated with the account, such as subscriptions, payment methods, credit balance etc.
\n","urlObject":{"path":["customers",":customer_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"}]}},"response":[{"id":"f38c7508-a552-495a-9cd6-198388951cf5","name":"Customer deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id"],"variable":[{"key":"customer_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"7f4469d0-dcc4-4955-bc9d-8502dbd9e32f","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id"],"variable":[{"key":"customer_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"85aee32b-9213-4a55-ae80-d69908e43ce4","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id","host":["{{host}}/{{version}}"],"path":["customers",":customer_id"],"variable":[{"key":"customer_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"aad89545-f8b4-43a1-a0c2-37c73205e975"},{"name":"Get Customer Invoices","id":"c3efcc07-b870-4bfd-9509-16a34ad5c4e0","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get Customer invoices.
\n","urlObject":{"path":["customers",":customer_id","invoices"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include external invoices
\n","type":"text/plain"},"key":"include","value":"externalInvoices"}],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"}]}},"response":[{"id":"cb7d6376-b4f7-4c35-993f-aafdfe295494","name":"Customer invoices response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/invoices?include=externalInvoices","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","invoices"],"query":[{"key":"include","value":"externalInvoices"}],"variable":[{"key":"customer_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"autoCollection\": true,\n \"balanceDue\": \"13.6000\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"comments\": \"comments\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerEmail\": \"jonh.doe@example.com\",\n \"customerName\": \"Jonh Doe\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"customerPhone\": \"404 55 4444\",\n \"dateDue\": \"2021-04-01 00:00:00\",\n \"dateFrom\": \"2021-04-01 00:00:00\",\n \"datePaid\": \"2021-04-01 13:30:36\",\n \"datePaymentRetry\": null,\n \"dateRefund\": null,\n \"dateTo\": \"2021-04-01 13:30:36\",\n \"dateVoid\": null,\n \"externalInvoices\": [\n {\n \"createdAt\": \"2021-04-01 00:00:00\",\n \"externalDetail\": {\n \"order\": {\n \"id\": 12091,\n \"status\": \"Complete\",\n \"cart_id\": \"5cvfdsb16-91fb-4336-85fb-d24326453gtb78ea\",\n \"coupons\": {\n \"url\": \"https://api.bigcommerce.com/stores/test/v2/orders/12091/coupons\",\n \"resource\": \"/orders/12091/coupons\"\n },\n \"products\": {\n \"url\": \"https://api.bigcommerce.com/stores/test/v2/orders/12091/products\",\n \"resource\": \"/orders/12091/products\"\n },\n \"status_id\": 0,\n \"total_tax\": \"7.7100\",\n \"channel_id\": 1,\n \"ip_address\": \"\",\n \"is_deleted\": false,\n \"currency_id\": 1,\n \"customer_id\": 7,\n \"external_id\": null,\n \"items_total\": 2,\n \"staff_notes\": \"\",\n \"date_created\": \"Thu, 01 Apr 2021 13:30:33 +0000\",\n \"date_shipped\": \"\",\n \"order_source\": \"checkout_api\",\n \"subtotal_tax\": \"6.9100\",\n \"total_ex_tax\": \"77.0700\",\n \"currency_code\": \"USD\",\n \"custom_status\": \"Incomplete\",\n \"date_modified\": \"Thu, 01 Apr 2021 13:30:33 +0000\",\n \"ebay_order_id\": \"0\",\n \"geoip_country\": \"\",\n \"items_shipped\": 0,\n \"total_inc_tax\": \"84.7800\",\n \"payment_method\": \"\",\n \"payment_status\": \"\",\n \"billing_address\": {\n \"zip\": \"22923\",\n \"city\": \"Barboursville\",\n \"email\": \"jonh.doe@example.com\",\n \"phone\": \"\",\n \"state\": \"Virginia\",\n \"company\": \"\",\n \"country\": \"United States\",\n \"street_1\": \"123 Main St\",\n \"street_2\": \"\",\n \"last_name\": \"Jonh\",\n \"first_name\": \"Doe\",\n \"form_fields\": [],\n \"country_iso2\": \"US\"\n },\n \"coupon_discount\": \"0.0000\",\n \"customer_locale\": \"en\",\n \"discount_amount\": \"0.0000\",\n \"external_source\": null,\n \"is_email_opt_in\": false,\n \"refunded_amount\": \"0.0000\",\n \"subtotal_ex_tax\": \"69.1200\",\n \"tax_provider_id\": \"FixedTaxProvider\",\n \"credit_card_type\": null,\n \"customer_message\": \"\",\n \"order_is_digital\": false,\n \"subtotal_inc_tax\": \"76.0300\",\n \"handling_cost_tax\": \"0.0000\",\n \"shipping_cost_tax\": \"0.8000\",\n \"wrapping_cost_tax\": \"0.0000\",\n \"base_handling_cost\": \"0.0000\",\n \"base_shipping_cost\": \"7.9500\",\n \"base_wrapping_cost\": \"0.0000\",\n \"geoip_country_iso2\": \"\",\n \"shipping_addresses\": {\n \"url\": \"https://api.bigcommerce.com/stores/test/v2/orders/12091/shipping_addresses\",\n \"resource\": \"/orders/12091/shipping_addresses\"\n },\n \"default_currency_id\": 1,\n \"payment_provider_id\": null,\n \"store_credit_amount\": \"0.0000\",\n \"external_merchant_id\": null,\n \"handling_cost_ex_tax\": \"0.0000\",\n \"shipping_cost_ex_tax\": \"7.9500\",\n \"wrapping_cost_ex_tax\": \"0.0000\",\n \"default_currency_code\": \"USD\",\n \"handling_cost_inc_tax\": \"0.0000\",\n \"shipping_cost_inc_tax\": \"8.7500\",\n \"wrapping_cost_inc_tax\": \"0.0000\",\n \"currency_exchange_rate\": \"1.0000000000\",\n \"shipping_address_count\": 1,\n \"gift_certificate_amount\": \"0.0000\",\n \"handling_cost_tax_class_id\": 2,\n \"shipping_cost_tax_class_id\": 2,\n \"wrapping_cost_tax_class_id\": 3,\n \"store_default_currency_code\": \"USD\",\n \"store_default_to_transactional_exchange_rate\": \"1.0000000000\"\n },\n \"orderProducts\": [\n {\n \"id\": 2003,\n \"sku\": \"\",\n \"upc\": \"\",\n \"name\": \"Prod 1\",\n \"type\": \"physical\",\n \"depth\": \"0.0000\",\n \"width\": \"0.0000\",\n \"height\": \"0.0000\",\n \"weight\": \"1.0000\",\n \"order_id\": 12091,\n \"quantity\": 1,\n \"price_tax\": \"1.2300\",\n \"return_id\": 0,\n \"total_tax\": \"1.2300\",\n \"base_price\": \"12.3400\",\n \"base_total\": \"12.3400\",\n \"event_date\": \"\",\n \"event_name\": null,\n \"product_id\": 1464,\n \"variant_id\": 1773,\n \"external_id\": null,\n \"is_refunded\": false,\n \"ebay_item_id\": \"\",\n \"price_ex_tax\": \"12.3400\",\n \"total_ex_tax\": \"12.3400\",\n \"name_customer\": \"Prod 1\",\n \"name_merchant\": \"Prod 1\",\n \"option_set_id\": 160,\n \"price_inc_tax\": \"13.5700\",\n \"refund_amount\": \"0.0000\",\n \"total_inc_tax\": \"13.5700\",\n \"wrapping_name\": \"\",\n \"cost_price_tax\": \"0.0000\",\n \"base_cost_price\": \"0.0000\",\n \"product_options\": [\n {\n \"id\": 2994,\n \"name\": \"Save-in-subscription1616158689-1464\",\n \"type\": \"Multiple choice\",\n \"value\": \"965\",\n \"option_id\": 372,\n \"display_name\": \"Save in subscription\",\n \"display_style\": \"Dropdown\",\n \"display_value\": \"Monthly\",\n \"order_product_id\": 2003,\n \"product_option_id\": 458,\n \"display_name_customer\": \"Save in subscription\",\n \"display_name_merchant\": \"Save in subscription\",\n \"display_value_customer\": \"Monthly\",\n \"display_value_merchant\": \"Monthly\"\n }\n ],\n \"order_address_id\": 11592,\n \"quantity_shipped\": 0,\n \"wrapping_message\": \"\",\n \"applied_discounts\": [],\n \"cost_price_ex_tax\": \"0.0000\",\n \"quantity_refunded\": 0,\n \"wrapping_cost_tax\": \"0.0000\",\n \"base_wrapping_cost\": \"0.0000\",\n \"bin_picking_number\": \"\",\n \"cost_price_inc_tax\": \"0.0000\",\n \"fulfillment_source\": \"\",\n \"is_bundled_product\": false,\n \"configurable_fields\": [],\n \"ebay_transaction_id\": \"\",\n \"fixed_shipping_cost\": \"0.0000\",\n \"wrapping_cost_ex_tax\": \"0.0000\",\n \"wrapping_cost_inc_tax\": \"0.0000\",\n \"parent_order_product_id\": null\n }\n ]\n },\n \"externalId\": \"12091\",\n \"id\": 1,\n \"invoiceId\": 1,\n \"status\": \"success\",\n \"updatedAt\": \"2021-04-01 00:00:00\",\n \"externalSubscriptionLogs\": [\n {\n \"createdAt\": \"2021-04-01 13:30:42\",\n \"externalInvoiceId\": 1,\n \"id\": 1,\n \"status\": \"success\",\n \"updatedAt\": \"2021-04-01 13:30:42\",\n \"subscriptionId\": 1\n }\n ]\n }\n ],\n \"id\": 1,\n \"invoiceNo\": \"1406\",\n \"offlinePaymentId\": \"\",\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"refundAmount\": \"0.0000\",\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": \"12.0000\",\n \"shippingCompanyIntegration\": null,\n \"shippingServiceId\": \"A01\",\n \"shippingServiceName\": \"\",\n \"status\": \"cancel\",\n \"subtotalTaxExc\": \"69.1200\",\n \"subtotalTaxInc\": \"76.8300\",\n \"taxAmount\": \"7.7100\",\n \"taxCompanyIntegration\": null,\n \"taxRate\": \"0.0000\",\n \"terms\": \"\",\n \"total\": \"84.7800\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n]"},{"id":"aa13fad3-8b8c-4385-80a6-3fbfa8d67bd7","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/invoices?include=externalInvoices","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","invoices"],"query":[{"key":"include","value":"externalInvoices"}],"variable":[{"key":"customer_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"88c6fede-d77c-4174-99c4-36fe182aec66","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/invoices?include=externalInvoices","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","invoices"],"query":[{"key":"include","value":"externalInvoices"}],"variable":[{"key":"customer_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"c3efcc07-b870-4bfd-9509-16a34ad5c4e0"},{"name":"Get Customer Logs","id":"430c5c6b-351f-40d7-a056-9f3e1cd9adac","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get Customer logs.
\n","urlObject":{"path":["customers",":customer_id","logs"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"}]}},"response":[{"id":"8071c0b2-b24f-4d87-80d1-9f4cf6a1202b","name":"Customer logs response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/logs","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","logs"],"variable":[{"key":"customer_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"id\": 22,\n \"jsonContent\": null,\n \"level\": null,\n \"message\": \"message test\",\n \"name\": \"Customer log name\",\n \"source\": \"source test\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"user\": {\n \"id\": 3546,\n \"picture\": \"https://s.gravatar.com/avatar/eb7534d77af41d?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fpa.png\",\n \"firstName\": \"Jonh\",\n \"lastName\": \"Doe\",\n \"username\": \"JonhDoe\",\n \"phoneNum\": null\n }\n }\n]"},{"id":"3554c5e9-f577-4367-823b-ed78d6cf4412","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/logs","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","logs"],"variable":[{"key":"customer_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"7923a8b9-4d60-4df6-8e3a-8595ac6eb457","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/logs","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","logs"],"variable":[{"key":"customer_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"430c5c6b-351f-40d7-a056-9f3e1cd9adac"},{"name":"Get Customer Subscriptions","id":"99813b6b-f6a1-41d2-a897-2d59677a85a8","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get customer subscriptions.
\n","urlObject":{"path":["customers",":customer_id","subscriptions"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"rateplan,rateplanCharge"}],"variable":[{"description":{"content":"(Required) Customer Id
\n","type":"text/plain"},"type":"any","value":"4","key":"customer_id"}]}},"response":[{"id":"f5df3f87-0a9e-4630-aa3f-f599dd014f77","name":"Customer subscriptions response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/customers/:customer_id/subscriptions?include=rateplan,rateplanCharge","host":["{{host}}/{{version}}"],"path":["customers",":customer_id","subscriptions"],"query":[{"key":"include","value":"rateplan,rateplanCharge"}],"variable":[{"key":"customer_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"detail\": null,\n \"id\": 1,\n \"lastBillRun\": null,\n \"lastCharge\": null,\n \"name\": \"Subscription name\",\n \"nextCharge\": \"2021-07-06 00:00:00\",\n \"offlinePaymentId\": null,\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"recurringChargeAmount\": 1843.139,\n \"recurringChargeQty\": 1,\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": null,\n \"shippingCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"UPS\",\n \"id\": 17,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"shippingServiceId\": \"02\",\n \"source\": \"publicApi\",\n \"sourceCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0,\n \"rateplan\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"id\": 7,\n \"lastCharge\": null,\n \"name\": \"Monthly\",\n \"nextCharge\": \"2021-03-31 00:00:00\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"productId\": 7,\n \"productName\": \"Product name\",\n \"productRateplanId\": 143,\n \"rateplanCharge\": [\n {\n \"billCycleDay\": {\n \"value\": \"Customer is the core to managing your clients inside of Rebillia. The customer object stores the entire Rebillia history of your customer and acts as the entry point for working with a customer's billing information, subscription data, transactions, invoices and more.
\nYou can access customer account information by navigating to Customers > Manage in the left-hand navigation section.
\nReturns a list of Company filters.
\n","urlObject":{"path":["companies","filters"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Section
\n","type":"text/plain"},"key":"section","value":"invoices"}],"variable":[]}},"response":[{"id":"bd143ebd-bfb0-429a-8f28-5b5aa92ef415","name":"Filters collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/companies/filters?section=invoices","host":["{{host}}/{{version}}"],"path":["companies","filters"],"query":[{"key":"section","value":"invoices"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"detail\": \"Created At Today \",\n \"id\": 1,\n \"isEditable\": true,\n \"label\": \"All invoice\",\n \"sectionId\": \"invoices\",\n \"status\": \"active\"\n }\n]"},{"id":"954d830e-cbd6-4145-a4ca-d7e5b6d9e5bc","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/companies/filters?section=invoices","host":["{{host}}/{{version}}"],"path":["companies","filters"],"query":[{"key":"section","value":"invoices"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"31e9203b-3d15-4c72-b113-d4208ffcfb12"},{"name":"Create a Filter","id":"bf06722d-a266-4851-bf4d-83131ea294dc","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create a new filter record.
\n","urlObject":{"path":["companies","filters"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"89a5d635-49b3-4dcf-a088-de3e22875bfe","name":"A customer was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"displayName\": \"All subscription\",\n \"section\": \"subscriptions\",\n \"isDefault\": false,\n \"rules\": [\n {\n \"operatorId\": 20,\n \"operatorDisplayName\": \"contains\",\n \"attributeId\": 88,\n \"settingValues\": []\n }\n ]\n}"},"url":"{{host}}/{{version}}/companies/filters"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"\",\n \"id\": 2,\n \"isEditable\": true,\n \"label\": \"All subscription\",\n \"sectionId\": \"subscriptions\",\n \"status\": \"active\"\n}"},{"id":"edaafa42-3a8f-49d4-8289-04ee1da4045f","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"displayName\": \"All subscription\",\n \"section\": \"subscriptions\",\n \"isDefault\": false,\n \"rules\": [\n {\n \"operatorId\": 20,\n \"operatorDisplayName\": \"contains\",\n \"attributeId\": 88,\n \"settingValues\": []\n }\n ]\n}"},"url":"{{host}}/{{version}}/companies/filters"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"ae9a55b8-1c34-42ea-a4c4-6b121600a244","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"displayName\": \"All subscription\",\n \"section\": \"subscriptions\",\n \"isDefault\": false,\n \"rules\": [\n {\n \"operatorId\": 20,\n \"operatorDisplayName\": \"contains\",\n \"attributeId\": 88,\n \"settingValues\": []\n }\n ]\n}"},"url":"{{host}}/{{version}}/companies/filters"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"bf06722d-a266-4851-bf4d-83131ea294dc"},{"name":"Get All Filters Fields","id":"e993eb3c-fc47-4431-b759-3d9531ffff0b","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Returns a list of Company filters fields.
\n","urlObject":{"path":["companies","filters","fields"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Section
\n","type":"text/plain"},"key":"section","value":"invoices"}],"variable":[]}},"response":[{"id":"fef489c5-774f-4299-945b-bba24c52a425","name":"Filters collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/companies/filters/fields?section=invoices","host":["{{host}}/{{version}}"],"path":["companies","filters","fields"],"query":[{"key":"section","value":"invoices"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"allowedOperators\": [\n {\n \"displayName\": \"contains\",\n \"id\": 73,\n \"name\": \"contains\",\n \"type\": \"cb_text\"\n }\n ],\n \"allowedValues\": [],\n \"dataType\": \"string\",\n \"displayName\": \"Name\",\n \"id\": 73,\n \"name\": \"kind\",\n \"originSource\": \"\"\n }\n]"},{"id":"2822318a-2e16-4f1f-a878-5754aa237609","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/companies/filters/fields?section=invoices","host":["{{host}}/{{version}}"],"path":["companies","filters","fields"],"query":[{"key":"section","value":"invoices"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"e993eb3c-fc47-4431-b759-3d9531ffff0b"}],"id":"73cce7eb-74f2-4a28-b862-d77a584acafe","description":"If you have a large number of subscriptions, customers, and products, you can use Rebillias's quick and advanced filter options to find what you're looking for quickly and simply.
\nAll of Rebillia's navigation tabs (Subscriptions, Customers, Invoices, Transactions, Event Logs, etc) are fully equipped with quick and advanced filter options that can be customized to suit the need of the hour.
\nFor a more advanced filter, you can add conditions of your own, by clicking on the Manage Filter option. This option allows you to create a filter with any number of custom rules to refine your search, so you can find exactly what you're looking for with the least amount of effort.
\n","_postman_id":"73cce7eb-74f2-4a28-b862-d77a584acafe"},{"name":"Invoices","item":[{"name":"Get All Invoices","id":"56459c49-22a6-4e2e-8206-29feac196671","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get invoice collection.
\n","urlObject":{"path":["invoices"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"detail,transactions,billruns"},{"disabled":true,"description":{"content":"Order by
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"Sort by
\n","type":"text/plain"},"key":"sortBy","value":"asc"}],"variable":[]}},"response":[{"id":"a7c0a7a8-41cc-4018-b7ba-8e19e5fb3f4b","name":"Invoice collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/invoices?include=detail,transactions,billruns&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["invoices"],"query":[{"key":"include","value":"detail,transactions,billruns"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"autoCollection\": true,\n \"balanceDue\": \"13.6000\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"billRuns\": [\n {\n \"amount\": 1,\n \"completedOn\": \"2021-04-01 14:46:03\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"executedOn\": \"2021-04-01 13:00:39\",\n \"id\": 49,\n \"invoiceCount\": 1,\n \"limit\": null,\n \"repeatType\": \"daily\",\n \"status\": \"completed\",\n \"subscriptionCount\": 1,\n \"targetDate\": \"2021-04-01\",\n \"type\": null,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"comments\": \"comments\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerEmail\": \"jonh.doe@example.com\",\n \"customerName\": \"Jonh Doe\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"customerPhone\": \"404 55 4444\",\n \"dateDue\": \"2021-04-01 00:00:00\",\n \"dateFrom\": \"2021-04-01 00:00:00\",\n \"datePaid\": \"2021-04-01 13:30:36\",\n \"datePaymentRetry\": null,\n \"dateRefund\": null,\n \"dateTo\": \"2021-04-01 13:30:36\",\n \"dateVoid\": null,\n \"detail\": [\n {\n \"amount\": \"0.2000\",\n \"chargeCredit\": null,\n \"description\": \"description test\",\n \"id\": 6799,\n \"qty\": 2,\n \"taxAmount\": \"0.0000\",\n \"totalTaxExc\": \"0.4000\",\n \"totalTaxInc\": \"1.6000\",\n \"taxRate\": \"3.0000\",\n \"product\": {\n \"category\": \"physical\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"This is a product description.\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 8,\n \"internalProductId\": null,\n \"name\": \"Product name\",\n \"sku\": \"P-2\",\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"productRatePlanCharge\": {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": {\n \"value\": \"Get invoice by ID.
\n","urlObject":{"path":["invoices",":invoice_id"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"detail,transactions,billruns"}],"variable":[{"description":{"content":"(Required) Invoice Id
\n","type":"text/plain"},"type":"any","value":"1","key":"invoice_id"}]}},"response":[{"id":"6771e6a4-e6d5-4d63-aba1-51c99dd7739a","name":"Invoice resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id?include=detail,transactions,billruns","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id"],"query":[{"key":"include","value":"detail,transactions,billruns"}],"variable":[{"key":"invoice_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"autoCollection\": true,\n \"balanceDue\": \"13.6000\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"billRuns\": [\n {\n \"amount\": 1,\n \"completedOn\": \"2021-04-01 14:46:03\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"executedOn\": \"2021-04-01 13:00:39\",\n \"id\": 49,\n \"invoiceCount\": 1,\n \"limit\": null,\n \"repeatType\": \"daily\",\n \"status\": \"completed\",\n \"subscriptionCount\": 1,\n \"targetDate\": \"2021-04-01\",\n \"type\": null,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"comments\": \"comments\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerEmail\": \"jonh.doe@example.com\",\n \"customerName\": \"Jonh Doe\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"customerPhone\": \"404 55 4444\",\n \"dateDue\": \"2021-04-01 00:00:00\",\n \"dateFrom\": \"2021-04-01 00:00:00\",\n \"datePaid\": \"2021-04-01 13:30:36\",\n \"datePaymentRetry\": null,\n \"dateRefund\": null,\n \"dateTo\": \"2021-04-01 13:30:36\",\n \"dateVoid\": null,\n \"detail\": [\n {\n \"amount\": \"0.2000\",\n \"chargeCredit\": null,\n \"description\": \"description test\",\n \"id\": 6799,\n \"qty\": 2,\n \"taxAmount\": \"0.0000\",\n \"totalTaxExc\": \"0.4000\",\n \"totalTaxInc\": \"1.6000\",\n \"taxRate\": \"3.0000\",\n \"product\": {\n \"category\": \"physical\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"This is a product description.\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 8,\n \"internalProductId\": null,\n \"name\": \"Product name\",\n \"sku\": \"P-2\",\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"productRatePlanCharge\": {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"id\": 79,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n },\n \"ratePlanCharge\": {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n },\n \"subscription\": {\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"detail\": null,\n \"id\": 1,\n \"lastBillRun\": null,\n \"lastCharge\": null,\n \"name\": \"Subscription name\",\n \"nextCharge\": \"2021-07-06 00:00:00\",\n \"offlinePaymentId\": null,\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"recurringChargeAmount\": 1843.139,\n \"recurringChargeQty\": 1,\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": null,\n \"shippingCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"UPS\",\n \"id\": 17,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"shippingServiceId\": \"02\",\n \"source\": \"publicApi\",\n \"sourceCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n }\n ],\n \"id\": 1,\n \"invoiceNo\": \"1406\",\n \"offlinePaymentId\": \"\",\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"refundAmount\": \"0.0000\",\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": \"12.0000\",\n \"shippingCompanyIntegration\": null,\n \"shippingServiceId\": \"A01\",\n \"shippingServiceName\": \"\",\n \"status\": \"cancel\",\n \"subtotalTaxExc\": \"69.1200\",\n \"subtotalTaxInc\": \"76.8300\",\n \"taxAmount\": \"7.7100\",\n \"taxCompanyIntegration\": null,\n \"taxRate\": \"0.0000\",\n \"terms\": \"\",\n \"total\": \"84.7800\",\n \"transaction\": [\n {\n \"amount\": \"3.2500\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"companyPaymentRun\": null,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentSource\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"errorMessage\": \"\",\n \"id\": 5,\n \"invoiceId\": 1,\n \"kind\": \"desktop\",\n \"parentId\": \"\",\n \"paymentAccountName\": \"Marta Morales\",\n \"paymentAccountNumber\": \"4242\",\n \"paymentExpDate\": \"3/2022\",\n \"paymentMethod\": \"Visa\",\n \"paymentType\": \"card\",\n \"status\": \"settled\",\n \"transactionId\": \"ch_1IdfLAHM3LZNSqFlUZzWo7lZ\",\n \"type\": \"sale\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"f216f8c7-1c11-48c0-883e-35f4c1828a37","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id?include=detail,transactions,billruns","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id"],"query":[{"key":"include","value":"detail,transactions,billruns"}],"variable":[{"key":"invoice_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"7b0d4832-f132-4c02-9125-bb09e20afc94","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id?include=detail,transactions,billruns","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id"],"query":[{"key":"include","value":"detail,transactions,billruns"}],"variable":[{"key":"invoice_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"85b2597a-44a9-49bc-9de6-2e70ad367e70"},{"name":"Get an Invoice By Status","id":"59bc02fc-b062-499a-bc60-815cd7a7970c","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get invoice by ID.
\n","urlObject":{"path":["invoices"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"detail,transactions,billruns"},{"key":"status","value":"{status}"}],"variable":[]}},"response":[{"id":"74de4e7e-f1fb-4c27-89bf-0fcfff1230ee","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id?include=detail,transactions,billruns","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id"],"query":[{"key":"include","value":"detail,transactions,billruns"}],"variable":[{"key":"invoice_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"a846e06e-3dc4-4cd6-a91e-4cfa7621becb","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id?include=detail,transactions,billruns","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id"],"query":[{"key":"include","value":"detail,transactions,billruns"}],"variable":[{"key":"invoice_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"},{"id":"cd48e807-d067-46d8-8e50-0d73f92a6ba2","name":"Get an Invoices","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/invoices?status={status}","host":["{{host}}/{{version}}"],"path":["invoices"],"query":[{"key":"include","value":"detail,transactions,billruns","description":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.","disabled":true},{"key":"status","value":"{status}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Apr 2025 10:19:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.27.0"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Allow","value":"GET, POST"}],"cookie":[],"responseTime":null,"body":"{\n \"currentPageNumber\": 1,\n \"itemsPerPage\": 25,\n \"totalItems\": 5095,\n \"totalPages\": 204,\n \"data\": [\n {\n \"id\": 17954,\n \"customerName\": \"Franco Escamilla\",\n \"dateFrom\": \"2022-08-12T03:00:00+00:00\",\n \"dateTo\": \"2022-08-12T03:00:00+00:00\",\n \"dateDue\": \"2022-08-12T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"91.9900\",\n \"total\": \"91.9900\",\n \"status\": \"posted\"\n },\n {\n \"id\": 19718,\n \"customerName\": \"Snir Sinatra\",\n \"dateFrom\": \"2022-08-24T03:00:00+00:00\",\n \"dateTo\": \"2022-08-24T03:00:00+00:00\",\n \"dateDue\": \"2022-08-24T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"70.0200\",\n \"total\": \"70.0200\",\n \"status\": \"posted\"\n },\n {\n \"id\": 20538,\n \"customerName\": \"Natalio Correas\",\n \"dateFrom\": \"2022-08-31T03:00:00+00:00\",\n \"dateTo\": \"2022-08-31T03:00:00+00:00\",\n \"dateDue\": \"2022-08-31T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"70.0200\",\n \"total\": \"70.0200\",\n \"status\": \"posted\"\n },\n {\n \"id\": 20662,\n \"customerName\": \"Matthew Pascualetti\",\n \"dateFrom\": \"2022-09-01T03:00:00+00:00\",\n \"dateTo\": \"2022-09-01T03:00:00+00:00\",\n \"dateDue\": \"2022-09-01T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"70.0200\",\n \"total\": \"70.0200\",\n \"status\": \"posted\"\n },\n {\n \"id\": 20754,\n \"customerName\": \"Martin SSS\",\n \"dateFrom\": \"2022-09-02T03:00:00+00:00\",\n \"dateTo\": \"2022-09-02T03:00:00+00:00\",\n \"dateDue\": \"2022-09-02T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"77.2100\",\n \"total\": \"77.2100\",\n \"status\": \"posted\"\n },\n {\n \"id\": 20808,\n \"customerName\": \"Matthew Pascualetti\",\n \"dateFrom\": \"2022-09-02T03:00:00+00:00\",\n \"dateTo\": \"2022-09-02T03:00:00+00:00\",\n \"dateDue\": \"2022-09-02T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"80.0200\",\n \"total\": \"80.0200\",\n \"status\": \"posted\"\n },\n {\n \"id\": 21098,\n \"customerName\": \"Matthew Pascualetti\",\n \"dateFrom\": \"2022-09-04T03:00:00+00:00\",\n \"dateTo\": \"2022-09-04T03:00:00+00:00\",\n \"dateDue\": \"2022-09-04T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"70.0200\",\n \"total\": \"70.0200\",\n \"status\": \"posted\"\n },\n {\n \"id\": 21966,\n \"customerName\": \"Pedro Faraz\",\n \"dateFrom\": \"2022-09-09T03:00:00+00:00\",\n \"dateTo\": \"2022-09-09T03:00:00+00:00\",\n \"dateDue\": \"2022-09-09T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"2247.0000\",\n \"total\": \"2247.0000\",\n \"status\": \"posted\"\n },\n {\n \"id\": 21967,\n \"customerName\": \"Juan Pablo Pérez\",\n \"dateFrom\": \"2022-09-09T03:00:00+00:00\",\n \"dateTo\": \"2022-09-09T03:00:00+00:00\",\n \"dateDue\": \"2022-09-09T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"2257.5000\",\n \"total\": \"2257.5000\",\n \"status\": \"posted\"\n },\n {\n \"id\": 22654,\n \"customerName\": \"Senior Blanes\",\n \"dateFrom\": \"2022-09-15T03:00:00+00:00\",\n \"dateTo\": \"2022-09-15T03:00:00+00:00\",\n \"dateDue\": \"2022-09-15T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"289.7400\",\n \"total\": \"289.7400\",\n \"status\": \"posted\"\n },\n {\n \"id\": 24747,\n \"customerName\": \"Franco Escamilla\",\n \"dateFrom\": \"2022-09-29T03:00:00+00:00\",\n \"dateTo\": \"2022-09-29T03:00:00+00:00\",\n \"dateDue\": \"2022-09-29T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"183.9800\",\n \"total\": \"183.9800\",\n \"status\": \"posted\"\n },\n {\n \"id\": 24748,\n \"customerName\": \"Franco Escamilla\",\n \"dateFrom\": \"2022-09-29T03:00:00+00:00\",\n \"dateTo\": \"2022-09-29T03:00:00+00:00\",\n \"dateDue\": \"2022-09-29T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"262.0000\",\n \"total\": \"262.0000\",\n \"status\": \"posted\"\n },\n {\n \"id\": 24898,\n \"customerName\": \"Franco Escamilla\",\n \"dateFrom\": \"2022-09-30T03:00:00+00:00\",\n \"dateTo\": \"2022-09-30T03:00:00+00:00\",\n \"dateDue\": \"2022-09-30T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"91.9900\",\n \"total\": \"91.9900\",\n \"status\": \"posted\"\n },\n {\n \"id\": 25049,\n \"customerName\": \"Franco Escamilla\",\n \"dateFrom\": \"2022-10-01T03:00:00+00:00\",\n \"dateTo\": \"2022-10-01T03:00:00+00:00\",\n \"dateDue\": \"2022-10-01T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"91.9900\",\n \"total\": \"91.9900\",\n \"status\": \"posted\"\n },\n {\n \"id\": 25050,\n \"customerName\": \"Franco Escamilla\",\n \"dateFrom\": \"2022-10-01T03:00:00+00:00\",\n \"dateTo\": \"2022-10-01T03:00:00+00:00\",\n \"dateDue\": \"2022-10-01T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"125.0000\",\n \"total\": \"125.0000\",\n \"status\": \"posted\"\n },\n {\n \"id\": 25200,\n \"customerName\": \"Franco Escamilla\",\n \"dateFrom\": \"2022-10-02T03:00:00+00:00\",\n \"dateTo\": \"2022-10-02T03:00:00+00:00\",\n \"dateDue\": \"2022-10-02T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"91.9900\",\n \"total\": \"91.9900\",\n \"status\": \"posted\"\n },\n {\n \"id\": 25201,\n \"customerName\": \"Franco Escamilla\",\n \"dateFrom\": \"2022-10-02T03:00:00+00:00\",\n \"dateTo\": \"2022-10-02T03:00:00+00:00\",\n \"dateDue\": \"2022-10-02T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"128.0000\",\n \"total\": \"128.0000\",\n \"status\": \"posted\"\n },\n {\n \"id\": 25349,\n \"customerName\": \"Franco Escamilla\",\n \"dateFrom\": \"2022-10-03T03:00:00+00:00\",\n \"dateTo\": \"2022-10-03T03:00:00+00:00\",\n \"dateDue\": \"2022-10-03T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"91.9900\",\n \"total\": \"91.9900\",\n \"status\": \"posted\"\n },\n {\n \"id\": 25350,\n \"customerName\": \"Franco Escamilla\",\n \"dateFrom\": \"2022-10-03T03:00:00+00:00\",\n \"dateTo\": \"2022-10-03T03:00:00+00:00\",\n \"dateDue\": \"2022-10-03T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"128.0000\",\n \"total\": \"128.0000\",\n \"status\": \"posted\"\n },\n {\n \"id\": 25746,\n \"customerName\": \"Franco Escamilla\",\n \"dateFrom\": \"2022-10-06T03:00:00+00:00\",\n \"dateTo\": \"2022-10-06T03:00:00+00:00\",\n \"dateDue\": \"2022-10-06T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"70.5000\",\n \"total\": \"70.5000\",\n \"status\": \"posted\"\n },\n {\n \"id\": 25767,\n \"customerName\": \"Matthew Pascualetti\",\n \"dateFrom\": \"2022-10-06T03:00:00+00:00\",\n \"dateTo\": \"2022-10-06T03:00:00+00:00\",\n \"dateDue\": \"2022-10-06T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"70.5000\",\n \"total\": \"70.5000\",\n \"status\": \"posted\"\n },\n {\n \"id\": 26096,\n \"customerName\": \"Franco Escamilla\",\n \"dateFrom\": \"2022-10-08T03:00:00+00:00\",\n \"dateTo\": \"2022-10-08T03:00:00+00:00\",\n \"dateDue\": \"2022-10-08T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"107.5000\",\n \"total\": \"107.5000\",\n \"status\": \"posted\"\n },\n {\n \"id\": 26097,\n \"customerName\": \"Joao Faraz\",\n \"dateFrom\": \"2022-10-08T03:00:00+00:00\",\n \"dateTo\": \"2022-10-08T03:00:00+00:00\",\n \"dateDue\": \"2022-10-08T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"91.4700\",\n \"total\": \"91.4700\",\n \"status\": \"posted\"\n },\n {\n \"id\": 26245,\n \"customerName\": \"Franco Escamilla\",\n \"dateFrom\": \"2022-10-09T03:00:00+00:00\",\n \"dateTo\": \"2022-10-09T03:00:00+00:00\",\n \"dateDue\": \"2022-10-09T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"58.0000\",\n \"total\": \"58.0000\",\n \"status\": \"posted\"\n },\n {\n \"id\": 26246,\n \"customerName\": \"Joao Faraz\",\n \"dateFrom\": \"2022-10-09T03:00:00+00:00\",\n \"dateTo\": \"2022-10-09T03:00:00+00:00\",\n \"dateDue\": \"2022-10-09T03:00:00+00:00\",\n \"datePaid\": null,\n \"balanceDue\": \"62.9900\",\n \"total\": \"62.9900\",\n \"status\": \"posted\"\n }\n ]\n}"}],"_postman_id":"59bc02fc-b062-499a-bc60-815cd7a7970c"},{"name":"Create an Invoice","id":"c90414d0-dadd-4705-a679-2dace656c51e","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create invoice.
\n","urlObject":{"path":["invoices"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"709c96fe-81cf-4fb4-8e28-89e5d76d0d88","name":"An invoice was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"billingAddress\": {\n \"type\": \"residential\",\n \"contactCompany\": \"\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"contactEmail\": \"contact@example.com\",\n \"street1\": \"123 Main st\",\n \"street2\": null,\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n },\n \"comments\": \"comments\",\n \"companyCurrencyId\": 4,\n \"companyGatewayId\": 13,\n \"customerEmail\": \"zachary.taylor@rebillia.com\",\n \"customerId\": 2,\n \"customerName\": \"Zachary Taylor\",\n \"customerPhone\": \"\",\n \"dateDue\": \"2021-01-11\",\n \"dateFrom\": \"2021-01-11\",\n \"dateTo\": \"2021-01-11\",\n \"detail\": [\n {\n \"amount\": \"20.00\",\n \"chargeCreditId\": null,\n \"description\": \"test\",\n \"qty\": 2,\n \"taxRate\": 3,\n \"total\": \"20.00\"\n }\n ],\n \"paymentMethodId\": 113,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"shippingAddress\": {\n \"type\": \"residential\",\n \"contactCompany\": \"\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"contactEmail\": \"contact@example.com\",\n \"street1\": \"123 Main st\",\n \"street2\": null,\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n },\n \"shippingAmount\": 1200,\n \"shippingCompanyIntegrationId\": null,\n \"shippingServiceId\": \"A01\",\n \"taxCompanyIntegrationId\": null,\n \"terms\": \"onReceipt\"\n}"},"url":"{{host}}/{{version}}/invoices"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"autoCollection\": true,\n \"balanceDue\": \"13.6\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"comments\": \"comments\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerEmail\": \"zachary.taylor@rebillia.com\",\n \"customerName\": \"Zachary Taylor\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"customerPhone\": \"\",\n \"dateDue\": \"2021-01-01 00:00:00\",\n \"dateFrom\": \"2021-01-01 00:00:00\",\n \"datePaid\": \"2021-04-01 13:30:36\",\n \"datePaymentRetry\": null,\n \"dateRefund\": null,\n \"dateTo\": \"2021-01-01 13:30:36\",\n \"dateVoid\": null,\n \"detail\": [\n {\n \"amount\": 0.2,\n \"chargeCredit\": null,\n \"description\": \"test\",\n \"id\": 6799,\n \"qty\": 2,\n \"taxAmount\": 0,\n \"totalTaxExc\": 0.4,\n \"totalTaxInc\": 1.6,\n \"taxRate\": 3,\n \"product\": null,\n \"productRatePlanCharge\": null,\n \"ratePlanCharge\": null,\n \"subscription\": null\n }\n ],\n \"id\": 1,\n \"invoiceNo\": \"1397\",\n \"offlinePaymentId\": \"\",\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"refundAmount\": \"aliqua eu\",\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": \"in ni\",\n \"shippingCompanyIntegration\": null,\n \"shippingServiceId\": \"A01\",\n \"status\": \"paymentDue\",\n \"subtotalTaxExc\": \"ex aliquip veniam officia ipsum\",\n \"subtotalTaxInc\": \"aute sit consectetur aliqua\",\n \"taxAmount\": \"eu dolor sit\",\n \"taxCompanyIntegration\": null,\n \"taxRate\": \"cillum veniam deserunt elit\",\n \"terms\": \"onReceipt\",\n \"total\": \"ea culpa\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"237ccb6a-f984-4f6f-a30f-5f5f1744c314","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"billingAddress\": {\n \"type\": \"residential\",\n \"contactCompany\": \"\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"contactEmail\": \"contact@example.com\",\n \"street1\": \"123 Main st\",\n \"street2\": null,\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n },\n \"comments\": \"comments\",\n \"companyCurrencyId\": 4,\n \"companyGatewayId\": 13,\n \"customerEmail\": \"zachary.taylor@rebillia.com\",\n \"customerId\": 2,\n \"customerName\": \"Zachary Taylor\",\n \"customerPhone\": \"\",\n \"dateDue\": \"2021-01-11\",\n \"dateFrom\": \"2021-01-11\",\n \"dateTo\": \"2021-01-11\",\n \"detail\": [\n {\n \"amount\": \"20.00\",\n \"chargeCreditId\": null,\n \"description\": \"test\",\n \"qty\": 2,\n \"taxRate\": 3,\n \"total\": \"20.00\"\n }\n ],\n \"paymentMethodId\": 113,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"shippingAddress\": {\n \"type\": \"residential\",\n \"contactCompany\": \"\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"contactEmail\": \"contact@example.com\",\n \"street1\": \"123 Main st\",\n \"street2\": null,\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n },\n \"shippingAmount\": 1200,\n \"shippingCompanyIntegrationId\": null,\n \"shippingServiceId\": \"A01\",\n \"taxCompanyIntegrationId\": null,\n \"terms\": \"onReceipt\"\n}"},"url":"{{host}}/{{version}}/invoices"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"55d3af15-08b4-4086-9208-bb9053151918","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"billingAddress\": {\n \"type\": \"residential\",\n \"contactCompany\": \"\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"contactEmail\": \"contact@example.com\",\n \"street1\": \"123 Main st\",\n \"street2\": null,\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n },\n \"comments\": \"comments\",\n \"companyCurrencyId\": 4,\n \"companyGatewayId\": 13,\n \"customerEmail\": \"zachary.taylor@rebillia.com\",\n \"customerId\": 2,\n \"customerName\": \"Zachary Taylor\",\n \"customerPhone\": \"\",\n \"dateDue\": \"2021-01-11\",\n \"dateFrom\": \"2021-01-11\",\n \"dateTo\": \"2021-01-11\",\n \"detail\": [\n {\n \"amount\": \"20.00\",\n \"chargeCreditId\": null,\n \"description\": \"test\",\n \"qty\": 2,\n \"taxRate\": 3,\n \"total\": \"20.00\"\n }\n ],\n \"paymentMethodId\": 113,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"shippingAddress\": {\n \"type\": \"residential\",\n \"contactCompany\": \"\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"contactEmail\": \"contact@example.com\",\n \"street1\": \"123 Main st\",\n \"street2\": null,\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n },\n \"shippingAmount\": 1200,\n \"shippingCompanyIntegrationId\": null,\n \"shippingServiceId\": \"A01\",\n \"taxCompanyIntegrationId\": null,\n \"terms\": \"onReceipt\"\n}"},"url":"{{host}}/{{version}}/invoices"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"c90414d0-dadd-4705-a679-2dace656c51e"},{"name":"Update an Invoice","id":"50a74caf-bcda-41ba-88c4-a3f19eae23ec","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update invoice by ID.
\n","urlObject":{"path":["invoices",":invoice_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Invoice Id
\n","type":"text/plain"},"type":"any","value":"1","key":"invoice_id"}]}},"response":[{"id":"e3130c88-001f-48a1-ac36-5ad4833af376","name":"An Invoice updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billingAddress\": {\n \"type\": \"residential\",\n \"contactCompany\": \"\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"contactEmail\": \"contact@example.com\",\n \"street1\": \"123 Main st\",\n \"street2\": null,\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n },\n \"comments\": \"comments\",\n \"companyCurrencyId\": 4,\n \"companyGatewayId\": 13,\n \"customerEmail\": \"zachary.taylor@rebillia.com\",\n \"customerId\": 2,\n \"customerName\": \"Zachary Taylor\",\n \"customerPhone\": \"\",\n \"dateDue\": \"2021-01-11\",\n \"dateFrom\": \"2021-01-11\",\n \"dateTo\": \"2021-01-11\",\n \"detail\": [\n {\n \"amount\": \"20.00\",\n \"chargeCreditId\": null,\n \"description\": \"test\",\n \"qty\": 2,\n \"taxRate\": 3,\n \"total\": \"20.00\"\n }\n ],\n \"paymentMethodId\": 113,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"shippingAddress\": {\n \"type\": \"residential\",\n \"contactCompany\": \"\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"contactEmail\": \"contact@example.com\",\n \"street1\": \"123 Main st\",\n \"street2\": null,\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n },\n \"shippingAmount\": 1200,\n \"shippingCompanyIntegrationId\": null,\n \"shippingServiceId\": \"A01\",\n \"taxCompanyIntegrationId\": null,\n \"terms\": \"onReceipt\"\n}"},"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id"],"variable":[{"key":"invoice_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"autoCollection\": true,\n \"balanceDue\": \"13.6\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"comments\": \"comments\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerEmail\": \"zachary.taylor@rebillia.com\",\n \"customerName\": \"Zachary Taylor\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"customerPhone\": \"\",\n \"dateDue\": \"2021-01-01 00:00:00\",\n \"dateFrom\": \"2021-01-01 00:00:00\",\n \"datePaid\": \"2021-04-01 13:30:36\",\n \"datePaymentRetry\": null,\n \"dateRefund\": null,\n \"dateTo\": \"2021-01-01 13:30:36\",\n \"dateVoid\": null,\n \"detail\": [\n {\n \"amount\": 0.2,\n \"chargeCredit\": null,\n \"description\": \"test\",\n \"id\": 6799,\n \"qty\": 2,\n \"taxAmount\": 0,\n \"totalTaxExc\": 0.4,\n \"totalTaxInc\": 1.6,\n \"taxRate\": 3,\n \"product\": null,\n \"productRatePlanCharge\": null,\n \"ratePlanCharge\": null,\n \"subscription\": null\n }\n ],\n \"id\": 1,\n \"invoiceNo\": \"1397\",\n \"offlinePaymentId\": \"\",\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"refundAmount\": \"aliqua eu\",\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": \"in ni\",\n \"shippingCompanyIntegration\": null,\n \"shippingServiceId\": \"A01\",\n \"status\": \"paymentDue\",\n \"subtotalTaxExc\": \"ex aliquip veniam officia ipsum\",\n \"subtotalTaxInc\": \"aute sit consectetur aliqua\",\n \"taxAmount\": \"eu dolor sit\",\n \"taxCompanyIntegration\": null,\n \"taxRate\": \"cillum veniam deserunt elit\",\n \"terms\": \"onReceipt\",\n \"total\": \"ea culpa\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"20511a66-7ba3-40fd-934f-280408906831","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billingAddress\": {\n \"type\": \"residential\",\n \"contactCompany\": \"\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"contactEmail\": \"contact@example.com\",\n \"street1\": \"123 Main st\",\n \"street2\": null,\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n },\n \"comments\": \"comments\",\n \"companyCurrencyId\": 4,\n \"companyGatewayId\": 13,\n \"customerEmail\": \"zachary.taylor@rebillia.com\",\n \"customerId\": 2,\n \"customerName\": \"Zachary Taylor\",\n \"customerPhone\": \"\",\n \"dateDue\": \"2021-01-11\",\n \"dateFrom\": \"2021-01-11\",\n \"dateTo\": \"2021-01-11\",\n \"detail\": [\n {\n \"amount\": \"20.00\",\n \"chargeCreditId\": null,\n \"description\": \"test\",\n \"qty\": 2,\n \"taxRate\": 3,\n \"total\": \"20.00\"\n }\n ],\n \"paymentMethodId\": 113,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"shippingAddress\": {\n \"type\": \"residential\",\n \"contactCompany\": \"\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"contactEmail\": \"contact@example.com\",\n \"street1\": \"123 Main st\",\n \"street2\": null,\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n },\n \"shippingAmount\": 1200,\n \"shippingCompanyIntegrationId\": null,\n \"shippingServiceId\": \"A01\",\n \"taxCompanyIntegrationId\": null,\n \"terms\": \"onReceipt\"\n}"},"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id"],"variable":[{"key":"invoice_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"0d9f851a-8411-46f0-a9bb-d1578fbb6037","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billingAddress\": {\n \"type\": \"residential\",\n \"contactCompany\": \"\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"contactEmail\": \"contact@example.com\",\n \"street1\": \"123 Main st\",\n \"street2\": null,\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n },\n \"comments\": \"comments\",\n \"companyCurrencyId\": 4,\n \"companyGatewayId\": 13,\n \"customerEmail\": \"zachary.taylor@rebillia.com\",\n \"customerId\": 2,\n \"customerName\": \"Zachary Taylor\",\n \"customerPhone\": \"\",\n \"dateDue\": \"2021-01-11\",\n \"dateFrom\": \"2021-01-11\",\n \"dateTo\": \"2021-01-11\",\n \"detail\": [\n {\n \"amount\": \"20.00\",\n \"chargeCreditId\": null,\n \"description\": \"test\",\n \"qty\": 2,\n \"taxRate\": 3,\n \"total\": \"20.00\"\n }\n ],\n \"paymentMethodId\": 113,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"shippingAddress\": {\n \"type\": \"residential\",\n \"contactCompany\": \"\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"contactEmail\": \"contact@example.com\",\n \"street1\": \"123 Main st\",\n \"street2\": null,\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n },\n \"shippingAmount\": 1200,\n \"shippingCompanyIntegrationId\": null,\n \"shippingServiceId\": \"A01\",\n \"taxCompanyIntegrationId\": null,\n \"terms\": \"onReceipt\"\n}"},"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id"],"variable":[{"key":"invoice_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"79f59adf-5032-4c43-be09-0a6d6b55804d","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billingAddress\": {\n \"type\": \"residential\",\n \"contactCompany\": \"\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"contactEmail\": \"contact@example.com\",\n \"street1\": \"123 Main st\",\n \"street2\": null,\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n },\n \"comments\": \"comments\",\n \"companyCurrencyId\": 4,\n \"companyGatewayId\": 13,\n \"customerEmail\": \"zachary.taylor@rebillia.com\",\n \"customerId\": 2,\n \"customerName\": \"Zachary Taylor\",\n \"customerPhone\": \"\",\n \"dateDue\": \"2021-01-11\",\n \"dateFrom\": \"2021-01-11\",\n \"dateTo\": \"2021-01-11\",\n \"detail\": [\n {\n \"amount\": \"20.00\",\n \"chargeCreditId\": null,\n \"description\": \"test\",\n \"qty\": 2,\n \"taxRate\": 3,\n \"total\": \"20.00\"\n }\n ],\n \"paymentMethodId\": 113,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"shippingAddress\": {\n \"type\": \"residential\",\n \"contactCompany\": \"\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"contactEmail\": \"contact@example.com\",\n \"street1\": \"123 Main st\",\n \"street2\": null,\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryId\": 240\n },\n \"shippingAmount\": 1200,\n \"shippingCompanyIntegrationId\": null,\n \"shippingServiceId\": \"A01\",\n \"taxCompanyIntegrationId\": null,\n \"terms\": \"onReceipt\"\n}"},"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id"],"variable":[{"key":"invoice_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"50a74caf-bcda-41ba-88c4-a3f19eae23ec"},{"name":"Delete an Invoice","id":"9ec4b298-3167-44ff-baf5-dfd543387b84","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete invoice.
\n","urlObject":{"path":["invoices",":invoice_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Invoice Id
\n","type":"text/plain"},"type":"any","value":"1","key":"invoice_id"}]}},"response":[{"id":"29f94cd2-e0ec-441f-b0d3-075ce94848ba","name":"Invoice deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id"],"variable":[{"key":"invoice_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"5f3f536e-a617-44da-b79d-cc8fc97fd733","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id"],"variable":[{"key":"invoice_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"2b074c8a-23b5-4df0-8f8c-24a350c8b8f7","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id"],"variable":[{"key":"invoice_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"9ec4b298-3167-44ff-baf5-dfd543387b84"},{"name":"Charge an Invoice","id":"46ed9f12-9df6-4743-9fc3-be3b4d0009cf","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Charge invoice.
\n","urlObject":{"path":["invoices",":invoice_id","charge"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"type":"any","value":"","key":"invoice_id"}]}},"response":[{"id":"e296a135-2072-49fa-8671-4d03320ba828","name":"Charge invoice response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"accountKind\": \"test\",\n \"accountName\": \"test\",\n \"accountType\": \"test\",\n \"amount\": 323,\n \"paymentMethodId\": 113,\n \"paymentNonce\": null,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"savePayment\": false,\n \"settlement\": \"authorizeCapture\"\n}"},"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id/charge","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id","charge"],"variable":[{"key":"invoice_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"autoCollection\": true,\n \"balanceDue\": \"13.6000\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"comments\": \"comments\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerEmail\": \"jonh.doe@example.com\",\n \"customerName\": \"Jonh Doe\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"customerPhone\": \"404 55 4444\",\n \"dateDue\": \"2021-04-01 00:00:00\",\n \"dateFrom\": \"2021-04-01 00:00:00\",\n \"datePaid\": \"2021-04-01 13:30:36\",\n \"datePaymentRetry\": null,\n \"dateRefund\": null,\n \"dateTo\": \"2021-04-01 13:30:36\",\n \"dateVoid\": null,\n \"detail\": [],\n \"id\": 1,\n \"invoiceNo\": \"1406\",\n \"offlinePaymentId\": \"\",\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"refundAmount\": \"0.0000\",\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": \"12.0000\",\n \"shippingCompanyIntegration\": null,\n \"shippingServiceId\": \"A01\",\n \"shippingServiceName\": \"\",\n \"status\": \"cancel\",\n \"subtotalTaxExc\": \"69.1200\",\n \"subtotalTaxInc\": \"76.8300\",\n \"taxAmount\": \"7.7100\",\n \"taxCompanyIntegration\": null,\n \"taxRate\": \"0.0000\",\n \"terms\": \"\",\n \"total\": \"84.7800\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"transaction\": {\n \"amount\": \"3.2500\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"companyPaymentRun\": null,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentSource\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"errorMessage\": \"\",\n \"id\": 5,\n \"invoiceId\": 1,\n \"kind\": \"desktop\",\n \"parentId\": \"\",\n \"paymentAccountName\": \"Marta Morales\",\n \"paymentAccountNumber\": \"4242\",\n \"paymentExpDate\": \"3/2022\",\n \"paymentMethod\": \"Visa\",\n \"paymentType\": \"card\",\n \"status\": \"settled\",\n \"transactionId\": \"ch_1IdfLAHM3LZNSqFlUZzWo7lZ\",\n \"type\": \"sale\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n}"},{"id":"774b59c6-e046-4774-8c11-9040e9f65ede","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"accountKind\": \"test\",\n \"accountName\": \"test\",\n \"accountType\": \"test\",\n \"amount\": 323,\n \"paymentMethodId\": 113,\n \"paymentNonce\": null,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"savePayment\": false,\n \"settlement\": \"authorizeCapture\"\n}"},"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id/charge","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id","charge"],"variable":[{"key":"invoice_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invoice_charge_error\",\n \"message\": \"A charge of an invoice was fail.\"\n}"},{"id":"0687d416-b012-4c65-b11d-32ee94bb9244","name":"Resource not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"accountKind\": \"test\",\n \"accountName\": \"test\",\n \"accountType\": \"test\",\n \"amount\": 323,\n \"paymentMethodId\": 113,\n \"paymentNonce\": null,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"savePayment\": false,\n \"settlement\": \"authorizeCapture\"\n}"},"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id/charge","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id","charge"],"variable":[{"key":"invoice_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"f94dee02-abf5-48b7-93ca-2025f50309ae","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"accountKind\": \"test\",\n \"accountName\": \"test\",\n \"accountType\": \"test\",\n \"amount\": 323,\n \"paymentMethodId\": 113,\n \"paymentNonce\": null,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"savePayment\": false,\n \"settlement\": \"authorizeCapture\"\n}"},"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id/charge","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id","charge"],"variable":[{"key":"invoice_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"46ed9f12-9df6-4743-9fc3-be3b4d0009cf"},{"name":"Charge an Invoice With External Payment","id":"3ca9e8f0-df8e-4b45-9cc9-be4ac12b2446","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Charge invoice.
\n","urlObject":{"path":["invoices",":invoice_id","charge"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Invoice Id
\n","type":"text/plain"},"type":"any","value":"1","key":"invoice_id"}]}},"response":[{"id":"0e1d0a41-a8d8-4353-89c5-70a0161f4d6d","name":"Charge invoice response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"accountKind\": \"test\",\n \"accountName\": \"test\",\n \"accountType\": \"test\",\n \"amount\": 323,\n \"paymentMethodId\": 113,\n \"paymentNonce\": null,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"savePayment\": false,\n \"settlement\": \"authorizeCapture\"\n}"},"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id/charge","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id","charge"],"variable":[{"key":"invoice_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"autoCollection\": true,\n \"balanceDue\": \"13.6000\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"comments\": \"comments\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerEmail\": \"jonh.doe@example.com\",\n \"customerName\": \"Jonh Doe\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"customerPhone\": \"404 55 4444\",\n \"dateDue\": \"2021-04-01 00:00:00\",\n \"dateFrom\": \"2021-04-01 00:00:00\",\n \"datePaid\": \"2021-04-01 13:30:36\",\n \"datePaymentRetry\": null,\n \"dateRefund\": null,\n \"dateTo\": \"2021-04-01 13:30:36\",\n \"dateVoid\": null,\n \"detail\": [],\n \"id\": 1,\n \"invoiceNo\": \"1406\",\n \"offlinePaymentId\": \"\",\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"refundAmount\": \"0.0000\",\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": \"12.0000\",\n \"shippingCompanyIntegration\": null,\n \"shippingServiceId\": \"A01\",\n \"shippingServiceName\": \"\",\n \"status\": \"cancel\",\n \"subtotalTaxExc\": \"69.1200\",\n \"subtotalTaxInc\": \"76.8300\",\n \"taxAmount\": \"7.7100\",\n \"taxCompanyIntegration\": null,\n \"taxRate\": \"0.0000\",\n \"terms\": \"\",\n \"total\": \"84.7800\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"transaction\": {\n \"amount\": \"3.2500\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"companyPaymentRun\": null,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentSource\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"errorMessage\": \"\",\n \"id\": 5,\n \"invoiceId\": 1,\n \"kind\": \"desktop\",\n \"parentId\": \"\",\n \"paymentAccountName\": \"Marta Morales\",\n \"paymentAccountNumber\": \"4242\",\n \"paymentExpDate\": \"3/2022\",\n \"paymentMethod\": \"Visa\",\n \"paymentType\": \"card\",\n \"status\": \"settled\",\n \"transactionId\": \"ch_1IdfLAHM3LZNSqFlUZzWo7lZ\",\n \"type\": \"sale\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n}"},{"id":"af65df53-ad82-4f28-bc6e-37f2e9a8a0eb","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"accountKind\": \"test\",\n \"accountName\": \"test\",\n \"accountType\": \"test\",\n \"amount\": 323,\n \"paymentMethodId\": 113,\n \"paymentNonce\": null,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"savePayment\": false,\n \"settlement\": \"authorizeCapture\"\n}"},"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id/charge","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id","charge"],"variable":[{"key":"invoice_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invoice_charge_error\",\n \"message\": \"A charge of an invoice was fail.\"\n}"},{"id":"b11144bd-cdc2-4dcf-b4b1-7487b9538ac7","name":"Resource not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"accountKind\": \"test\",\n \"accountName\": \"test\",\n \"accountType\": \"test\",\n \"amount\": 323,\n \"paymentMethodId\": 113,\n \"paymentNonce\": null,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"savePayment\": false,\n \"settlement\": \"authorizeCapture\"\n}"},"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id/charge","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id","charge"],"variable":[{"key":"invoice_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"58516e19-8bba-4475-87ba-e71d2e69512e","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"accountKind\": \"test\",\n \"accountName\": \"test\",\n \"accountType\": \"test\",\n \"amount\": 323,\n \"paymentMethodId\": 113,\n \"paymentNonce\": null,\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"savePayment\": false,\n \"settlement\": \"authorizeCapture\"\n}"},"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id/charge","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id","charge"],"variable":[{"key":"invoice_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"3ca9e8f0-df8e-4b45-9cc9-be4ac12b2446"},{"name":"Cancel an Invoice","id":"38d4774e-30e1-4040-9e6a-0a58cff0c764","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Cancel invoice.
\n","urlObject":{"path":["invoices",":invoice_id","void"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Invoice Id
\n","type":"text/plain"},"type":"any","value":"1","key":"invoice_id"}]}},"response":[{"id":"515758dd-4a58-4c91-927b-e128e999dbfd","name":"Cancel invoice response","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id/void","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id","void"],"variable":[{"key":"invoice_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"autoCollection\": true,\n \"balanceDue\": \"13.6000\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"comments\": \"comments\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerEmail\": \"jonh.doe@example.com\",\n \"customerName\": \"Jonh Doe\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"customerPhone\": \"404 55 4444\",\n \"dateDue\": \"2021-04-01 00:00:00\",\n \"dateFrom\": \"2021-04-01 00:00:00\",\n \"datePaid\": \"2021-04-01 13:30:36\",\n \"datePaymentRetry\": null,\n \"dateRefund\": null,\n \"dateTo\": \"2021-04-01 13:30:36\",\n \"dateVoid\": null,\n \"detail\": [],\n \"id\": 1,\n \"invoiceNo\": \"1406\",\n \"offlinePaymentId\": \"\",\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"refundAmount\": \"0.0000\",\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": \"12.0000\",\n \"shippingCompanyIntegration\": null,\n \"shippingServiceId\": \"A01\",\n \"shippingServiceName\": \"\",\n \"status\": \"cancel\",\n \"subtotalTaxExc\": \"69.1200\",\n \"subtotalTaxInc\": \"76.8300\",\n \"taxAmount\": \"7.7100\",\n \"taxCompanyIntegration\": null,\n \"taxRate\": \"0.0000\",\n \"terms\": \"\",\n \"total\": \"84.7800\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"8d989e8f-9f9f-438d-b2ab-e09e9c53b63a","name":"Bad request","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id/void","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id","void"],"variable":[{"key":"invoice_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invoice_cancel_error\",\n \"message\": \"An invoice can not be cancel.\"\n}"},{"id":"7e616421-e119-4852-a403-52873ffc44c8","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id/void","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id","void"],"variable":[{"key":"invoice_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"3887f3e5-9080-42c7-86d4-bb47164674ab","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/{{version}}/invoices/:invoice_id/void","host":["{{host}}/{{version}}"],"path":["invoices",":invoice_id","void"],"variable":[{"key":"invoice_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"38d4774e-30e1-4040-9e6a-0a58cff0c764"}],"id":"bf50b3a2-529f-4f4e-b9a5-9a645835f78d","description":"Invoices are your bills that you are sending to your customers.
\nFor every subscription a posted invoice (upcoming invoice) is used to track all the charges, credits and adjustments for the current term. The invoices are generated automatically and driven by the configuration of products, rate plans, and billing schedules. When it is time to invoice, you can process them thousands at a time, do it on-demand, or one at a time as your customers need it. You can generate the real-time invoices immediately after refunds on payments or subscription changes. The prorated charges can be included in the invoice amount calculation to ensure that your customers are billed correctly when subscriptions start part way through a billing period.
\nWhen invoice is closed, an attempt to charge the credit card is made. If the payment succeeds, it is marked as paid. If the payment fails, the invoice is marked as payment_due and retry settings are taken into account. If no retry attempts are configured, the invoice is marked as not_paid. If the amount due is zero or negative, the invoice is immediately marked as paid and the balance if any is carried forward to the next term of the invoice.\nThe Invoice Object includes the following fields:
\nGet Product Rateplan collection.
\n","urlObject":{"path":["products",":product_id","product-rateplans"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"productRateplanCharge,chargeTier"},{"disabled":true,"description":{"content":"Status of the Product Rateplan
\n","type":"text/plain"},"key":"status","value":"published"},{"disabled":true,"description":{"content":"Order by
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"Sort by
\n","type":"text/plain"},"key":"sortBy","value":"asc"}],"variable":[{"description":{"content":"(Required) Product Id
\n","type":"text/plain"},"type":"any","value":"8","key":"product_id"}]}},"response":[{"id":"28539a09-6707-4bbb-8764-c0a5c189d145","name":"Product Rateplan collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/products/:product_id/product-rateplans?include=productRateplanCharge,chargeTier&status=published&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["products",":product_id","product-rateplans"],"query":[{"key":"include","value":"productRateplanCharge,chargeTier"},{"key":"status","value":"published"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"product_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 7,\n \"isSync\": true,\n \"name\": \"Name\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"product\": \"/v1/products/8\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"id\": 79,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ],\n \"recurringChargeAmount\": 6,\n \"recurringChargeQty\": 2,\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n]"},{"id":"08209b05-2b22-474f-bc8b-7502e495c592","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/products/:product_id/product-rateplans?include=productRateplanCharge,chargeTier&status=published&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["products",":product_id","product-rateplans"],"query":[{"key":"include","value":"productRateplanCharge,chargeTier"},{"key":"status","value":"published"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"product_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"29a6b962-7fa0-471e-bbfe-0bd371128bd3","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/products/:product_id/product-rateplans?include=productRateplanCharge,chargeTier&status=published&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["products",":product_id","product-rateplans"],"query":[{"key":"include","value":"productRateplanCharge,chargeTier"},{"key":"status","value":"published"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"product_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"693f8e92-632a-44e2-be1b-42ace09ba444"},{"name":"Get a Rate Plan","id":"8238dff7-7707-4f76-a76a-71a459f3c473","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get Product Rateplan by ID.
\n","urlObject":{"path":["product-rateplans",":product_rateplan_id"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"productRateplanCharge"}],"variable":[{"description":{"content":"(Required) Product Rateplan Id
\n","type":"text/plain"},"type":"any","value":"7","key":"product_rateplan_id"}]}},"response":[{"id":"20b8cd07-84db-46a6-9ab4-fab0f528f828","name":"Product Rateplan resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id?include=productRateplanCharge","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id"],"query":[{"key":"include","value":"productRateplanCharge"}],"variable":[{"key":"product_rateplan_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 7,\n \"isSync\": true,\n \"name\": \"Name\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"product\": \"/v1/products/8\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"id\": 79,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ],\n \"recurringChargeAmount\": 6,\n \"recurringChargeQty\": 2,\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n}"},{"id":"262cf376-193c-4b50-b664-b3098df5e584","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id?include=productRateplanCharge","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id"],"query":[{"key":"include","value":"productRateplanCharge"}],"variable":[{"key":"product_rateplan_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"d2a1ce49-7eb2-4201-809d-7e3e0da8263e","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id?include=productRateplanCharge","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id"],"query":[{"key":"include","value":"productRateplanCharge"}],"variable":[{"key":"product_rateplan_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"8238dff7-7707-4f76-a76a-71a459f3c473"},{"name":"Create a Rate Plan","id":"4024f7f7-0b58-4220-a02d-fcaedb0a91ee","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create Product Rateplan.
\n","urlObject":{"path":["product-rateplans"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"81fbc7d6-f7bd-4cdc-8b63-9b0ea9a65d2b","name":"A product rateplan was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"productId\": 8,\n \"name\": \"Name\",\n \"description\": \"Description\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"effectiveEndDate\": \"2022-10-11\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"currency\": \"usd\",\n \"endingUnit\": \"1\",\n \"price\": 299,\n \"priceFormat\": \"flatFee\",\n \"startingUnit\": \"1\",\n \"tier\": 121\n }\n ],\n \"chargeType\": \"recurring\",\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ]\n}"},"url":"{{host}}/{{version}}/product-rateplans"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 7,\n \"isSync\": true,\n \"name\": \"Name\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"product\": \"/v1/products/8\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"id\": 79,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ],\n \"recurringChargeAmount\": 6,\n \"recurringChargeQty\": 2,\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n}"},{"id":"fe820689-72a1-4810-a552-6345128ac667","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"productId\": 8,\n \"name\": \"Name\",\n \"description\": \"Description\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"effectiveEndDate\": \"2022-10-11\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"currency\": \"usd\",\n \"endingUnit\": \"1\",\n \"price\": 299,\n \"priceFormat\": \"flatFee\",\n \"startingUnit\": \"1\",\n \"tier\": 121\n }\n ],\n \"chargeType\": \"recurring\",\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ]\n}"},"url":"{{host}}/{{version}}/product-rateplans"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"61f17c66-fc3c-42a3-a402-58f2ffca128a","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"productId\": 8,\n \"name\": \"Name\",\n \"description\": \"Description\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"effectiveEndDate\": \"2022-10-11\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"currency\": \"usd\",\n \"endingUnit\": \"1\",\n \"price\": 299,\n \"priceFormat\": \"flatFee\",\n \"startingUnit\": \"1\",\n \"tier\": 121\n }\n ],\n \"chargeType\": \"recurring\",\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ]\n}"},"url":"{{host}}/{{version}}/product-rateplans"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"4024f7f7-0b58-4220-a02d-fcaedb0a91ee"},{"name":"Update a Rate Plan","id":"a9dbf648-472f-4832-a01c-c279841a1edf","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update product rateplan by ID.
\n","urlObject":{"path":["product-rateplans",":product_rateplan_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Product Rateplan Id
\n","type":"text/plain"},"type":"any","value":"7","key":"product_rateplan_id"}]}},"response":[{"id":"08631c03-2043-4fb8-bb82-87126de07f15","name":"A Product Rateplan updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Name\",\n \"description\": \"Description\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"effectiveEndDate\": \"2020-10-11\"\n}"},"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id"],"variable":[{"key":"product_rateplan_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 7,\n \"isSync\": true,\n \"name\": \"Name\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"product\": \"/v1/products/8\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"id\": 79,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ],\n \"recurringChargeAmount\": 6,\n \"recurringChargeQty\": 2,\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n}"},{"id":"589890b6-777d-4dd6-81d0-6ff1c0db1fd2","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Name\",\n \"description\": \"Description\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"effectiveEndDate\": \"2020-10-11\"\n}"},"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id"],"variable":[{"key":"product_rateplan_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"ad46220c-9102-42ee-95d0-25433ef6b789","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Name\",\n \"description\": \"Description\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"effectiveEndDate\": \"2020-10-11\"\n}"},"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id"],"variable":[{"key":"product_rateplan_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"7be8ce85-f515-49e4-bba9-e576c8fd4a30","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Name\",\n \"description\": \"Description\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"effectiveEndDate\": \"2020-10-11\"\n}"},"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id"],"variable":[{"key":"product_rateplan_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"a9dbf648-472f-4832-a01c-c279841a1edf"},{"name":"Delete a Rate Plan","id":"bf5738a7-b1f7-4f81-bff0-f41d5af968f9","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete product rateplan.
\n","urlObject":{"path":["product-rateplans",":product_rateplan_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Product Rateplan Id
\n","type":"text/plain"},"type":"any","value":"7","key":"product_rateplan_id"}]}},"response":[{"id":"50519c1e-5276-4d88-8798-c1cca588d19c","name":"Product Rateplan deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id"],"variable":[{"key":"product_rateplan_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"990ad1fc-6f04-4018-a1c1-7053d790ba20","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id"],"variable":[{"key":"product_rateplan_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"dbea5086-d303-45de-94ce-46d178307eab","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id"],"variable":[{"key":"product_rateplan_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"bf5738a7-b1f7-4f81-bff0-f41d5af968f9"},{"name":"Update a Rate Plan Status","id":"94d34bea-7875-4689-aeaa-5962deb0a90c","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update Product Rateplan status.
\n","urlObject":{"path":["product-rateplans",":product_rateplan_id","status"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Product Rateplan Id
\n","type":"text/plain"},"type":"any","value":"7","key":"product_rateplan_id"}]}},"response":[{"id":"264ba527-a841-42d9-9603-556697988c34","name":"Product Rateplan updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"published\"\n}"},"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id/status","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id","status"],"variable":[{"key":"product_rateplan_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 7,\n \"isSync\": true,\n \"name\": \"Name\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"product\": \"/v1/products/8\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"id\": 79,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ],\n \"recurringChargeAmount\": 6,\n \"recurringChargeQty\": 2,\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n}"},{"id":"f6bf1656-3c9d-43ef-9af9-39f1631206c8","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"published\"\n}"},"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id/status","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id","status"],"variable":[{"key":"product_rateplan_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"dc421553-fc6d-4fde-80d0-ea35862747aa","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"published\"\n}"},"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id/status","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id","status"],"variable":[{"key":"product_rateplan_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"94d34bea-7875-4689-aeaa-5962deb0a90c"},{"name":"Sync a Rate Plan","id":"c87c4c4d-e620-4eb8-9696-1b30d2e84f1a","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Sync Product Rateplan.
\n","urlObject":{"path":["product-rateplans",":product_rateplan_id","sync"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Product Rateplan Id
\n","type":"text/plain"},"type":"any","value":"7","key":"product_rateplan_id"}]}},"response":[{"id":"93422630-2b38-4439-87b7-93a5ec66547e","name":"Product Rateplan synced","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id/sync","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id","sync"],"variable":[{"key":"product_rateplan_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"91fe5acb-ca6e-4579-b52e-1b699008964f","name":"Resource not found","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id/sync","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id","sync"],"variable":[{"key":"product_rateplan_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"a7152042-5e47-4030-885c-099ac44bc666","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id/sync","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id","sync"],"variable":[{"key":"product_rateplan_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"c87c4c4d-e620-4eb8-9696-1b30d2e84f1a"},{"name":"Get External Product Rate Plans","id":"51d64475-617b-4567-8eb2-81bb8cb9bc28","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get a External Products Rateplan Charge collection.
\n","urlObject":{"path":["product-rateplans",":product_rateplan_id","external-products"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Product Rateplan Id
\n","type":"text/plain"},"type":"any","value":"7","key":"product_rateplan_id"}]}},"response":[{"id":"0bdef5d8-1408-4f17-b5dc-2c5bd3743ea1","name":"External Products Rateplan Charge collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id/external-products","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id","external-products"],"variable":[{"key":"product_rateplan_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Shopify\",\n \"id\": 7,\n \"status\": \"pending\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalId\": \"1\",\n \"externalName\": \"Name of the external\",\n \"externalProduct\": {\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Shopify\",\n \"id\": 7,\n \"status\": \"pending\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalId\": \"53550\",\n \"productId\": 47\n },\n \"externalSku\": \"SKU-CODE\",\n \"externalUrl\": \"string\",\n \"id\": 1,\n \"productRateplanCharge\": {\n \"id\": 79,\n \"name\": \"Name\"\n }\n }\n]"},{"id":"ee59401e-9ef9-4177-b8c9-f4faebb22afd","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id/external-products","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id","external-products"],"variable":[{"key":"product_rateplan_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"808155ab-b52c-4369-9b93-7063efce0f5a","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id/external-products","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id","external-products"],"variable":[{"key":"product_rateplan_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"51d64475-617b-4567-8eb2-81bb8cb9bc28"},{"name":"Create an External Product Rate Plan","id":"9b0a0a28-dcab-43e4-8820-1186b2844117","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create External Products Rateplan Charge.
\n","urlObject":{"path":["product-rateplans","external-products"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"550305e1-0119-462f-a861-609e4386a2d0","name":"A external product rateplan charge was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyIntegrationId\": 7,\n \"externalId\": \"1\",\n \"externalProductId\": 68,\n \"externalName\": \"Name of the external\",\n \"externalSku\": \"SKU-CODE\",\n \"externalUrl\": \"string\",\n \"productRatePlanChargeId\": 79\n}"},"url":"{{host}}/{{version}}/product-rateplans/external-products"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Shopify\",\n \"id\": 7,\n \"status\": \"pending\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalId\": \"1\",\n \"externalName\": \"Name of the external\",\n \"externalProduct\": {\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Shopify\",\n \"id\": 7,\n \"status\": \"pending\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalId\": \"53550\",\n \"productId\": 47\n },\n \"externalSku\": \"SKU-CODE\",\n \"externalUrl\": \"string\",\n \"id\": 1,\n \"productRateplanCharge\": {\n \"id\": 79,\n \"name\": \"Name\"\n }\n}"},{"id":"795839ce-0497-467e-aeeb-97aa0ee1a002","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyIntegrationId\": 7,\n \"externalId\": \"1\",\n \"externalProductId\": 68,\n \"externalName\": \"Name of the external\",\n \"externalSku\": \"SKU-CODE\",\n \"externalUrl\": \"string\",\n \"productRatePlanChargeId\": 79\n}"},"url":"{{host}}/{{version}}/product-rateplans/external-products"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"56603de7-5161-4d84-bdf8-293107271b66","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyIntegrationId\": 7,\n \"externalId\": \"1\",\n \"externalProductId\": 68,\n \"externalName\": \"Name of the external\",\n \"externalSku\": \"SKU-CODE\",\n \"externalUrl\": \"string\",\n \"productRatePlanChargeId\": 79\n}"},"url":"{{host}}/{{version}}/product-rateplans/external-products"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"9b0a0a28-dcab-43e4-8820-1186b2844117"},{"name":"Delete an External Product Rate Plan","id":"f008ebe7-6288-42e1-899d-817579126a4a","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete external products rateplan charge.
\n","urlObject":{"path":["product-rateplans","external-products",":external_product_rateplan_charge_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) External Products Rateplan Charge Id
\n","type":"text/plain"},"type":"any","value":"1","key":"external_product_rateplan_charge_id"}]}},"response":[{"id":"99b84ed2-b13d-4e74-bce4-fa73c67cc9c9","name":"External Products Rateplan Charge.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/external-products/:external_product_rateplan_charge_id","host":["{{host}}/{{version}}"],"path":["product-rateplans","external-products",":external_product_rateplan_charge_id"],"variable":[{"key":"external_product_rateplan_charge_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"48bc9a3f-4c16-4f7a-953e-07969e4225af","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/external-products/:external_product_rateplan_charge_id","host":["{{host}}/{{version}}"],"path":["product-rateplans","external-products",":external_product_rateplan_charge_id"],"variable":[{"key":"external_product_rateplan_charge_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"204f960d-9814-42e2-ad1d-b3959d7f16c4","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/external-products/:external_product_rateplan_charge_id","host":["{{host}}/{{version}}"],"path":["product-rateplans","external-products",":external_product_rateplan_charge_id"],"variable":[{"key":"external_product_rateplan_charge_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"f008ebe7-6288-42e1-899d-817579126a4a"}],"id":"bc3ca0df-1e9f-44ea-9f12-9c55f1e87e40","description":"A rate plan represents a collection of charges that your customers may incur when buying your product and decides how a product is priced and invoiced. When a customer purchases a product, they can pick from one of the available rate plans. A product rate plan can contain one or more charges.
\nGet product rateplan charge collection.
\n","urlObject":{"path":["product-rateplans",":product_rateplan_id","product-rateplan-charges"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"chargeTier,externalProduct"},{"disabled":true,"description":{"content":"Order by
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"Sort by
\n","type":"text/plain"},"key":"sortBy","value":"asc"}],"variable":[{"description":{"content":"(Required) Product Rateplan Id
\n","type":"text/plain"},"type":"any","value":"7","key":"product_rateplan_id"}]}},"response":[{"id":"4bf3a09f-ec97-4c40-9fbf-87236a308030","name":"Product Rateplan Charge collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id/product-rateplan-charges?include=chargeTier,externalProduct&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id","product-rateplan-charges"],"query":[{"key":"include","value":"chargeTier,externalProduct"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"product_rateplan_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description\",\n \"externalProduct\": [\n {\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Shopify\",\n \"id\": 7,\n \"status\": \"pending\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalId\": \"1\",\n \"externalName\": \"Name of the external\",\n \"externalProduct\": {\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Shopify\",\n \"id\": 7,\n \"status\": \"pending\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalId\": \"53550\",\n \"productId\": 47\n },\n \"externalSku\": \"SKU-CODE\",\n \"externalUrl\": \"string\",\n \"id\": 1,\n \"productRateplanCharge\": {\n \"id\": 79,\n \"name\": \"Name\"\n }\n }\n ],\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": \"1.0000\",\n \"id\": 88,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n]"},{"id":"fb39c212-b41b-4c41-8b6c-c63fe9ea24ff","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplans/:product_rateplan_id/product-rateplan-charges?include=chargeTier,externalProduct&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["product-rateplans",":product_rateplan_id","product-rateplan-charges"],"query":[{"key":"include","value":"chargeTier,externalProduct"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"product_rateplan_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"d21c83cb-a5ba-4da6-ad95-eb97790be219"},{"name":"Get a Rate Plan Charge","id":"e047951d-ef4e-40f1-9d14-05a3151a2be2","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get product rateplan charge by ID.
\n","urlObject":{"path":["product-rateplan-charges",":product_rateplan_charge_id"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"chargeTier"}],"variable":[{"description":{"content":"(Required) Product Rateplan Charge Id
\n","type":"text/plain"},"type":"any","value":"88","key":"product_rateplan_charge_id"}]}},"response":[{"id":"9734c25d-2e1e-4f05-99e6-2264f3fa79a7","name":"Product Rateplan Charge resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplan-charges/:product_rateplan_charge_id?include=chargeTier","host":["{{host}}/{{version}}"],"path":["product-rateplan-charges",":product_rateplan_charge_id"],"query":[{"key":"include","value":"chargeTier"}],"variable":[{"key":"product_rateplan_charge_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"billCycleDay\": null,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description\",\n \"externalProduct\": [\n {\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Shopify\",\n \"id\": 7,\n \"status\": \"pending\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalId\": \"1\",\n \"externalName\": \"Name of the external\",\n \"externalProduct\": {\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Shopify\",\n \"id\": 7,\n \"status\": \"pending\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalId\": \"53550\",\n \"productId\": 47\n },\n \"externalSku\": \"SKU-CODE\",\n \"externalUrl\": \"string\",\n \"id\": 1,\n \"productRateplanCharge\": {\n \"id\": 79,\n \"name\": \"Name\"\n }\n }\n ],\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": \"1.0000\",\n \"id\": 88,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n}"},{"id":"f0533313-e239-458e-b43c-a51f8d58d0bf","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplan-charges/:product_rateplan_charge_id?include=chargeTier","host":["{{host}}/{{version}}"],"path":["product-rateplan-charges",":product_rateplan_charge_id"],"query":[{"key":"include","value":"chargeTier"}],"variable":[{"key":"product_rateplan_charge_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"0e425492-2610-4716-8df1-588e6eaed565","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplan-charges/:product_rateplan_charge_id?include=chargeTier","host":["{{host}}/{{version}}"],"path":["product-rateplan-charges",":product_rateplan_charge_id"],"query":[{"key":"include","value":"chargeTier"}],"variable":[{"key":"product_rateplan_charge_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"e047951d-ef4e-40f1-9d14-05a3151a2be2"},{"name":"Create a Rate Plan Charge","id":"cdde13d3-fc06-4fb7-9f9f-8e6321e0ce90","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create Product Rateplan Charge.
\n","urlObject":{"path":["product-rateplan-charges"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"598fb30a-623a-459a-9e56-407bb801e987","name":"A product rateplan charge was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"ratePlanId\": 151,\n \"billCycleDay\": null,\n \"billingTiming\": \"inAdvance\",\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriod\": null,\n \"priceIncreasePercentage\": null,\n \"specificBillingPeriod\": 1,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": false,\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": null,\n \"weight\": 150,\n \"width\": 100,\n \"height\": 100,\n \"depth\": 100,\n \"isFreeShipping\": true,\n \"fixedShippingPrice\": 2000,\n \"shippingGroup\": \"shippGrop1\",\n \"originLocation\": \"origin1\",\n \"dimensionalRule\": \"rule1\",\n \"chargeTier\": [\n {\n \"currency\": \"USD\",\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"price\": 15,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":"{{host}}/{{version}}/product-rateplan-charges"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"billCycleDay\": null,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"depth\": \"1.0000\",\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": \"1.0000\",\n \"id\": 88,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n}"},{"id":"694e690f-0d9b-444c-94fe-31ce5c3cf9a2","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"ratePlanId\": 151,\n \"billCycleDay\": null,\n \"billingTiming\": \"inAdvance\",\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriod\": null,\n \"priceIncreasePercentage\": null,\n \"specificBillingPeriod\": 1,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": false,\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": null,\n \"weight\": 150,\n \"width\": 100,\n \"height\": 100,\n \"depth\": 100,\n \"isFreeShipping\": true,\n \"fixedShippingPrice\": 2000,\n \"shippingGroup\": \"shippGrop1\",\n \"originLocation\": \"origin1\",\n \"dimensionalRule\": \"rule1\",\n \"chargeTier\": [\n {\n \"currency\": \"USD\",\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"price\": 15,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":"{{host}}/{{version}}/product-rateplan-charges"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"1a1f5eba-f9bd-4211-9673-8aa973f1bae1","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"ratePlanId\": 151,\n \"billCycleDay\": null,\n \"billingTiming\": \"inAdvance\",\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriod\": null,\n \"priceIncreasePercentage\": null,\n \"specificBillingPeriod\": 1,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": false,\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": null,\n \"weight\": 150,\n \"width\": 100,\n \"height\": 100,\n \"depth\": 100,\n \"isFreeShipping\": true,\n \"fixedShippingPrice\": 2000,\n \"shippingGroup\": \"shippGrop1\",\n \"originLocation\": \"origin1\",\n \"dimensionalRule\": \"rule1\",\n \"chargeTier\": [\n {\n \"currency\": \"USD\",\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"price\": 15,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":"{{host}}/{{version}}/product-rateplan-charges"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"cdde13d3-fc06-4fb7-9f9f-8e6321e0ce90"},{"name":"Update a Rate Plan Charges","id":"40db5f38-6e45-452a-b70f-23e2e715ad2c","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update product rateplan charge by ID.
\n","urlObject":{"path":["product-rateplan-charges",":product_rateplan_charge_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Product Rateplan Charge Id
\n","type":"text/plain"},"type":"any","value":"88","key":"product_rateplan_charge_id"}]}},"response":[{"id":"db24fbe2-2c4b-4874-967e-c3f169d8debb","name":"A Product Rateplan Charge updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billCycleDay\": null,\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"billCycleType\": \"defaultFromCustomer\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeType\": \"recurring\",\n \"taxable\": false,\n \"weight\": 150,\n \"endDateCondition\": \"subscriptionEnd\",\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"category\": \"physical\",\n \"specificBillingPeriod\": 1,\n \"name\": \"Name\",\n \"weeklyBillCycleDay\": null,\n \"chargeTier\": [\n {\n \"currency\": \"USD\",\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"price\": 15,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/product-rateplan-charges/:product_rateplan_charge_id","host":["{{host}}/{{version}}"],"path":["product-rateplan-charges",":product_rateplan_charge_id"],"variable":[{"key":"product_rateplan_charge_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"billCycleDay\": null,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"depth\": \"1.0000\",\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": \"1.0000\",\n \"id\": 88,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n}"},{"id":"dcea6066-d055-41aa-a577-faf44e2e586f","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billCycleDay\": null,\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"billCycleType\": \"defaultFromCustomer\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeType\": \"recurring\",\n \"taxable\": false,\n \"weight\": 150,\n \"endDateCondition\": \"subscriptionEnd\",\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"category\": \"physical\",\n \"specificBillingPeriod\": 1,\n \"name\": \"Name\",\n \"weeklyBillCycleDay\": null,\n \"chargeTier\": [\n {\n \"currency\": \"USD\",\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"price\": 15,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/product-rateplan-charges/:product_rateplan_charge_id","host":["{{host}}/{{version}}"],"path":["product-rateplan-charges",":product_rateplan_charge_id"],"variable":[{"key":"product_rateplan_charge_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"d20980cb-6ccd-4b28-a4b8-c5388a4aa93b","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billCycleDay\": null,\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"billCycleType\": \"defaultFromCustomer\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeType\": \"recurring\",\n \"taxable\": false,\n \"weight\": 150,\n \"endDateCondition\": \"subscriptionEnd\",\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"category\": \"physical\",\n \"specificBillingPeriod\": 1,\n \"name\": \"Name\",\n \"weeklyBillCycleDay\": null,\n \"chargeTier\": [\n {\n \"currency\": \"USD\",\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"price\": 15,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/product-rateplan-charges/:product_rateplan_charge_id","host":["{{host}}/{{version}}"],"path":["product-rateplan-charges",":product_rateplan_charge_id"],"variable":[{"key":"product_rateplan_charge_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"d57d4af8-0dbe-486d-941b-7fa484d3aa87","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billCycleDay\": null,\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"billCycleType\": \"defaultFromCustomer\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeType\": \"recurring\",\n \"taxable\": false,\n \"weight\": 150,\n \"endDateCondition\": \"subscriptionEnd\",\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"category\": \"physical\",\n \"specificBillingPeriod\": 1,\n \"name\": \"Name\",\n \"weeklyBillCycleDay\": null,\n \"chargeTier\": [\n {\n \"currency\": \"USD\",\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"price\": 15,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/product-rateplan-charges/:product_rateplan_charge_id","host":["{{host}}/{{version}}"],"path":["product-rateplan-charges",":product_rateplan_charge_id"],"variable":[{"key":"product_rateplan_charge_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"40db5f38-6e45-452a-b70f-23e2e715ad2c"},{"name":"Delete a Rate Plan Charges","id":"2e2cc4eb-98d1-4320-b02a-ee6ebbac06ee","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete product rateplan charge.
\n","urlObject":{"path":["product-rateplan-charges",":product_rateplan_charge_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Product Rateplan Charge Id
\n","type":"text/plain"},"type":"any","value":"88","key":"product_rateplan_charge_id"}]}},"response":[{"id":"6873e2c2-344e-44dd-b3e5-f6d004002dd7","name":"Product Rateplan Charge deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplan-charges/:product_rateplan_charge_id","host":["{{host}}/{{version}}"],"path":["product-rateplan-charges",":product_rateplan_charge_id"],"variable":[{"key":"product_rateplan_charge_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"fbb414f7-6504-4008-84ba-517a8ba7fb24","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplan-charges/:product_rateplan_charge_id","host":["{{host}}/{{version}}"],"path":["product-rateplan-charges",":product_rateplan_charge_id"],"variable":[{"key":"product_rateplan_charge_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"cf417d96-403f-4414-85dc-4b72b983bb5a","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/product-rateplan-charges/:product_rateplan_charge_id","host":["{{host}}/{{version}}"],"path":["product-rateplan-charges",":product_rateplan_charge_id"],"variable":[{"key":"product_rateplan_charge_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"2e2cc4eb-98d1-4320-b02a-ee6ebbac06ee"}],"id":"de5f53dc-c699-47f0-b754-e1ce8d0a8da2","description":"Product rate plan charges are the fees that you charge your customer when they sign up for your product. They also include the rules surrounding those fees. Each rate plan can include any number of charges.
\nGet Product collection.
\n","urlObject":{"path":["products"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"productRateplanCharge,externalProduct,externalInterval,salesChannels"},{"disabled":true,"description":{"content":"Order by
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"Sort by
\n","type":"text/plain"},"key":"sortBy","value":"asc"},{"disabled":true,"description":{"content":"Filter ID
\n","type":"text/plain"},"key":"filterId","value":"23"}],"variable":[]}},"response":[{"id":"74206f7b-cd43-4682-8a1e-533c14f7efb5","name":"Product collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/products?include=productRateplanCharge,externalProduct,externalInterval,salesChannels&orderBy=id&sortBy=asc&filterId=23","host":["{{host}}/{{version}}"],"path":["products"],"query":[{"key":"include","value":"productRateplanCharge,externalProduct,externalInterval,salesChannels"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"},{"key":"filterId","value":"23"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"category\": \"physical\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"This is a product description.\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 8,\n \"internalProductId\": null,\n \"name\": \"Product name\",\n \"sku\": \"P-2\",\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"externalProduct\": [\n {\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Shopify\",\n \"id\": 7,\n \"status\": \"pending\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalId\": \"22\",\n \"productId\": 63057475,\n \"externalInterval\": [\n {\n \"id\": 5,\n \"optionId\": 420,\n \"optionValue\": 875,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"status\": \"active\"\n }\n ]\n }\n ],\n \"productRateplan\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 7,\n \"isSync\": true,\n \"name\": \"Name\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"product\": \"/v1/products/8\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"id\": 79,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ],\n \"recurringChargeAmount\": 6,\n \"recurringChargeQty\": 2,\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n ],\n \"salesChannels\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"name\": \"Bigcommerce\",\n \"type\": \"ecommerce\",\n \"status\": \"active\"\n }\n ]\n }\n]"},{"id":"f4d524f5-89e5-4f0b-948b-a35e57d5a537","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/products?include=productRateplanCharge,externalProduct,externalInterval,salesChannels&orderBy=id&sortBy=asc&filterId=23","host":["{{host}}/{{version}}"],"path":["products"],"query":[{"key":"include","value":"productRateplanCharge,externalProduct,externalInterval,salesChannels"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"},{"key":"filterId","value":"23"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"242f7f0e-8716-4ae0-bb22-f21baab399d6"},{"name":"Get a Product","id":"ee86aa53-e2ba-4b9c-bf9b-df0b7c0ebcf1","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get product by ID.
\n","urlObject":{"path":["products",":product_id"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"productRateplanCharge,externalProduct,externalInterval,salesChannels"}],"variable":[{"description":{"content":"(Required) Product Id
\n","type":"text/plain"},"type":"any","value":"8","key":"product_id"}]}},"response":[{"id":"a06513f7-910e-4778-9017-6e4e702e7303","name":"Product resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/products/:product_id?include=productRateplanCharge,externalProduct,externalInterval,salesChannels","host":["{{host}}/{{version}}"],"path":["products",":product_id"],"query":[{"key":"include","value":"productRateplanCharge,externalProduct,externalInterval,salesChannels"}],"variable":[{"key":"product_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"category\": \"physical\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"This is a product description.\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 8,\n \"internalProductId\": null,\n \"name\": \"Product name\",\n \"sku\": \"P-2\",\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"externalProduct\": [\n {\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Shopify\",\n \"id\": 7,\n \"status\": \"pending\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalId\": \"22\",\n \"productId\": -9203509,\n \"externalInterval\": [\n {\n \"id\": 5,\n \"optionId\": 420,\n \"optionValue\": 875,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"status\": \"active\"\n }\n ]\n }\n ],\n \"productRateplan\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 7,\n \"isSync\": true,\n \"name\": \"Name\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"product\": \"/v1/products/8\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"id\": 79,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ],\n \"recurringChargeAmount\": 6,\n \"recurringChargeQty\": 2,\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n ],\n \"salesChannels\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"name\": \"Bigcommerce\",\n \"type\": \"ecommerce\",\n \"status\": \"active\"\n }\n ]\n}"},{"id":"525e16ac-7171-4931-a84a-4eb8aeb9978c","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/products/:product_id?include=productRateplanCharge,externalProduct,externalInterval,salesChannels","host":["{{host}}/{{version}}"],"path":["products",":product_id"],"query":[{"key":"include","value":"productRateplanCharge,externalProduct,externalInterval,salesChannels"}],"variable":[{"key":"product_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"6c5e2474-05b9-4acd-b236-42db401c12e8","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/products/:product_id?include=productRateplanCharge,externalProduct,externalInterval,salesChannels","host":["{{host}}/{{version}}"],"path":["products",":product_id"],"query":[{"key":"include","value":"productRateplanCharge,externalProduct,externalInterval,salesChannels"}],"variable":[{"key":"product_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"ee86aa53-e2ba-4b9c-bf9b-df0b7c0ebcf1"},{"name":"Create a Product","id":"4bc90441-a2fc-41e5-9a00-1f09247cbd30","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create product.
\n","urlObject":{"path":["products"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"31eb930e-572f-4ae7-9dee-abbbd17fbda5","name":"A product was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Product name\",\n \"description\": \"This is a test product\",\n \"sku\": \"P-1\",\n \"category\": \"base products\",\n \"effectiveStartDate\": \"2020-09-07\",\n \"effectiveEndDate\": \"2020-09-08\",\n \"productRatePlan\": [\n {\n \"name\": \"Name\",\n \"description\": \"Description\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"productRatePlanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"price\": 15,\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": 1\n }\n ],\n \"chargeType\": \"recurring\",\n \"category\": \"physical\",\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriod\": null,\n \"priceIncreasePercentage\": null,\n \"specificBillingPeriod\": 1,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": false,\n \"upToPeriods\": null,\n \"upToPeriodsType\": null,\n \"weeklyBillCycleDay\": null,\n \"weight\": 100,\n \"width\": null,\n \"height\": null,\n \"depth\": null,\n \"isFreeShipping\": true,\n \"fixedShippingPrice\": 2000,\n \"shippingGroup\": \"shippGrop1\",\n \"originLocation\": \"origin1\"\n }\n ]\n }\n ]\n}"},"url":"{{host}}/{{version}}/products"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"category\": \"base products\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"This is a product description.\",\n \"effectiveEndDate\": \"2021-10-11\",\n \"effectiveStartDate\": \"2021-10-08\",\n \"id\": 8,\n \"internalProductId\": null,\n \"name\": \"Product name\",\n \"productRateplan\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 7,\n \"isSync\": true,\n \"name\": \"Name\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"product\": \"/v1/products/8\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"id\": 79,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ],\n \"recurringChargeAmount\": 6,\n \"recurringChargeQty\": 2,\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n ],\n \"sku\": \"P-1\",\n \"status\": \"draft\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"6998f896-edd3-4f6f-bdf0-98adcc08988c","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Product name\",\n \"description\": \"This is a test product\",\n \"sku\": \"P-1\",\n \"category\": \"base products\",\n \"effectiveStartDate\": \"2020-09-07\",\n \"effectiveEndDate\": \"2020-09-08\",\n \"productRatePlan\": [\n {\n \"name\": \"Name\",\n \"description\": \"Description\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"productRatePlanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"price\": 15,\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": 1\n }\n ],\n \"chargeType\": \"recurring\",\n \"category\": \"physical\",\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriod\": null,\n \"priceIncreasePercentage\": null,\n \"specificBillingPeriod\": 1,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": false,\n \"upToPeriods\": null,\n \"upToPeriodsType\": null,\n \"weeklyBillCycleDay\": null,\n \"weight\": 100,\n \"width\": null,\n \"height\": null,\n \"depth\": null,\n \"isFreeShipping\": true,\n \"fixedShippingPrice\": 2000,\n \"shippingGroup\": \"shippGrop1\",\n \"originLocation\": \"origin1\"\n }\n ]\n }\n ]\n}"},"url":"{{host}}/{{version}}/products"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"b0b4538c-9239-4028-abe1-d5d83dd92c77","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Product name\",\n \"description\": \"This is a test product\",\n \"sku\": \"P-1\",\n \"category\": \"base products\",\n \"effectiveStartDate\": \"2020-09-07\",\n \"effectiveEndDate\": \"2020-09-08\",\n \"productRatePlan\": [\n {\n \"name\": \"Name\",\n \"description\": \"Description\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"productRatePlanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"price\": 15,\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": 1\n }\n ],\n \"chargeType\": \"recurring\",\n \"category\": \"physical\",\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriod\": null,\n \"priceIncreasePercentage\": null,\n \"specificBillingPeriod\": 1,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": false,\n \"upToPeriods\": null,\n \"upToPeriodsType\": null,\n \"weeklyBillCycleDay\": null,\n \"weight\": 100,\n \"width\": null,\n \"height\": null,\n \"depth\": null,\n \"isFreeShipping\": true,\n \"fixedShippingPrice\": 2000,\n \"shippingGroup\": \"shippGrop1\",\n \"originLocation\": \"origin1\"\n }\n ]\n }\n ]\n}"},"url":"{{host}}/{{version}}/products"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"4bc90441-a2fc-41e5-9a00-1f09247cbd30"},{"name":"Update a Product","id":"f0516f36-4aa4-4d7a-907b-c28f28487526","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update product by ID.
\n","urlObject":{"path":["products",":product_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Product Id
\n","type":"text/plain"},"type":"any","value":"8","key":"product_id"}]}},"response":[{"id":"ce174166-ccb4-42fc-a35f-f6bfea5c14e3","name":"A Product updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Product name\",\n \"description\": \"This is a test product\",\n \"sku\": \"P-1\",\n \"category\": \"base products\",\n \"effectiveStartDate\": \"2021-10-08\",\n \"effectiveEndDate\": \"2021-10-11\"\n}"},"url":{"raw":"{{host}}/{{version}}/products/:product_id","host":["{{host}}/{{version}}"],"path":["products",":product_id"],"variable":[{"key":"product_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"category\": \"base products\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"This is a product description.\",\n \"effectiveEndDate\": \"2021-10-11\",\n \"effectiveStartDate\": \"2021-10-08\",\n \"id\": 8,\n \"internalProductId\": null,\n \"name\": \"Product name\",\n \"productRateplan\": \"/v1/products/8/product-rateplans/7\",\n \"sku\": \"P-1\",\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"c9c0e255-c58c-4d1b-b9fb-d2d402222338","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Product name\",\n \"description\": \"This is a test product\",\n \"sku\": \"P-1\",\n \"category\": \"base products\",\n \"effectiveStartDate\": \"2021-10-08\",\n \"effectiveEndDate\": \"2021-10-11\"\n}"},"url":{"raw":"{{host}}/{{version}}/products/:product_id","host":["{{host}}/{{version}}"],"path":["products",":product_id"],"variable":[{"key":"product_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"381d83af-2958-4154-b109-0dd1ef5229cb","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Product name\",\n \"description\": \"This is a test product\",\n \"sku\": \"P-1\",\n \"category\": \"base products\",\n \"effectiveStartDate\": \"2021-10-08\",\n \"effectiveEndDate\": \"2021-10-11\"\n}"},"url":{"raw":"{{host}}/{{version}}/products/:product_id","host":["{{host}}/{{version}}"],"path":["products",":product_id"],"variable":[{"key":"product_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"fff8e69c-548b-4e52-9667-c354ecb686b4","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Product name\",\n \"description\": \"This is a test product\",\n \"sku\": \"P-1\",\n \"category\": \"base products\",\n \"effectiveStartDate\": \"2021-10-08\",\n \"effectiveEndDate\": \"2021-10-11\"\n}"},"url":{"raw":"{{host}}/{{version}}/products/:product_id","host":["{{host}}/{{version}}"],"path":["products",":product_id"],"variable":[{"key":"product_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"f0516f36-4aa4-4d7a-907b-c28f28487526"},{"name":"Delete a Product","id":"a340e807-75ac-4054-90ed-fd291a580f18","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete product.
\n","urlObject":{"path":["products",":product_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Product Id
\n","type":"text/plain"},"type":"any","value":"8","key":"product_id"}]}},"response":[{"id":"2e8d1ec5-2286-4418-aa2e-4e90c52e985a","name":"Product deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/products/:product_id","host":["{{host}}/{{version}}"],"path":["products",":product_id"],"variable":[{"key":"product_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"270a0f2b-5a21-49c3-8f82-ee55a5a210d5","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/products/:product_id","host":["{{host}}/{{version}}"],"path":["products",":product_id"],"variable":[{"key":"product_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"e7aad180-8afa-492f-8bbd-e741e8069128","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/products/:product_id","host":["{{host}}/{{version}}"],"path":["products",":product_id"],"variable":[{"key":"product_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"a340e807-75ac-4054-90ed-fd291a580f18"},{"name":"Update a Product Status","id":"e00521e7-dde5-470c-ac1f-7b653669df6a","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update product.
\n","urlObject":{"path":["products",":product_id","status"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Product Id
\n","type":"text/plain"},"type":"any","value":"8","key":"product_id"}]}},"response":[{"id":"bab9ef92-fcd7-4f68-9180-281d3d63f114","name":"A Product updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"published\"\n}"},"url":{"raw":"{{host}}/{{version}}/products/:product_id/status","host":["{{host}}/{{version}}"],"path":["products",":product_id","status"],"variable":[{"key":"product_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"category\": \"base products\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"This is a product description.\",\n \"effectiveEndDate\": \"2021-10-11\",\n \"effectiveStartDate\": \"2021-10-08\",\n \"id\": 8,\n \"internalProductId\": null,\n \"name\": \"Product name\",\n \"productRateplan\": \"/v1/products/8/product-rateplans/7\",\n \"sku\": \"P-1\",\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"fd7c157e-a760-4ede-be78-3ac1379136a2","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"published\"\n}"},"url":{"raw":"{{host}}/{{version}}/products/:product_id/status","host":["{{host}}/{{version}}"],"path":["products",":product_id","status"],"variable":[{"key":"product_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Valid status: active, requestPayment, paused, archived.\"\n}"},{"id":"8cc117da-27d8-4119-9836-3ed26d5c8e4a","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"published\"\n}"},"url":{"raw":"{{host}}/{{version}}/products/:product_id/status","host":["{{host}}/{{version}}"],"path":["products",":product_id","status"],"variable":[{"key":"product_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"233b7865-5bac-42ae-91b6-f74819313c33","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"published\"\n}"},"url":{"raw":"{{host}}/{{version}}/products/:product_id/status","host":["{{host}}/{{version}}"],"path":["products",":product_id","status"],"variable":[{"key":"product_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"e00521e7-dde5-470c-ac1f-7b653669df6a"},{"name":"Create an External Product","id":"e1ed4a2c-0229-4b2f-92b1-e9cde276fbd2","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create an External Product.
\n","urlObject":{"path":["products",":product_id","external-products"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Product Id
\n","type":"text/plain"},"type":"any","value":"8","key":"product_id"}]}},"response":[{"id":"448115a6-3e17-4e89-a561-4f535c785aac","name":"An External Product was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyIntegrationId\": 8,\n \"productId\": \"35\",\n \"settings\": {\n \"id\": 21422,\n \"image\": \"www.images.com 2\",\n \"name\": \"Product from BC 2\",\n \"options\": [\n {\n \"displayName\": \"Insurance 2\",\n \"values\": [\n \"Yes 2\",\n \"No 2\"\n ]\n },\n {\n \"displayName\": \"Subscription 2\",\n \"values\": [\n \"One time 2\",\n \"1 month 2\",\n \"2 months 2\"\n ]\n }\n ],\n \"price\": \"25\",\n \"sku\": \"PROD-TEST\",\n \"modifierDisplayName\": \"Link\"\n }\n}"},"url":{"raw":"{{host}}/{{version}}/products/:product_id/external-products","host":["{{host}}/{{version}}"],"path":["products",":product_id","external-products"],"variable":[{"key":"product_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"category\": \"physical\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"This is a product description.\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"externalProduct\": [\n {\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalId\": \"22\",\n \"productId\": -10216620\n }\n ],\n \"id\": 8,\n \"internalProductId\": null,\n \"name\": \"Product name\",\n \"sku\": \"P-2\",\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"d1ea29ef-c1de-4417-93e0-57d9dae68d23","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyIntegrationId\": 8,\n \"productId\": \"35\",\n \"settings\": {\n \"id\": 21422,\n \"image\": \"www.images.com 2\",\n \"name\": \"Product from BC 2\",\n \"options\": [\n {\n \"displayName\": \"Insurance 2\",\n \"values\": [\n \"Yes 2\",\n \"No 2\"\n ]\n },\n {\n \"displayName\": \"Subscription 2\",\n \"values\": [\n \"One time 2\",\n \"1 month 2\",\n \"2 months 2\"\n ]\n }\n ],\n \"price\": \"25\",\n \"sku\": \"PROD-TEST\",\n \"modifierDisplayName\": \"Link\"\n }\n}"},"url":{"raw":"{{host}}/{{version}}/products/:product_id/external-products","host":["{{host}}/{{version}}"],"path":["products",":product_id","external-products"],"variable":[{"key":"product_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"5fffbfb3-8084-4a8e-afe5-40f66af1585b","name":"Resource not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyIntegrationId\": 8,\n \"productId\": \"35\",\n \"settings\": {\n \"id\": 21422,\n \"image\": \"www.images.com 2\",\n \"name\": \"Product from BC 2\",\n \"options\": [\n {\n \"displayName\": \"Insurance 2\",\n \"values\": [\n \"Yes 2\",\n \"No 2\"\n ]\n },\n {\n \"displayName\": \"Subscription 2\",\n \"values\": [\n \"One time 2\",\n \"1 month 2\",\n \"2 months 2\"\n ]\n }\n ],\n \"price\": \"25\",\n \"sku\": \"PROD-TEST\",\n \"modifierDisplayName\": \"Link\"\n }\n}"},"url":{"raw":"{{host}}/{{version}}/products/:product_id/external-products","host":["{{host}}/{{version}}"],"path":["products",":product_id","external-products"],"variable":[{"key":"product_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"dfad4800-07e4-4d2c-81d9-ad002ccac10d","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyIntegrationId\": 8,\n \"productId\": \"35\",\n \"settings\": {\n \"id\": 21422,\n \"image\": \"www.images.com 2\",\n \"name\": \"Product from BC 2\",\n \"options\": [\n {\n \"displayName\": \"Insurance 2\",\n \"values\": [\n \"Yes 2\",\n \"No 2\"\n ]\n },\n {\n \"displayName\": \"Subscription 2\",\n \"values\": [\n \"One time 2\",\n \"1 month 2\",\n \"2 months 2\"\n ]\n }\n ],\n \"price\": \"25\",\n \"sku\": \"PROD-TEST\",\n \"modifierDisplayName\": \"Link\"\n }\n}"},"url":{"raw":"{{host}}/{{version}}/products/:product_id/external-products","host":["{{host}}/{{version}}"],"path":["products",":product_id","external-products"],"variable":[{"key":"product_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"e1ed4a2c-0229-4b2f-92b1-e9cde276fbd2"},{"name":"Delete an External Product","id":"ddc686e5-6cc2-4658-96d2-c17a26af7fd4","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete an External Product.
\n","urlObject":{"path":["products",":product_id","external-products",":external_product_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Product Id
\n","type":"text/plain"},"type":"any","value":"8","key":"product_id"},{"description":{"content":"(Required) Product Id
\n","type":"text/plain"},"type":"any","value":"22","key":"external_product_id"}]}},"response":[{"id":"b2efe47a-bbdb-43c8-a2a7-10dba9e8527c","name":"External Product deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/products/:product_id/external-products/:external_product_id","host":["{{host}}/{{version}}"],"path":["products",":product_id","external-products",":external_product_id"],"variable":[{"key":"product_id"},{"key":"external_product_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"3bddd0f5-174c-4134-bb5f-203db3942fd9","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/products/:product_id/external-products/:external_product_id","host":["{{host}}/{{version}}"],"path":["products",":product_id","external-products",":external_product_id"],"variable":[{"key":"product_id"},{"key":"external_product_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"041776ae-b8b6-4224-b35f-0dd7bdc80b29","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/products/:product_id/external-products/:external_product_id","host":["{{host}}/{{version}}"],"path":["products",":product_id","external-products",":external_product_id"],"variable":[{"key":"product_id"},{"key":"external_product_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"ddc686e5-6cc2-4658-96d2-c17a26af7fd4"}],"id":"a0a6e868-2e5b-4b37-ae84-34ec72880070","description":"These are the entries in the product catalog and represent the products or services your company sells on a subscription basis.
\nThis article presents an overview of Rebillia's product catalog. It discusses how Rebillia product catalog is built specifically for subscription businesses, what the different components of the product catalog are, and what the available charge models for creating custom price plans.
\nWith Rebillia Platform, you have one product catalog which you use to define the products your company sells and the pricing for those products. We designed the Product Catalog specifically for subscription-based businesses, which is different from the product catalogs you may find in ERP, CRM, or accounting applications. Those applications were designed with physical goods in mind. For example, whereas a product in a traditional widget-based product catalog only has one price (for example, $9.99 per unit), prices for subscriptions are expressed as one or more price plans, with each price plan containing any number of fees, such as activation fees, monthly subscription fees, and usage based fees.
\nWhat makes Rebillia's product catalog stand out is its flexible and easy-to-use interface and its support of sophisticated charge (pricing) models. You can add and remove products and services as your business grows and evolves. With a variety of charge models to choose from, you have the power to adapt your pricing to your customer and market needs, helping you grow your business and drive revenue in a shorter amount of time.
\nStorefront Subscriptions
\n","urlObject":{"path":["storefrontapi","subscriptions"],"host":["{{host}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"externalAddress,chargeTier,product,productRateplanCharge,externalRatePlanCharges"}],"variable":[]}},"response":[{"id":"f43ace84-2c66-44b3-aa23-fe8753ffa428","name":"List all Subscriptions response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/subscriptions?include=externalAddress,chargeTier,product,productRateplanCharge,externalRatePlanCharges","host":["{{host}}"],"path":["storefrontapi","subscriptions"],"query":[{"key":"include","value":"externalAddress,chargeTier,product,productRateplanCharge,externalRatePlanCharges"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"detail\": null,\n \"externalAddressId\": 10,\n \"externalRatePlanCharges\": [\n {\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalDetail\": {\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": [\n {\n \"id\": 982,\n \"label\": \"Red\",\n \"option_id\": 463,\n \"option_display_name\": \"Color\"\n }\n ]\n },\n \"externalId\": \"1\",\n \"externalName\": \"Name of the external\",\n \"externalSku\": \"SKU-CODE\",\n \"externalUrl\": \"string\",\n \"id\": 1,\n \"rateplanCharge\": {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n }\n ],\n \"externalProduct\": {\n \"id\": 1460,\n \"image\": \"\",\n \"name\": \"Sample Product\",\n \"price\": \"35\",\n \"sku\": \"\",\n \"url\": 30821008,\n \"options\": [\n {\n \"displayName\": \"Subscribe & Save\",\n \"values\": [\n \"Send every month\"\n ]\n }\n ],\n \"variants\": [\n {\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": []\n }\n ]\n },\n \"product\": {\n \"category\": \"physical\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"This is a product description.\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 8,\n \"internalProductId\": null,\n \"name\": \"Product name\",\n \"productRatePlan\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 7,\n \"isSync\": true,\n \"name\": \"Name\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"product\": \"/v1/products/8\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"id\": 79,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ],\n \"recurringChargeAmount\": 6,\n \"recurringChargeQty\": 2,\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n ],\n \"sku\": \"P-2\",\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"subtotal\": null,\n \"shipping\": null,\n \"id\": 1,\n \"lastCharge\": null,\n \"name\": \"Subscription name\",\n \"nextCharge\": \"2021-07-06 00:00:00\",\n \"offlinePaymentId\": null,\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"ratePlan\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"id\": 7,\n \"lastCharge\": null,\n \"name\": \"Monthly\",\n \"nextCharge\": \"2021-03-31 00:00:00\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"productId\": 7,\n \"productName\": \"Product name\",\n \"productRateplanId\": 143,\n \"rateplanCharge\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n ],\n \"recurringChargeAmount\": 71579559,\n \"recurringChargeQty\": 1,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n },\n \"recurringChargeAmount\": 1843.139,\n \"recurringChargeQty\": 1,\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": null,\n \"shippingCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"UPS\",\n \"id\": 17,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"shippingServiceId\": \"02\",\n \"source\": \"publicApi\",\n \"sourceCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n]"},{"id":"0dbdf539-ecde-46fe-8951-18072e85a2d8","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/subscriptions?include=externalAddress,chargeTier,product,productRateplanCharge,externalRatePlanCharges","host":["{{host}}"],"path":["storefrontapi","subscriptions"],"query":[{"key":"include","value":"externalAddress,chargeTier,product,productRateplanCharge,externalRatePlanCharges"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"f94326b0-105f-4633-ae09-9009908b0a1e"},{"name":"Get a Subscription of Customer","id":"a07a6e86-1c47-4860-9f8f-40a9348d323d","request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/storefrontapi/subscriptions/:subscription_id","description":"Storefront Subscription
\n","urlObject":{"path":["storefrontapi","subscriptions",":subscription_id"],"host":["{{host}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"externalAddress,chargeTier,product,productRateplanCharge,externalRatePlanCharges"}],"variable":[{"id":"1345ee02-01be-4642-b42d-4405361cfd05","description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"529420d0-e906-4eaa-b48b-b32d23bc1255","name":"Subscription resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id?include=externalAddress,chargeTier,product,productRateplanCharge,externalRatePlanCharges","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id"],"query":[{"key":"include","value":"externalAddress,chargeTier,product,productRateplanCharge,externalRatePlanCharges"}],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"detail\": null,\n \"externalAddressId\": 10,\n \"externalRatePlanCharges\": [\n {\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalDetail\": {\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": [\n {\n \"id\": 982,\n \"label\": \"Red\",\n \"option_id\": 463,\n \"option_display_name\": \"Color\"\n }\n ]\n },\n \"externalId\": \"1\",\n \"externalName\": \"Name of the external\",\n \"externalSku\": \"SKU-CODE\",\n \"externalUrl\": \"string\",\n \"id\": 1,\n \"rateplanCharge\": {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n }\n ],\n \"externalProduct\": {\n \"id\": 1460,\n \"image\": \"\",\n \"name\": \"Sample Product\",\n \"price\": \"35\",\n \"sku\": \"\",\n \"url\": 30821008,\n \"options\": [\n {\n \"displayName\": \"Subscribe & Save\",\n \"values\": [\n \"Send every month\"\n ]\n }\n ],\n \"variants\": [\n {\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": []\n }\n ]\n },\n \"product\": {\n \"category\": \"physical\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"This is a product description.\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 8,\n \"internalProductId\": null,\n \"name\": \"Product name\",\n \"productRatePlan\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 7,\n \"isSync\": true,\n \"name\": \"Name\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"product\": \"/v1/products/8\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"id\": 79,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ],\n \"recurringChargeAmount\": 6,\n \"recurringChargeQty\": 2,\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n ],\n \"sku\": \"P-2\",\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"subtotal\": null,\n \"shipping\": null,\n \"id\": 1,\n \"lastCharge\": null,\n \"name\": \"Subscription name\",\n \"nextCharge\": \"2021-07-06 00:00:00\",\n \"offlinePaymentId\": null,\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"ratePlan\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"id\": 7,\n \"lastCharge\": null,\n \"name\": \"Monthly\",\n \"nextCharge\": \"2021-03-31 00:00:00\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"productId\": 7,\n \"productName\": \"Product name\",\n \"productRateplanId\": 143,\n \"rateplanCharge\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n ],\n \"recurringChargeAmount\": 71579559,\n \"recurringChargeQty\": 1,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n },\n \"recurringChargeAmount\": 1843.139,\n \"recurringChargeQty\": 1,\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": null,\n \"shippingCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"UPS\",\n \"id\": 17,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"shippingServiceId\": \"02\",\n \"source\": \"publicApi\",\n \"sourceCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n}"},{"id":"514901e4-a8eb-499a-be31-d6f3d7bc3ba8","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id?include=externalAddress,chargeTier,product,productRateplanCharge,externalRatePlanCharges","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id"],"query":[{"key":"include","value":"externalAddress,chargeTier,product,productRateplanCharge,externalRatePlanCharges"}],"variable":[{"key":"subscription_id","value":"88"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"916fd7de-b738-4b1d-84f7-4ffdb1753c45","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id?include=externalAddress,chargeTier,product,productRateplanCharge,externalRatePlanCharges","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id"],"query":[{"key":"include","value":"externalAddress,chargeTier,product,productRateplanCharge,externalRatePlanCharges"}],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"variable":[{"id":"1345ee02-01be-4642-b42d-4405361cfd05","key":"subscription_id","value":"1","type":"any","description":"(Required) Subscription Id"}],"_postman_id":"a07a6e86-1c47-4860-9f8f-40a9348d323d"},{"name":"Update a Subscription Payment Method","id":"2c09a912-d361-4f2d-81f7-18257824b98e","request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"paymentMethodId\": 44\n}"},"url":"{{host}}/storefrontapi/subscriptions/:subscription_id/payment","description":"Storefront update Subscription payment method
\n","urlObject":{"path":["storefrontapi","subscriptions",":subscription_id","payment"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"699470fe-a161-47bf-88cc-36281a22fad5","name":"A Subscription payment method updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"paymentMethodId\": 44\n}"},"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/payment","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","payment"],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n}"},{"id":"48eb00af-2942-4ab2-9866-3baf11cec577","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"paymentMethodId\": 44\n}"},"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/payment","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","payment"],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"e44bff7d-a03e-4249-bd2c-472b37ca8881","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"paymentMethodId\": 44\n}"},"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/payment","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","payment"],"variable":[{"key":"subscription_id","value":"88"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"5ff339fd-8daf-4d4d-8001-8360c444d001","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"paymentMethodId\": 44\n}"},"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/payment","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","payment"],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"2c09a912-d361-4f2d-81f7-18257824b98e"},{"name":"Update a Subscription Shipping Address","id":"05051a18-6526-4794-86e3-a7889ed7f4e9","request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"externalId\": 10\n}"},"url":"{{host}}/storefrontapi/subscriptions/:subscription_id/shippingAddress","description":"Storefront update Subscription shipping address
\n","urlObject":{"path":["storefrontapi","subscriptions",":subscription_id","shippingAddress"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"c3a66d13-8ba4-496c-94d6-9f672a178836","name":"A Subscription shipping address updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"externalId\": 10\n}"},"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/shippingAddress","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","shippingAddress"],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n}"},{"id":"61322e3b-6ebe-4be7-8afe-308983184563","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"externalId\": 10\n}"},"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/shippingAddress","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","shippingAddress"],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"e6870e44-f33b-4cad-a2c9-0cba1c2ded08","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"externalId\": 10\n}"},"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/shippingAddress","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","shippingAddress"],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"ec0fd822-86b1-4757-a9ab-02ab42636e6f","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"externalId\": 10\n}"},"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/shippingAddress","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","shippingAddress"],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"05051a18-6526-4794-86e3-a7889ed7f4e9"},{"name":"Update a Subscription Status","id":"90fe85d6-9a96-44c9-bfad-dca109cb950c","request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"archived\"\n}"},"url":"{{host}}/storefrontapi/subscriptions/:subscription_id/status","description":"Storefront update Subscription
\n","urlObject":{"path":["storefrontapi","subscriptions",":subscription_id","status"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"b5bde1b3-3ccb-4b89-985c-cd2988ddb455","name":"A Subscription status updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"archived\"\n}"},"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/status","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","status"],"variable":[{"key":"subscription_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"detail\": null,\n \"externalAddressId\": 10,\n \"externalRatePlanCharges\": [\n {\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalDetail\": {\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": [\n {\n \"id\": 982,\n \"label\": \"Red\",\n \"option_id\": 463,\n \"option_display_name\": \"Color\"\n }\n ]\n },\n \"externalId\": \"1\",\n \"externalName\": \"Name of the external\",\n \"externalSku\": \"SKU-CODE\",\n \"externalUrl\": \"string\",\n \"id\": 1,\n \"rateplanCharge\": {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n }\n ],\n \"externalProduct\": {\n \"id\": 1460,\n \"image\": \"\",\n \"name\": \"Sample Product\",\n \"price\": \"35\",\n \"sku\": \"\",\n \"url\": -98730333,\n \"options\": [\n {\n \"displayName\": \"Subscribe & Save\",\n \"values\": [\n \"Send every month\"\n ]\n }\n ],\n \"variants\": [\n {\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": [\n {\n \"id\": 982,\n \"label\": \"Red\",\n \"option_id\": 463,\n \"option_display_name\": \"Color\"\n }\n ]\n }\n ]\n },\n \"product\": {\n \"category\": \"physical\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"This is a product description.\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 8,\n \"internalProductId\": null,\n \"name\": \"Product name\",\n \"productRatePlan\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 7,\n \"isSync\": true,\n \"name\": \"Name\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"product\": \"/v1/products/8\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"id\": 79,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ],\n \"recurringChargeAmount\": 6,\n \"recurringChargeQty\": 2,\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n ],\n \"sku\": \"P-2\",\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"subtotal\": null,\n \"shipping\": null,\n \"id\": 1,\n \"lastCharge\": null,\n \"name\": \"Subscription name\",\n \"nextCharge\": \"2021-07-06 00:00:00\",\n \"offlinePaymentId\": null,\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"ratePlan\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"id\": 7,\n \"lastCharge\": null,\n \"name\": \"Monthly\",\n \"nextCharge\": \"2021-03-31 00:00:00\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"productId\": 7,\n \"productName\": \"Product name\",\n \"productRateplanId\": 143,\n \"rateplanCharge\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n ],\n \"recurringChargeAmount\": 58131466,\n \"recurringChargeQty\": 1,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n },\n \"recurringChargeAmount\": 1843.139,\n \"recurringChargeQty\": 1,\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": null,\n \"shippingCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"UPS\",\n \"id\": 17,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"shippingServiceId\": \"02\",\n \"source\": \"publicApi\",\n \"sourceCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"archived\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n}"},{"id":"c63a28f9-4142-4fe1-85be-0df6f5f87acc","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"archived\"\n}"},"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/status","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","status"],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"6b5459e2-d772-4c87-8568-99392115baef","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"archived\"\n}"},"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/status","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","status"],"variable":[{"key":"subscription_id","value":"88"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"bebf5a7c-638a-4011-9a68-b1a437688732","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"archived\"\n}"},"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/status","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","status"],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"90fe85d6-9a96-44c9-bfad-dca109cb950c"},{"name":"Get all Subscriptions Upcoming of Customer","id":"0968ab1d-0f29-452a-bd3f-7a0a5eeacd96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/storefrontapi/subscriptions/subscriptions-upcoming","description":"Storefront Subscriptions Upcoming
\n","urlObject":{"path":["storefrontapi","subscriptions","subscriptions-upcoming"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"a22338f8-0faf-4ad3-bc12-55945535335d","name":"List of Subscriptions Upcoming","originalRequest":{"method":"GET","header":[],"url":"{{host}}/storefrontapi/subscriptions/subscriptions-upcoming"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"period\": \"2021-09\",\n \"data\": [\n {\n \"day\": \"2021-09-27\",\n \"data\": [\n {\n \"subscription\": {\n \"id\": 1,\n \"name\": \"Subscription name\",\n \"paymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https:\\/\\/restcountries.eu\\/data\\/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"customerAddressBook\": {\n \"city\": \"Downtown\",\n \"company\": null,\n \"contactEmail\": null,\n \"contactName\": null,\n \"contactPhone\": null,\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https:\\/\\/restcountries.eu\\/data\\/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 143,\n \"name\": null,\n \"state\": \"Georgia\",\n \"street1\": \"2770 Fleur de lis way\",\n \"street2\": null,\n \"type\": \"residential\",\n \"zip\": \"30456\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"shippingAddress\": null\n },\n \"externalProduct\": {\n \"id\": 1460,\n \"image\": \"\",\n \"name\": \"Sample Product\",\n \"price\": \"35\",\n \"sku\": \"\",\n \"url\": \"https:\\/\\/store-test.mybigcommerce.com\\/sample-product\\/\",\n \"options\": [\n {\n \"displayName\": \"Color\",\n \"values\": [\n \"Red\"\n ]\n }\n ],\n \"variants\": [\n {\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": [\n {\n \"id\": 982,\n \"label\": \"Red\",\n \"option_id\": 463,\n \"option_display_name\": \"Color\"\n }\n ]\n }\n ] \n },\n \"shippingAmount\": 0,\n \"subtotal\": 12.50,\n \"upcomingCharges\": [\n {\n \"ratePlan\": {\n \"id\": 7,\n \"name\": \"Monthly\",\n \"charges\": [\n {\n \"billCycleDay\": 43,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": \"/v1/subscriptions/1?include=chargeTier\",\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"depth\": \"1.0000\",\n \"delay\": null,\n \"delayType\": null,\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"endDateCondition\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n ]\n }\n }\n ]\n }\n ]\n }\n ]\n }\n]"},{"id":"dc57348a-7ee9-4684-bf48-4fccd4bec8c0","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"{{host}}/storefrontapi/subscriptions/subscriptions-upcoming"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"0968ab1d-0f29-452a-bd3f-7a0a5eeacd96"},{"name":"Create a Subscription Rate Plan","id":"a45ab5ab-0ac0-49de-bbed-dfe8b5f643ae","request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[],"url":"{{host}}/storefrontapi/subscriptions/:subscription_id/ratePlans","description":"Storefront create a Subscription Rate Plan
\n","urlObject":{"path":["storefrontapi","subscriptions",":subscription_id","ratePlans"],"host":["{{host}}"],"query":[{"disabled":true,"description":{"content":"(Required) Product Rate Plan ID.
\n","type":"text/plain"},"key":"productRatePlanId","value":"7"},{"disabled":true,"description":{"content":"(Required) Rate Plan ID to remove
\n","type":"text/plain"},"key":"ratePlanId","value":"4"}],"variable":[{"id":"50903c04-bc1a-4b1c-b13d-c2ce853e9ae7","description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"8cb033ad-0019-427b-b3e9-e73c83c62f1c","name":"A Subscription rate plan created","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/ratePlans?productRatePlanId=7&ratePlanId=4","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","ratePlans"],"query":[{"key":"productRatePlanId","value":"7"},{"key":"ratePlanId","value":"4"}],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"id\": 7,\n \"lastCharge\": null,\n \"name\": \"Monthly\",\n \"nextCharge\": \"2021-03-31 00:00:00\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"productId\": 7,\n \"productName\": \"Product name\",\n \"productRateplanId\": 143,\n \"rateplanCharge\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n ],\n \"recurringChargeAmount\": 31250031,\n \"recurringChargeQty\": 1,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n}"},{"id":"12c1ef50-056e-472b-84c0-641910f42c4c","name":"Bad request","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/ratePlans?productRatePlanId=7&ratePlanId=4","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","ratePlans"],"query":[{"key":"productRatePlanId","value":"7"},{"key":"ratePlanId","value":"4"}],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"121bd0f8-58d4-4917-a4e5-1e171c6daebf","name":"Resource not found","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/ratePlans?productRatePlanId=7&ratePlanId=4","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","ratePlans"],"query":[{"key":"productRatePlanId","value":"7"},{"key":"ratePlanId","value":"4"}],"variable":[{"key":"subscription_id","value":"88"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"69aca192-fa48-4c2c-8931-c08060dd0205","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/storefrontapi/subscriptions/:subscription_id/ratePlans?productRatePlanId=7&ratePlanId=4","host":["{{host}}"],"path":["storefrontapi","subscriptions",":subscription_id","ratePlans"],"query":[{"key":"productRatePlanId","value":"7"},{"key":"ratePlanId","value":"4"}],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"variable":[{"id":"50903c04-bc1a-4b1c-b13d-c2ce853e9ae7","key":"subscription_id","value":"1","type":"any","description":"(Required) Subscription Id"}],"_postman_id":"a45ab5ab-0ac0-49de-bbed-dfe8b5f643ae"}],"id":"05fbe256-680c-4207-aadf-74c2b8403611","_postman_id":"05fbe256-680c-4207-aadf-74c2b8403611","description":""},{"name":"Payment Methods","item":[{"name":"Get all Payment Methods of Customer","id":"558102fc-81d2-4b20-801d-18b688b08faa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/storefrontapi/paymentmethods","description":"Storefront Payment Methods
\n","urlObject":{"path":["storefrontapi","paymentmethods"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"044fb370-f303-4b45-a7a8-e3e152de2668","name":"List of Payment Methods","originalRequest":{"method":"GET","header":[],"url":"{{host}}/storefrontapi/paymentmethods"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n }\n]"},{"id":"b1406b2b-b40b-47ce-8221-3bbaf5d4aedf","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"{{host}}/storefrontapi/paymentmethods"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"558102fc-81d2-4b20-801d-18b688b08faa"},{"name":"Get a Payment Method of Customer","id":"6aa36390-4be7-4365-9bd1-f5ba99794a36","request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/storefrontapi/paymentmethods/:customer_payment_method_id","description":"Storefront Payment Methods
\n","urlObject":{"path":["storefrontapi","paymentmethods",":customer_payment_method_id"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Payment Method Id
\n","type":"text/plain"},"type":"any","value":"44","key":"customer_payment_method_id"}]}},"response":[{"id":"3706291c-09a9-4e26-96a2-d684a315f723","name":"Payment Method resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/paymentmethods/:customer_payment_method_id","host":["{{host}}"],"path":["storefrontapi","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_payment_method_id","value":"44"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n}"},{"id":"f29a25af-fa62-4791-a163-07fb41987031","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/paymentmethods/:customer_payment_method_id","host":["{{host}}"],"path":["storefrontapi","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_payment_method_id","value":"77"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"11f7ad1a-9100-48ef-9ca2-d6ad6d81607a","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/paymentmethods/:customer_payment_method_id","host":["{{host}}"],"path":["storefrontapi","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_payment_method_id","value":"44"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"6aa36390-4be7-4365-9bd1-f5ba99794a36"},{"name":"Create a Customer Payment Method","id":"1a135691-8e82-4fea-8b10-84276480b025","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"companyGatewayId\": 3412,\n \"type\": \"card\",\n \"accountType\": \"checking\",\n \"accountKind\": \"business\",\n \"accountName\": \"Marta Morales\",\n \"paymentMethod\": {\n \"nonce\": \"tok_visa\"\n },\n \"billingAddress\": {\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryCode\": \"US\"\n }\n}"},"url":"{{host}}/storefrontapi/paymentmethods","description":"Create Storefront Payment Method
\n","urlObject":{"path":["storefrontapi","paymentmethods"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"31177eda-e5ec-4428-87d5-499182ce6ebb","name":"A customer payment method was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyGatewayId\": 3412,\n \"type\": \"card\",\n \"accountType\": \"checking\",\n \"accountKind\": \"business\",\n \"accountName\": \"Marta Morales\",\n \"paymentMethod\": {\n \"nonce\": \"tok_visa\"\n },\n \"billingAddress\": {\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryCode\": \"US\"\n }\n}"},"url":"{{host}}/storefrontapi/paymentmethods"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n}"},{"id":"b3291fea-ab34-43f1-8cd5-879b65da38f3","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyGatewayId\": 3412,\n \"type\": \"card\",\n \"accountType\": \"checking\",\n \"accountKind\": \"business\",\n \"accountName\": \"Marta Morales\",\n \"paymentMethod\": {\n \"nonce\": \"tok_visa\"\n },\n \"billingAddress\": {\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryCode\": \"US\"\n }\n}"},"url":"{{host}}/storefrontapi/paymentmethods"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"ec0709b7-4ab6-4cc9-900d-baff7f4038ac","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyGatewayId\": 3412,\n \"type\": \"card\",\n \"accountType\": \"checking\",\n \"accountKind\": \"business\",\n \"accountName\": \"Marta Morales\",\n \"paymentMethod\": {\n \"nonce\": \"tok_visa\"\n },\n \"billingAddress\": {\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"city\": \"Barboursville\",\n \"state\": \"Virginia\",\n \"zip\": \"22923\",\n \"countryCode\": \"US\"\n }\n}"},"url":"{{host}}/storefrontapi/paymentmethods"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"1a135691-8e82-4fea-8b10-84276480b025"},{"name":"Update a Customer Payment Method","id":"9b357812-5b01-4e3e-9976-e6ebf34d6a60","request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"externalId\": 8\n}"},"url":"{{host}}/storefrontapi/paymentmethods/:customer_payment_method_id","description":"Update a Storefront Payment Method
\n","urlObject":{"path":["storefrontapi","paymentmethods",":customer_payment_method_id"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Payment Method Id
\n","type":"text/plain"},"type":"any","value":"44","key":"customer_payment_method_id"}]}},"response":[{"id":"5be85082-9fc6-42d7-bf98-3706f9115da2","name":"A Customer Payment Method updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"externalId\": 8\n}"},"url":{"raw":"{{host}}/storefrontapi/paymentmethods/:customer_payment_method_id","host":["{{host}}"],"path":["storefrontapi","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_payment_method_id","value":"44"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n}"},{"id":"2c0be1e1-409c-41f3-844b-e4b1f56d8d50","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"externalId\": 8\n}"},"url":{"raw":"{{host}}/storefrontapi/paymentmethods/:customer_payment_method_id","host":["{{host}}"],"path":["storefrontapi","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_payment_method_id","value":"44"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"9fdfe93e-8bd0-4424-8fe6-566c822146f3","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"externalId\": 8\n}"},"url":{"raw":"{{host}}/storefrontapi/paymentmethods/:customer_payment_method_id","host":["{{host}}"],"path":["storefrontapi","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_payment_method_id","value":"77"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"84f8f4f8-bbe6-42df-83c1-46e755550c58","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"externalId\": 8\n}"},"url":{"raw":"{{host}}/storefrontapi/paymentmethods/:customer_payment_method_id","host":["{{host}}"],"path":["storefrontapi","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_payment_method_id","value":"44"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"9b357812-5b01-4e3e-9976-e6ebf34d6a60"},{"name":"Delete a Customer Payment Method","id":"38cc82c8-4208-4490-ac9a-b7d49c1e7311","request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"DELETE","header":[],"url":"{{host}}/storefrontapi/paymentmethods/:customer_payment_method_id","description":"Delete Storefront Payment Method
\n","urlObject":{"path":["storefrontapi","paymentmethods",":customer_payment_method_id"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(Required) Customer Payment Method Id
\n","type":"text/plain"},"type":"any","value":"44","key":"customer_payment_method_id"}]}},"response":[{"id":"bf0c9052-5ebe-432b-9c7a-2b732bd67719","name":"Customer Payment Method deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/storefrontapi/paymentmethods/:customer_payment_method_id","host":["{{host}}"],"path":["storefrontapi","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_payment_method_id","value":"44"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"2f76d862-19a8-445f-b7a9-3077538bb080","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/storefrontapi/paymentmethods/:customer_payment_method_id","host":["{{host}}"],"path":["storefrontapi","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_payment_method_id","value":"77"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"6c427c26-986e-4cc7-af61-96e06147524c","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/storefrontapi/paymentmethods/:customer_payment_method_id","host":["{{host}}"],"path":["storefrontapi","paymentmethods",":customer_payment_method_id"],"variable":[{"key":"customer_payment_method_id","value":"44"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"38cc82c8-4208-4490-ac9a-b7d49c1e7311"}],"id":"cfd1865b-c96e-4fa1-8cfd-9d505e105a95","_postman_id":"cfd1865b-c96e-4fa1-8cfd-9d505e105a95","description":""},{"name":"Address Books","item":[{"name":"Get all Address Books of Customer","id":"b76163e3-30f1-45de-8c29-fee3e386f2f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/storefrontapi/addressbooks","description":"Storefront Address Book
\n","urlObject":{"path":["storefrontapi","addressbooks"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"fb6dfa0e-7425-4475-9c0b-6de3f4225b94","name":"List of Address Books","originalRequest":{"method":"GET","header":[],"url":"{{host}}/storefrontapi/addressbooks"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"address1\": \"123 Main St\",\n \"address2\": \"\",\n \"address_type\": \"address_type\",\n \"city\": \"Barboursville\",\n \"company\": null,\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"customer_id\": 7,\n \"first_name\": \"Marta\",\n \"last_name\": \"Morales\",\n \"phone\": \"404 55 5555\",\n \"postal_code\": \"22923\",\n \"state_or_province\": \"Virginia\"\n }\n]"},{"id":"5389d607-8cda-49d6-9252-59d4fe827b67","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"{{host}}/storefrontapi/addressbooks"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"b76163e3-30f1-45de-8c29-fee3e386f2f4"}],"id":"4f5d988f-00f7-49fa-ac59-6495f9562be8","_postman_id":"4f5d988f-00f7-49fa-ac59-6495f9562be8","description":""},{"name":"Company Gateway","item":[{"name":"Retrieve Gateway Client Token","id":"638445ac-be55-4d1d-91d1-457a90b4da63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/storefrontapi/gateways/:company_gateway_id/clienttoken","description":"Storefront Retrieve Gateway Client Token
\n","urlObject":{"path":["storefrontapi","gateways",":company_gateway_id","clienttoken"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(Required) Company Gateway Id
\n","type":"text/plain"},"type":"any","value":"{{company_gateway_id}}","key":"company_gateway_id"}]}},"response":[{"id":"d9a12289-00a3-46b8-ae56-95a263eba59b","name":"Gateway Client Token","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/gateways/:company_gateway_id/clienttoken","host":["{{host}}"],"path":["storefrontapi","gateways",":company_gateway_id","clienttoken"],"variable":[{"key":"company_gateway_id","value":"3412"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"publicKey\": \"pk_test_n7dbfBGFNYNfMm34ergrBTRn64BGF\"\n}"},{"id":"bf3a82f6-8460-4b56-8182-450ec4b1e985","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/gateways/:company_gateway_id/clienttoken","host":["{{host}}"],"path":["storefrontapi","gateways",":company_gateway_id","clienttoken"],"variable":[{"key":"company_gateway_id","value":"34122"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"f76aa38a-b2fc-4396-b646-1752480cf2f8","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/gateways/:company_gateway_id/clienttoken","host":["{{host}}"],"path":["storefrontapi","gateways",":company_gateway_id","clienttoken"],"variable":[{"key":"company_gateway_id","value":"3412"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"638445ac-be55-4d1d-91d1-457a90b4da63"}],"id":"70674ca1-3e9c-4b8f-b15f-15d0a0eee118","_postman_id":"70674ca1-3e9c-4b8f-b15f-15d0a0eee118","description":""},{"name":"Products","item":[{"name":"Get all Product Rate Plans","id":"dbf455b0-7447-4c68-9928-016fcaa970b7","request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/storefrontapi/products/:product_id/rateplans","description":"Storefront Product Rate Plans
\n","urlObject":{"path":["storefrontapi","products",":product_id","rateplans"],"host":["{{host}}"],"query":[{"disabled":true,"description":{"content":"Product Rate Plan status
\n","type":"text/plain"},"key":"status","value":"published"}],"variable":[{"description":{"content":"(Required) Product ID
\n","type":"text/plain"},"type":"any","value":"8","key":"product_id"}]}},"response":[{"id":"a2338849-a2a2-45b9-bc13-21bfc262687b","name":"List of Product Rate Plans","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/products/:product_id/rateplans?status=published","host":["{{host}}"],"path":["storefrontapi","products",":product_id","rateplans"],"query":[{"key":"status","value":"published"}],"variable":[{"key":"product_id","value":"8"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"Description\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 7,\n \"isSync\": true,\n \"name\": \"Name\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"product\": \"/v1/products/8\",\n \"productRateplanCharge\": [\n {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"id\": 79,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n }\n ],\n \"recurringChargeAmount\": 6,\n \"recurringChargeQty\": 2,\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n]"},{"id":"bf5c69f9-c598-425c-b4dc-6aa148dfc651","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/products/:product_id/rateplans?status=published","host":["{{host}}"],"path":["storefrontapi","products",":product_id","rateplans"],"query":[{"key":"status","value":"published"}],"variable":[{"key":"product_id","value":"8"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"f4814ec5-93db-46fb-b897-7a77ada94aa7","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/products/:product_id/rateplans?status=published","host":["{{host}}"],"path":["storefrontapi","products",":product_id","rateplans"],"query":[{"key":"status","value":"published"}],"variable":[{"key":"product_id","value":"8"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"dbf455b0-7447-4c68-9928-016fcaa970b7"}],"id":"b9eae268-07e2-4533-bbd9-49b57ffd2a04","_postman_id":"b9eae268-07e2-4533-bbd9-49b57ffd2a04","description":""},{"name":"Rate Plan Charges","item":[{"name":"Get an External Product linked to Rate Plan Charge","id":"a61245de-6cb7-4667-9803-bf0e09882778","request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/storefrontapi/rateplan-charges/:rate_plan_charge_id/external-product","description":"Storefront Rate Plan Charge get External Product
\n","urlObject":{"path":["storefrontapi","rateplan-charges",":rate_plan_charge_id","external-product"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(Required) Rate Plan Charge Id
\n","type":"text/plain"},"type":"any","value":"2777","key":"rate_plan_charge_id"}]}},"response":[{"id":"ca11ddac-37fd-4f64-98c8-8f2de12abd8d","name":"An External Product","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/rateplan-charges/:rate_plan_charge_id/external-product","host":["{{host}}"],"path":["storefrontapi","rateplan-charges",":rate_plan_charge_id","external-product"],"variable":[{"key":"rate_plan_charge_id","value":"2777"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1460,\n \"image\": \"\",\n \"name\": \"Sample Product\",\n \"price\": \"35\",\n \"sku\": \"\",\n \"url\": 18816899,\n \"options\": [\n {\n \"displayName\": \"Subscribe & Save\",\n \"values\": [\n \"Send every month\"\n ]\n }\n ],\n \"variants\": [\n {\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": [\n {\n \"id\": 982,\n \"label\": \"Red\",\n \"option_id\": 463,\n \"option_display_name\": \"Color\"\n }\n ]\n }\n ]\n}"},{"id":"2a07f47d-dc6e-4ddb-a1cc-cc01cca09ef2","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/rateplan-charges/:rate_plan_charge_id/external-product","host":["{{host}}"],"path":["storefrontapi","rateplan-charges",":rate_plan_charge_id","external-product"],"variable":[{"key":"rate_plan_charge_id","value":"2777"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"e0cea5cd-58d6-4566-a25e-3954cffcffcd","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/rateplan-charges/:rate_plan_charge_id/external-product","host":["{{host}}"],"path":["storefrontapi","rateplan-charges",":rate_plan_charge_id","external-product"],"variable":[{"key":"rate_plan_charge_id","value":"2777"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"a61245de-6cb7-4667-9803-bf0e09882778"},{"name":"Update an External Rate Plan Charge","id":"ae3f198b-2818-4e33-aed7-fbd05eab9039","request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": [\n {\n \"id\": 982,\n \"label\": \"Red\",\n \"option_id\": 463,\n \"option_display_name\": \"Color\"\n }\n ]\n}"},"url":"{{host}}/storefrontapi/rateplan-charges/:rate_plan_charge_id/external-rateplan-charge","description":"Storefront update External Rate Plan Charge
\n","urlObject":{"path":["storefrontapi","rateplan-charges",":rate_plan_charge_id","external-rateplan-charge"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(Required) Rate Plan Charge Id
\n","type":"text/plain"},"type":"any","value":"2777","key":"rate_plan_charge_id"}]}},"response":[{"id":"7f051891-8363-4a54-96b6-9a02bd95c806","name":"An External Rate Plan Charge updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": [\n {\n \"id\": 982,\n \"label\": \"Red\",\n \"option_id\": 463,\n \"option_display_name\": \"Color\"\n }\n ]\n}"},"url":{"raw":"{{host}}/storefrontapi/rateplan-charges/:rate_plan_charge_id/external-rateplan-charge","host":["{{host}}"],"path":["storefrontapi","rateplan-charges",":rate_plan_charge_id","external-rateplan-charge"],"variable":[{"key":"rate_plan_charge_id","value":"2777"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"externalDetail\": {\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": [\n {\n \"id\": 982,\n \"label\": \"Red\",\n \"option_id\": 463,\n \"option_display_name\": \"Color\"\n }\n ]\n },\n \"externalId\": \"1\",\n \"externalName\": \"Name of the external\",\n \"externalSku\": \"SKU-CODE\",\n \"externalUrl\": \"string\",\n \"id\": 1,\n \"rateplanCharge\": {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n}"},{"id":"b2858a01-278f-4fe7-bdf7-06a5113f9134","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": [\n {\n \"id\": 982,\n \"label\": \"Red\",\n \"option_id\": 463,\n \"option_display_name\": \"Color\"\n }\n ]\n}"},"url":{"raw":"{{host}}/storefrontapi/rateplan-charges/:rate_plan_charge_id/external-rateplan-charge","host":["{{host}}"],"path":["storefrontapi","rateplan-charges",":rate_plan_charge_id","external-rateplan-charge"],"variable":[{"key":"rate_plan_charge_id","value":"2777"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"063c1ed7-e31c-482a-9d57-c197248537e4","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": [\n {\n \"id\": 982,\n \"label\": \"Red\",\n \"option_id\": 463,\n \"option_display_name\": \"Color\"\n }\n ]\n}"},"url":{"raw":"{{host}}/storefrontapi/rateplan-charges/:rate_plan_charge_id/external-rateplan-charge","host":["{{host}}"],"path":["storefrontapi","rateplan-charges",":rate_plan_charge_id","external-rateplan-charge"],"variable":[{"key":"rate_plan_charge_id","value":"27777"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"f40a72a1-7865-4c2e-96e3-85bc6b4cdba8","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 1769,\n \"product_id\": 1460,\n \"sku\": \"\",\n \"price\": 35,\n \"calculated_price\": 35,\n \"sale_price\": 0,\n \"retail_price\": 0,\n \"map_price\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"height\": 0,\n \"depth\": 0,\n \"is_free_shipping\": false,\n \"fixed_cost_shipping_price\": 0,\n \"calculated_weight\": 0,\n \"purchasing_disabled\": false,\n \"purchasing_disabled_message\": \"\",\n \"image_url\": \"\",\n \"cost_price\": 0,\n \"upc\": \"\",\n \"mpn\": \"\",\n \"gtin\": \"\",\n \"inventory_level\": 0,\n \"inventory_warning_level\": 0,\n \"bin_picking_number\": \"\",\n \"option_values\": [\n {\n \"id\": 982,\n \"label\": \"Red\",\n \"option_id\": 463,\n \"option_display_name\": \"Color\"\n }\n ]\n}"},"url":{"raw":"{{host}}/storefrontapi/rateplan-charges/:rate_plan_charge_id/external-rateplan-charge","host":["{{host}}"],"path":["storefrontapi","rateplan-charges",":rate_plan_charge_id","external-rateplan-charge"],"variable":[{"key":"rate_plan_charge_id","value":"2777"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"ae3f198b-2818-4e33-aed7-fbd05eab9039"},{"name":"Schedule a Rate Plan Charge","id":"10ce833b-2c95-4ee5-8e35-bcc96eca613d","request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"chargedThroughDate\": \"2020-01-06\"\n}"},"url":"{{host}}/storefrontapi/rateplan-charges/:rate_plan_charge_id/schedule-next-charge","description":"Storefront schedule Rate Plan Charge
\n","urlObject":{"path":["storefrontapi","rateplan-charges",":rate_plan_charge_id","schedule-next-charge"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(Required) Rate Plan Charge Id
\n","type":"text/plain"},"type":"any","value":"2777","key":"rate_plan_charge_id"}]}},"response":[{"id":"7fa06483-ec67-4e7a-b3e0-44ddf3fac57e","name":"A Rate Plan Charge scheduled","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"chargedThroughDate\": \"2020-01-06\"\n}"},"url":{"raw":"{{host}}/storefrontapi/rateplan-charges/:rate_plan_charge_id/schedule-next-charge","host":["{{host}}"],"path":["storefrontapi","rateplan-charges",":rate_plan_charge_id","schedule-next-charge"],"variable":[{"key":"rate_plan_charge_id","value":"2777"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"id\": 7,\n \"lastCharge\": null,\n \"name\": \"Monthly\",\n \"nextCharge\": \"2021-03-31 00:00:00\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"productId\": 7,\n \"productName\": \"Product name\",\n \"productRateplanId\": 143,\n \"rateplanCharge\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n ],\n \"recurringChargeAmount\": 17916340,\n \"recurringChargeQty\": 1,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n}"},{"id":"e3fcc7ec-719a-40f2-a9ff-c8a916b47ee6","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"chargedThroughDate\": \"2020-01-06\"\n}"},"url":{"raw":"{{host}}/storefrontapi/rateplan-charges/:rate_plan_charge_id/schedule-next-charge","host":["{{host}}"],"path":["storefrontapi","rateplan-charges",":rate_plan_charge_id","schedule-next-charge"],"variable":[{"key":"rate_plan_charge_id","value":"2777"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"6d2c3163-8cbb-4ca7-ac8c-2df801a4a203","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"chargedThroughDate\": \"2020-01-06\"\n}"},"url":{"raw":"{{host}}/storefrontapi/rateplan-charges/:rate_plan_charge_id/schedule-next-charge","host":["{{host}}"],"path":["storefrontapi","rateplan-charges",":rate_plan_charge_id","schedule-next-charge"],"variable":[{"key":"rate_plan_charge_id","value":"27777"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"98686e52-e2ea-4e34-a6ea-6c4a69a62778","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"chargedThroughDate\": \"2020-01-06\"\n}"},"url":{"raw":"{{host}}/storefrontapi/rateplan-charges/:rate_plan_charge_id/schedule-next-charge","host":["{{host}}"],"path":["storefrontapi","rateplan-charges",":rate_plan_charge_id","schedule-next-charge"],"variable":[{"key":"rate_plan_charge_id","value":"2777"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"10ce833b-2c95-4ee5-8e35-bcc96eca613d"}],"id":"b9066e30-4837-435f-aeac-32836089ffc6","_postman_id":"b9066e30-4837-435f-aeac-32836089ffc6","description":""},{"name":"Checkout","id":"8b795fc9-cbd2-4694-924f-33bd706f0dc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/storefrontapi/checkouts/payments?cartId={{cart_id}}&gatewayKeyName=authorize","description":"Storefront Checkout
\n","urlObject":{"path":["storefrontapi","checkouts","payments"],"host":["{{host}}"],"query":[{"description":{"content":"(Required) Cart ID
\n","type":"text/plain"},"key":"cartId","value":"{{cart_id}}"},{"description":{"content":"(Required) Gateway Key name
\n","type":"text/plain"},"key":"gatewayKeyName","value":"authorize"}],"variable":[]}},"response":[{"id":"de742aef-df58-4ce1-8f29-6157f464484c","name":"Checkout data","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/checkouts/payments?cartId=7983092c-6f9f-47f2-b400-955569aaa58db&gatewayKeyName=stripe","host":["{{host}}"],"path":["storefrontapi","checkouts","payments"],"query":[{"key":"cartId","value":"7983092c-6f9f-47f2-b400-955569aaa58db"},{"key":"gatewayKeyName","value":"stripe"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"cartHasSubscription\": true,\n \"gatewaySettings\": {\n \"publicKey\": \"pk_test_b652gvbBVDFBfdbnFqgM00LqKPcQR3\",\n \"default\": \"stripe\"\n },\n \"paymentMethods\": [\n {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https:\\/\\/restcountries.eu\\/data\\/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": true,\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"customerAddressBook\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https:\\/\\/restcountries.eu\\/data\\/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": true,\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n }\n ]\n },\n \"error\": null,\n \"form\": \"Storefront Check Cart
\n","urlObject":{"path":["storefrontapi",":publicKey","carts",":cart_id","validate"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(Required) Public Key of Integration
\n","type":"text/plain"},"type":"any","value":"{{publicKey}}","key":"publicKey"},{"description":{"content":"(Required) Cart ID
\n","type":"text/plain"},"type":"any","value":"{{cart_id}}","key":"cart_id"}]}},"response":[{"id":"9c11239c-71d4-4571-9a09-0032181ded7c","name":"Cart validation","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/:publicKey/carts/:cart_id/validate","host":["{{host}}"],"path":["storefrontapi",":publicKey","carts",":cart_id","validate"],"variable":[{"key":"publicKey","value":"AS2DSJ4IQJBX4952VLSHY7Q7QZEPOIKL"},{"key":"cart_id","value":"7983092c-6f9f-47f2-b400-955569aaa58db"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"currencyCode\": \"USD\",\n \"cartHasSubscription\": true\n}"},{"id":"5e2ee8bb-f722-4f9d-ab53-9447389a0c6b","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/:publicKey/carts/:cart_id/validate","host":["{{host}}"],"path":["storefrontapi",":publicKey","carts",":cart_id","validate"],"variable":[{"key":"publicKey","value":"AS2DSJ4IQJBX4952VLSHY7Q7QZEPOIKL"},{"key":"cart_id","value":"7983092c-6f9f-47f2-b400-955569aaa58"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"d1ac8d27-1b0f-4fe0-b5e7-3d51fb66bd5e","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/:publicKey/carts/:cart_id/validate","host":["{{host}}"],"path":["storefrontapi",":publicKey","carts",":cart_id","validate"],"variable":[{"key":"publicKey","value":"AS2DSJ4IQJBX4952VLSHY7Q7QZEPOIKL"},{"key":"cart_id","value":"7983092c-6f9f-47f2-b400-955569aaa58db"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"f4ce1214-f3a6-457d-8795-75aa3ee4ee25"},{"name":"Login Customer","id":"a79bc177-6a7b-4a4b-b2e1-57ff9f0a505f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/storefrontapi/:publicKey/login?email={{customerEmail}}&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJjdXN0b21lciI6eyJpZCI6NDgsImVtYWlsIjoibWF0aWFzLnBhc2N1YWxldHRpQHJlYmlsbGlhLmNvbSIsImdyb3VwX2lkIjoiMCJ9LCJpc3MiOiJiYy9hcHBzIiwic3ViIjoiM3VtMHl4dTVlayIsImlhdCI6MTYzNjcyMzA3MiwiZXhwIjoxNjM2NzIzOTcyLCJ2ZXJzaW9uIjoxLCJhdWQiOiJzejY5dml0d2YwcHBseGdpYWczb3Yyd24xdDAwN2o0IiwiYXBwbGljYXRpb25faWQiOiJzejY5dml0d2YwcHBseGdpYWczb3Yyd24xdDAwN2o0Iiwic3RvcmVfaGFzaCI6IjN1bTB5eHU1ZWsiLCJvcGVyYXRpb24iOiJjdXJyZW50X2N1c3RvbWVyIn0.DRt4Y4h5hxX1t16x1ZCr-8r5UfsPLZYjJO-9XWrpJL9jJrT3ycLoz5wkQbEuTevsC5YzJ8bNEN9k91FHFCRPZw","description":"Storefront Login
\n","urlObject":{"path":["storefrontapi",":publicKey","login"],"host":["{{host}}"],"query":[{"description":{"content":"Customer email.
\n","type":"text/plain"},"key":"email","value":"{{customerEmail}}"},{"description":{"content":"Token generated by the store (check the endpoint current.jwt on the store website)
\n","type":"text/plain"},"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJjdXN0b21lciI6eyJpZCI6NDgsImVtYWlsIjoibWF0aWFzLnBhc2N1YWxldHRpQHJlYmlsbGlhLmNvbSIsImdyb3VwX2lkIjoiMCJ9LCJpc3MiOiJiYy9hcHBzIiwic3ViIjoiM3VtMHl4dTVlayIsImlhdCI6MTYzNjcyMzA3MiwiZXhwIjoxNjM2NzIzOTcyLCJ2ZXJzaW9uIjoxLCJhdWQiOiJzejY5dml0d2YwcHBseGdpYWczb3Yyd24xdDAwN2o0IiwiYXBwbGljYXRpb25faWQiOiJzejY5dml0d2YwcHBseGdpYWczb3Yyd24xdDAwN2o0Iiwic3RvcmVfaGFzaCI6IjN1bTB5eHU1ZWsiLCJvcGVyYXRpb24iOiJjdXJyZW50X2N1c3RvbWVyIn0.DRt4Y4h5hxX1t16x1ZCr-8r5UfsPLZYjJO-9XWrpJL9jJrT3ycLoz5wkQbEuTevsC5YzJ8bNEN9k91FHFCRPZw"}],"variable":[{"description":{"content":"(Required) Integration Public Key.
\n","type":"text/plain"},"type":"any","value":"{{publicKey}}","key":"publicKey"}]}},"response":[{"id":"0f965cf8-1376-47d0-92b7-11ffb3754574","name":"Token of Rebillia","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/:publicKey/login?email=customer@email.com&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJjdXN0b21lciI6eyJpZCI6MSwiZW1haWwiOiJjdXN0b21lckBlbWFpbC5jb20iLCJncm91cF9pZCI6IjIzIn0sImlzcyI6ImJjL2FwcHMiLCJzdWIiOiJmZHNzZGY0MzIiLCJpYXQiOjE2MzUyNTk4MzUsImV4cCI6MTYzNTI2MDczNSwidmVyc2lvbiI6MSwiYXVkIjoiYWRzZmR3MjM0NDN2ZmRkZnMiLCJhcHBsaWNhdGlvbl9pZCI6ImRzdnI0dzM0NTMydnJ0YmZkZGRzIiwic3RvcmVfaGFzaCI6ImFkc2ZkdzIzNDQzdmZkZGZzIiwib3BlcmF0aW9uIjoiY3VycmVudF9jdXN0b21lciJ9.R5xbgT16YKnsefi_f-i8g2Zb1Pyw3a0WdzsyQ4tC1k5d0dsIvBlZ4OKddX0T2XwVeqN4pq59QfL7NffuUJPvNg","host":["{{host}}"],"path":["storefrontapi",":publicKey","login"],"query":[{"key":"email","value":"customer@email.com"},{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJjdXN0b21lciI6eyJpZCI6MSwiZW1haWwiOiJjdXN0b21lckBlbWFpbC5jb20iLCJncm91cF9pZCI6IjIzIn0sImlzcyI6ImJjL2FwcHMiLCJzdWIiOiJmZHNzZGY0MzIiLCJpYXQiOjE2MzUyNTk4MzUsImV4cCI6MTYzNTI2MDczNSwidmVyc2lvbiI6MSwiYXVkIjoiYWRzZmR3MjM0NDN2ZmRkZnMiLCJhcHBsaWNhdGlvbl9pZCI6ImRzdnI0dzM0NTMydnJ0YmZkZGRzIiwic3RvcmVfaGFzaCI6ImFkc2ZkdzIzNDQzdmZkZGZzIiwib3BlcmF0aW9uIjoiY3VycmVudF9jdXN0b21lciJ9.R5xbgT16YKnsefi_f-i8g2Zb1Pyw3a0WdzsyQ4tC1k5d0dsIvBlZ4OKddX0T2XwVeqN4pq59QfL7NffuUJPvNg"}],"variable":[{"key":"publicKey","value":"AS2DSJ4IQJBX4952VLSHY7Q7QZEPOIKL"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE2MzUyNTk4NzAsImV4cCI6MTYzNTM0NjI3MCwiY29tcGFueUludGVncmF0aW9uSWQiOjEsImN1c3RvbWVySWQiOjEsImV4dGVybmFsSWQiOjcsImVtYWlsIjoiY3VzdG9tZXJAZW1haWwuY29tIiwidHlwZSI6Im5vcm1hbCJ9.fAzSP9qdkk7GsEtNRTExAzsD5fJhjTVJ8luXPnmg_RY\""},{"id":"fbebb1fa-9a95-4943-bab3-d2b6375924a0","name":"Bad request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/:publicKey/login?email=customer@email.com&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJjdXN0b21lciI6eyJpZCI6MSwiZW1haWwiOiJjdXN0b21lckBlbWFpbC5jb20iLCJncm91cF9pZCI6IjIzIn0sImlzcyI6ImJjL2FwcHMiLCJzdWIiOiJmZHNzZGY0MzIiLCJpYXQiOjE2MzUyNTk4MzUsImV4cCI6MTYzNTI2MDczNSwidmVyc2lvbiI6MSwiYXVkIjoiYWRzZmR3MjM0NDN2ZmRkZnMiLCJhcHBsaWNhdGlvbl9pZCI6ImRzdnI0dzM0NTMydnJ0YmZkZGRzIiwic3RvcmVfaGFzaCI6ImFkc2ZkdzIzNDQzdmZkZGZzIiwib3BlcmF0aW9uIjoiY3VycmVudF9jdXN0b21lciJ9.R5xbgT16YKnsefi_f-i8g2Zb1Pyw3a0WdzsyQ4tC1k5d0dsIvBlZ4OKddX0T2XwVeqN4pq59QfL7NffuUJPvNg","host":["{{host}}"],"path":["storefrontapi",":publicKey","login"],"query":[{"key":"email","value":"customer@email.com"},{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJjdXN0b21lciI6eyJpZCI6MSwiZW1haWwiOiJjdXN0b21lckBlbWFpbC5jb20iLCJncm91cF9pZCI6IjIzIn0sImlzcyI6ImJjL2FwcHMiLCJzdWIiOiJmZHNzZGY0MzIiLCJpYXQiOjE2MzUyNTk4MzUsImV4cCI6MTYzNTI2MDczNSwidmVyc2lvbiI6MSwiYXVkIjoiYWRzZmR3MjM0NDN2ZmRkZnMiLCJhcHBsaWNhdGlvbl9pZCI6ImRzdnI0dzM0NTMydnJ0YmZkZGRzIiwic3RvcmVfaGFzaCI6ImFkc2ZkdzIzNDQzdmZkZGZzIiwib3BlcmF0aW9uIjoiY3VycmVudF9jdXN0b21lciJ9.R5xbgT16YKnsefi_f-i8g2Zb1Pyw3a0WdzsyQ4tC1k5d0dsIvBlZ4OKddX0T2XwVeqN4pq59QfL7NffuUJPvNg"}],"variable":[{"key":"publicKey","value":"AS2DSJ4IQJBX4952VLSHY7Q7QZEPOIKL"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"70745171-37af-4333-ab8c-55c038b4aa55","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/:publicKey/login?email=custome@email.com&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJjdXN0b21lciI6eyJpZCI6MSwiZW1haWwiOiJjdXN0b21lckBlbWFpbC5jb20iLCJncm91cF9pZCI6IjIzIn0sImlzcyI6ImJjL2FwcHMiLCJzdWIiOiJmZHNzZGY0MzIiLCJpYXQiOjE2MzUyNTk4MzUsImV4cCI6MTYzNTI2MDczNSwidmVyc2lvbiI6MSwiYXVkIjoiYWRzZmR3MjM0NDN2ZmRkZnMiLCJhcHBsaWNhdGlvbl9pZCI6ImRzdnI0dzM0NTMydnJ0YmZkZGRzIiwic3RvcmVfaGFzaCI6ImFkc2ZkdzIzNDQzdmZkZGZzIiwib3BlcmF0aW9uIjoiY3VycmVudF9jdXN0b21lciJ9.R5xbgT16YKnsefi_f-i8g2Zb1Pyw3a0WdzsyQ4tC1k5d0dsIvBlZ4OKddX0T2XwVeqN4pq59QfL7NffuUJPvNg","host":["{{host}}"],"path":["storefrontapi",":publicKey","login"],"query":[{"key":"email","value":"custome@email.com"},{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJjdXN0b21lciI6eyJpZCI6MSwiZW1haWwiOiJjdXN0b21lckBlbWFpbC5jb20iLCJncm91cF9pZCI6IjIzIn0sImlzcyI6ImJjL2FwcHMiLCJzdWIiOiJmZHNzZGY0MzIiLCJpYXQiOjE2MzUyNTk4MzUsImV4cCI6MTYzNTI2MDczNSwidmVyc2lvbiI6MSwiYXVkIjoiYWRzZmR3MjM0NDN2ZmRkZnMiLCJhcHBsaWNhdGlvbl9pZCI6ImRzdnI0dzM0NTMydnJ0YmZkZGRzIiwic3RvcmVfaGFzaCI6ImFkc2ZkdzIzNDQzdmZkZGZzIiwib3BlcmF0aW9uIjoiY3VycmVudF9jdXN0b21lciJ9.R5xbgT16YKnsefi_f-i8g2Zb1Pyw3a0WdzsyQ4tC1k5d0dsIvBlZ4OKddX0T2XwVeqN4pq59QfL7NffuUJPvNg"}],"variable":[{"key":"publicKey","value":"AS2DSJ4IQJBX4952VLSHY7Q7QZEPOIKL"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"db3e03f4-9ef2-4eb8-a648-1f613653ecd5","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/:publicKey/login?email=customer@email.com&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJjdXN0b21lciI6eyJpZCI6MSwiZW1haWwiOiJjdXN0b21lckBlbWFpbC5jb20iLCJncm91cF9pZCI6IjIzIn0sImlzcyI6ImJjL2FwcHMiLCJzdWIiOiJmZHNzZGY0MzIiLCJpYXQiOjE2MzUyNTk4MzUsImV4cCI6MTYzNTI2MDczNSwidmVyc2lvbiI6MSwiYXVkIjoiYWRzZmR3MjM0NDN2ZmRkZnMiLCJhcHBsaWNhdGlvbl9pZCI6ImRzdnI0dzM0NTMydnJ0YmZkZGRzIiwic3RvcmVfaGFzaCI6ImFkc2ZkdzIzNDQzdmZkZGZzIiwib3BlcmF0aW9uIjoiY3VycmVudF9jdXN0b21lciJ9.R5xbgT16YKnsefi_f-i8g2Zb1Pyw3a0WdzsyQ4tC1k5d0dsIvBlZ4OKddX0T2XwVeqN4pq59QfL7NffuUJPvNg","host":["{{host}}"],"path":["storefrontapi",":publicKey","login"],"query":[{"key":"email","value":"customer@email.com"},{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJjdXN0b21lciI6eyJpZCI6MSwiZW1haWwiOiJjdXN0b21lckBlbWFpbC5jb20iLCJncm91cF9pZCI6IjIzIn0sImlzcyI6ImJjL2FwcHMiLCJzdWIiOiJmZHNzZGY0MzIiLCJpYXQiOjE2MzUyNTk4MzUsImV4cCI6MTYzNTI2MDczNSwidmVyc2lvbiI6MSwiYXVkIjoiYWRzZmR3MjM0NDN2ZmRkZnMiLCJhcHBsaWNhdGlvbl9pZCI6ImRzdnI0dzM0NTMydnJ0YmZkZGRzIiwic3RvcmVfaGFzaCI6ImFkc2ZkdzIzNDQzdmZkZGZzIiwib3BlcmF0aW9uIjoiY3VycmVudF9jdXN0b21lciJ9.R5xbgT16YKnsefi_f-i8g2Zb1Pyw3a0WdzsyQ4tC1k5d0dsIvBlZ4OKddX0T2XwVeqN4pq59QfL7NffuUJPvNg"}],"variable":[{"key":"publicKey","value":"AS2DSJ4IQJBX4952VLSHY7Q7QZEPOIKL"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"a79bc177-6a7b-4a4b-b2e1-57ff9f0a505f"},{"name":"Settings","id":"c001ffb5-b59c-4695-8dc8-bb55a2cdc809","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/storefrontapi/:publicKey/settings","description":"Storefront Settings
\n","urlObject":{"path":["storefrontapi",":publicKey","settings"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(Required) Public Key of Integration
\n","type":"text/plain"},"type":"any","value":"AS2DSJ4IQJBX4952VLSHY7Q7QZEPOIKL","key":"publicKey"}]}},"response":[{"id":"6f601fdd-9652-4ae0-a7d0-2bbcbb30cc43","name":"List of Settings","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/:publicKey/settings","host":["{{host}}"],"path":["storefrontapi",":publicKey","settings"],"variable":[{"key":"publicKey","value":"AS2DSJ4IQJBX4952VLSHY7Q7QZEPOIKL"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"allowCustomerCancelSubscription\": \"1\",\n \"allowCustomerChangeChargeProduct\": \"1\",\n \"allowCustomerChangeSubscriptionRatePlan\": \"1\",\n \"allowCustomerReScheduleSubscription\": \"1\",\n \"allowCustomerReScheduleSubscriptionToBack\": \"1\",\n \"allowCustomerSkipUpcomingCharge\": \"1\",\n \"allowCustomerUpdateSubscriptionDetail\": \"1\",\n \"allowCustomerUpdateSubscriptionPaymentMethod\": \"1\",\n \"allowCustomerUpdateSubscriptionShipTo\": \"1\",\n \"allowCustomerUpdateSubscriptionShippingMethod\": \"1\",\n \"apiVersion\": \"1.0\",\n \"appClientId\": \"df56bfrth0pplxgiwevhnyv2wn1t854fr\",\n \"autoArrangeCustomerAccountNavigation\": \"0\",\n \"autoRemoveOtherPaymentOptions\": \"0\",\n \"cartHasSubscriptionMessage\": \"We found a subscription product in your cart. You must be logged in to successfully purchase a subscription.\",\n \"enableCheckout\": \"0\",\n \"enableCustomerAddToMySubscriptionButton\": \"0\",\n \"enableCustomerPaymentMethodNavigation\": \"0\",\n \"enableCustomerSubscriptionNavigation\": \"0\",\n \"enableCustomerUpcomingNavigation\": \"0\",\n \"environment\": \"test\",\n \"paymentGateways\": \"[{\\\"label\\\":\\\"authorize\\\",\\\"value\\\":1},{\\\"label\\\":\\\"braintree\\\",\\\"value\\\":2},{\\\"label\\\":\\\"stripe\\\",\\\"value\\\":3},{\\\"label\\\":\\\"square\\\",\\\"value\\\":4}, {\\\"label\\\":\\\"cybersource\\\",\\\"value\\\":5}]\",\n \"status\": \"active\"\n}"},{"id":"5c5d19d2-64ee-41f2-bedf-aedaf54c1e0f","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/:publicKey/settings","host":["{{host}}"],"path":["storefrontapi",":publicKey","settings"],"variable":[{"key":"publicKey","value":"AS2DSJ4IQJBX4952VLSHY7Q7QZEPOIKL"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"c001ffb5-b59c-4695-8dc8-bb55a2cdc809"},{"name":"Place Order","id":"bdb2f353-e644-4dd8-b27b-22ee068a5a00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"payment\": {\n \"saveCard\": false,\n \"paymentNonce\": \"tok_visa\",\n \"gatewayKeyName\": \"stripe\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/storefrontapi/checkouts/:checkout_id/place-order","description":"Storefront Place Order
\n","urlObject":{"path":["storefrontapi","checkouts",":checkout_id","place-order"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"(Required) Checkout ID
\n","type":"text/plain"},"type":"any","value":"{{cart_id}}","key":"checkout_id"}]}},"response":[{"id":"6aae0d8f-fe3c-4e05-836c-6e62b0384cf5","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/checkouts/:checkout_id/place-order","host":["{{host}}"],"path":["storefrontapi","checkouts",":checkout_id","place-order"],"variable":[{"key":"checkout_id","value":"7983092c-6f9f-47f2-b400-955569aaa58db"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"orderId\": 244369,\n \"token\": \"e6fa87fbeh5654g54g65478a3e34c075b6f947bb4653b65b5b65\"\n },\n \"code\": 200\n}"},{"id":"52aa655d-342a-4085-b410-8c5e41c99227","name":"Bad request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/checkouts/:checkout_id/place-order","host":["{{host}}"],"path":["storefrontapi","checkouts",":checkout_id","place-order"],"variable":[{"key":"checkout_id","value":"7983092c-6f9f-47f2-b400-955569aaa58db"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"a4be464d-9293-4caf-9072-4881b35f10f9","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/checkouts/:checkout_id/place-order","host":["{{host}}"],"path":["storefrontapi","checkouts",":checkout_id","place-order"],"variable":[{"key":"checkout_id","value":"7983092c-6f9f-47f2-b400-955569aaa58"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"1340f24c-ece4-4f2c-a71c-26465fe510a1","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/storefrontapi/checkouts/:checkout_id/place-order","host":["{{host}}"],"path":["storefrontapi","checkouts",":checkout_id","place-order"],"variable":[{"key":"checkout_id","value":"7983092c-6f9f-47f2-b400-955569aaa58db"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"bdb2f353-e644-4dd8-b27b-22ee068a5a00"}],"id":"773d5478-f46c-4d57-a031-7d1a34029b65","_postman_id":"773d5478-f46c-4d57-a031-7d1a34029b65","description":""},{"name":"Subscriptions","item":[{"name":"Rate Plans","item":[{"name":"List all Subscription rate plans","id":"84883bd6-0549-43be-beb1-e94dc280da06","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get Subscription rate plans collection.
\n","urlObject":{"path":["subscriptions",":subscription_id","rateplans"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"25e092c8-3c9f-44c8-91b8-8c987662384d","name":"Subscription rate plan collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans"],"variable":[{"key":"subscription_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"id\": 7,\n \"lastCharge\": null,\n \"name\": \"Monthly\",\n \"nextCharge\": \"2021-03-31 00:00:00\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"productId\": 7,\n \"productName\": \"Product name\",\n \"productRateplanId\": 143,\n \"rateplanCharge\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n ],\n \"recurringChargeAmount\": 30789572,\n \"recurringChargeQty\": 1,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n]"},{"id":"15907ae3-69a1-4c7f-a092-767f1997991b","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans"],"variable":[{"key":"subscription_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"cf916e8a-4e76-4de4-9a2c-a417e798341a","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans"],"variable":[{"key":"subscription_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"84883bd6-0549-43be-beb1-e94dc280da06"},{"name":"Get the Subscription rate plan","id":"db24413e-30fa-41aa-b188-76bf83b5ddea","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get Subscription rate plan.
\n","urlObject":{"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"},{"description":{"content":"(Required) Rate Plan Id
\n","type":"text/plain"},"type":"any","value":"7","key":"rate_plan_id"}]}},"response":[{"id":"cb1cce22-8339-4d08-88b1-ad2af1d2be62","name":"Subscription rate plan response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans/:rate_plan_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"id\": 7,\n \"lastCharge\": null,\n \"name\": \"Monthly\",\n \"nextCharge\": \"2021-03-31 00:00:00\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"productId\": 7,\n \"productName\": \"Product name\",\n \"productRateplanId\": 143,\n \"rateplanCharge\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n ],\n \"recurringChargeAmount\": -66227624,\n \"recurringChargeQty\": 1,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n}"},{"id":"e4852630-c1ff-4c03-b6b3-7cb99e913e7d","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans/:rate_plan_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"2a7b8499-919a-49e1-a9c5-be39587197f5","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans/:rate_plan_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"db24413e-30fa-41aa-b188-76bf83b5ddea"},{"name":"Create Subscription rate plan","id":"fc1c06a5-b71c-40dd-8df9-62757df52df7","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create subscription rate plan.
\n","urlObject":{"path":["subscriptions",":subscription_id","rateplans"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"6ad75e49-46f7-4d48-9b67-305fbe7ce7fa","name":"A rate plan was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Monthly\",\n \"productRateplanId\": 143,\n \"ratePlanCharge\": [\n {\n \"productRatePlanChargeId\": 7,\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2020-10-10\",\n \"effectiveStartDate\": \"2020-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 150,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"USD\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans"],"variable":[{"key":"subscription_id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"id\": 7,\n \"lastCharge\": null,\n \"name\": \"Monthly\",\n \"nextCharge\": \"2021-03-31 00:00:00\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"productId\": 7,\n \"productName\": \"Product name\",\n \"productRateplanId\": 143,\n \"rateplanCharge\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n ],\n \"recurringChargeAmount\": -66227624,\n \"recurringChargeQty\": 1,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n}"},{"id":"88683488-cf6b-4f85-a111-51f8c162df56","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Monthly\",\n \"productRateplanId\": 143,\n \"ratePlanCharge\": [\n {\n \"productRatePlanChargeId\": 7,\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2020-10-10\",\n \"effectiveStartDate\": \"2020-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 150,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"USD\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans"],"variable":[{"key":"subscription_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"cd7b1054-fedb-4ef3-8ab1-afb27d64b526","name":"Resource not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Monthly\",\n \"productRateplanId\": 143,\n \"ratePlanCharge\": [\n {\n \"productRatePlanChargeId\": 7,\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2020-10-10\",\n \"effectiveStartDate\": \"2020-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 150,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"USD\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans"],"variable":[{"key":"subscription_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"06c8bbe0-9936-4b7c-b969-9ab87c648c82","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Monthly\",\n \"productRateplanId\": 143,\n \"ratePlanCharge\": [\n {\n \"productRatePlanChargeId\": 7,\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2020-10-10\",\n \"effectiveStartDate\": \"2020-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 150,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"USD\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans"],"variable":[{"key":"subscription_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"fc1c06a5-b71c-40dd-8df9-62757df52df7"},{"name":"Update Subscription Rate plan","id":"83f88268-b4a5-4367-99b9-9fd598421ad9","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update subscription rate plan by ID.
\n","urlObject":{"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"},{"description":{"content":"(Required) Rate plan Id
\n","type":"text/plain"},"type":"any","value":"7","key":"rate_plan_id"}]}},"response":[{"id":"591d740a-ac52-4544-984e-18cc3e2d4df6","name":"A Rate plan updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Monthly\"\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans/:rate_plan_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"id\": 7,\n \"lastCharge\": null,\n \"name\": \"Monthly\",\n \"nextCharge\": \"2021-03-31 00:00:00\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"productId\": 7,\n \"productName\": \"Product name\",\n \"productRateplanId\": 143,\n \"rateplanCharge\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n ],\n \"recurringChargeAmount\": -66227624,\n \"recurringChargeQty\": 1,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n}"},{"id":"2ef19032-900b-45a2-9b17-4ac3c225e7b6","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Monthly\"\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans/:rate_plan_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"36d573d4-e586-4e14-baba-f5be6a63962a","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Monthly\"\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans/:rate_plan_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"3b73e64d-e2ad-4cfe-b67a-533873f6c066","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Monthly\"\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans/:rate_plan_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"83f88268-b4a5-4367-99b9-9fd598421ad9"},{"name":"Delete Subscription Rate plan","id":"262b9fb9-6d99-4e2e-bf34-3c507204ac76","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete subscription rate plan.
\n","urlObject":{"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"},{"description":{"content":"(Required) Rate plan Id
\n","type":"text/plain"},"type":"any","value":"7","key":"rate_plan_id"}]}},"response":[{"id":"8d684744-bb81-46ef-8456-aa4afaf3f5d9","name":"Rate plan deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans/:rate_plan_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"7f6284c2-4de9-47ca-a0db-6c9b62292b9f","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans/:rate_plan_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"21073b0e-5bb5-4ca9-9766-3b2239b0f53b","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans/:rate_plan_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"262b9fb9-6d99-4e2e-bf34-3c507204ac76"}],"id":"cd650b1f-8647-4150-9488-4cfc67634f44","description":"Get Subscription rate plan charge.
\n","urlObject":{"path":["subscriptions",":subscription_id","rateplan-charges",":rate_plan_charge_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"},{"description":{"content":"(Required) Rate Plan Charge Id
\n","type":"text/plain"},"type":"any","value":"2777","key":"rate_plan_charge_id"}]}},"response":[{"id":"bf5b9d54-e669-41f3-9a7c-d25c0ba3636f","name":"Subscription rate plan charge response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplan-charges/:rate_plan_charge_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplan-charges",":rate_plan_charge_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_charge_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"lastBillRun\": {\n \"companyBillRunId\": 5,\n \"createdAt\": \"2021-03-02 00:00:00\",\n \"description\": \"Description\",\n \"id\": 23,\n \"invoiceId\": 1,\n \"ratePlanChargeId\": 2777,\n \"status\": \"completed\",\n \"updatedAt\": \"2021-03-02 00:00:00\"\n },\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n}"},{"id":"cce8f889-e2d0-461a-ab92-e2bab9e404a3","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplan-charges/:rate_plan_charge_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplan-charges",":rate_plan_charge_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_charge_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"c7d6f34a-1334-44d8-890f-f2a74853f3dc","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplan-charges/:rate_plan_charge_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplan-charges",":rate_plan_charge_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_charge_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"a983ad9d-80c5-4008-836c-39577037c747"},{"name":"Create Subscription rate plan charge","id":"3f0c8052-4ec6-45fb-bf25-f5ae6d6f9f9c","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create subscription rate plan charge.
\n","urlObject":{"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id","rateplan-charges"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"},{"description":{"content":"(Required) Rate plan charge Id
\n","type":"text/plain"},"type":"any","value":"7","key":"rate_plan_id"}]}},"response":[{"id":"88d6b700-6765-401e-bafd-d823ee11b1d3","name":"A rate plan charge was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2020-10-10\",\n \"effectiveStartDate\": \"2020-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"isFreeShipping\": false,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10\",\n \"startingDate\": \"2020-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 150,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"USD\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans/:rate_plan_id/rateplan-charges","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id","rateplan-charges"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n}"},{"id":"0ae4b735-caac-44ff-b2a8-3e6122fae3af","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2020-10-10\",\n \"effectiveStartDate\": \"2020-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"isFreeShipping\": false,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10\",\n \"startingDate\": \"2020-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 150,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"USD\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans/:rate_plan_id/rateplan-charges","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id","rateplan-charges"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"6edcba9c-83f8-4834-a0cc-aa847750d2f8","name":"Resource not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2020-10-10\",\n \"effectiveStartDate\": \"2020-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"isFreeShipping\": false,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10\",\n \"startingDate\": \"2020-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 150,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"USD\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans/:rate_plan_id/rateplan-charges","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id","rateplan-charges"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"4ad1da98-585c-4045-a30d-f5558cd0b8c7","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2020-10-10\",\n \"effectiveStartDate\": \"2020-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"isFreeShipping\": false,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10\",\n \"startingDate\": \"2020-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 150,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"USD\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplans/:rate_plan_id/rateplan-charges","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplans",":rate_plan_id","rateplan-charges"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"3f0c8052-4ec6-45fb-bf25-f5ae6d6f9f9c"},{"name":"Update Subscription Rate plan charge","id":"0f288faf-fe1c-4670-a0e6-1133e59dbbd8","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update subscription rate plan charge by ID.
\n","urlObject":{"path":["subscriptions",":subscription_id","rateplan-charges",":rate_plan_charge_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"},{"description":{"content":"(Required) Rate plan charge Id
\n","type":"text/plain"},"type":"any","value":"2777","key":"rate_plan_charge_id"}]}},"response":[{"id":"33defa1c-c0ef-484a-bfa7-111ebea266bb","name":"A Rate plan charge updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2020-10-10\",\n \"effectiveStartDate\": \"2020-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 150,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"USD\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplan-charges/:rate_plan_charge_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplan-charges",":rate_plan_charge_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_charge_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n}"},{"id":"3d8beb32-bde6-4334-8c14-c541f10c36d6","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2020-10-10\",\n \"effectiveStartDate\": \"2020-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 150,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"USD\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplan-charges/:rate_plan_charge_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplan-charges",":rate_plan_charge_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_charge_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"190b027d-7e64-4401-9ac7-7d3da4f96363","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2020-10-10\",\n \"effectiveStartDate\": \"2020-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 150,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"USD\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplan-charges/:rate_plan_charge_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplan-charges",":rate_plan_charge_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_charge_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"ab9395e3-e4a9-4c22-b84d-de46435459e6","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2020-10-10\",\n \"effectiveStartDate\": \"2020-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 150,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"USD\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplan-charges/:rate_plan_charge_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplan-charges",":rate_plan_charge_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_charge_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"0f288faf-fe1c-4670-a0e6-1133e59dbbd8"},{"name":"Delete Subscription Rate plan charge","id":"ac64af63-af84-4882-9a47-5603ff03fc48","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete subscription rate plan charge.
\n","urlObject":{"path":["subscriptions",":subscription_id","rateplan-charges",":rate_plan_charge_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"},{"description":{"content":"(Required) Rate plan charge Id
\n","type":"text/plain"},"type":"any","value":"2777","key":"rate_plan_charge_id"}]}},"response":[{"id":"d6f08694-b2bb-4570-8422-37bf9bf81149","name":"Rate plan deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplan-charges/:rate_plan_charge_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplan-charges",":rate_plan_charge_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_charge_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"c7140914-2596-4300-b702-edcea00ce358","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplan-charges/:rate_plan_charge_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplan-charges",":rate_plan_charge_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_charge_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"996f1966-e385-4713-8ba0-9aebb5f4ec81","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/rateplan-charges/:rate_plan_charge_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","rateplan-charges",":rate_plan_charge_id"],"variable":[{"key":"subscription_id"},{"key":"rate_plan_charge_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"ac64af63-af84-4882-9a47-5603ff03fc48"}],"id":"68b4e149-5961-4d8d-8274-83fa87cbcad6","description":"Get subscription collection.
\n","urlObject":{"path":["subscriptions"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"rateplan,rateplanCharge,chargeTier,lastBillRun"},{"disabled":true,"description":{"content":"Order by
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"Sort by
\n","type":"text/plain"},"key":"sortBy","value":"asc"}],"variable":[]}},"response":[{"id":"6d5a5df9-aab8-4c27-99f2-d44efc3dee5f","name":"Subscription collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions?include=rateplan,rateplanCharge,chargeTier,lastBillRun&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["subscriptions"],"query":[{"key":"include","value":"rateplan,rateplanCharge,chargeTier,lastBillRun"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"detail\": null,\n \"id\": 1,\n \"lastBillRun\": null,\n \"lastCharge\": null,\n \"name\": \"Subscription name\",\n \"nextCharge\": \"2021-07-06 00:00:00\",\n \"offlinePaymentId\": null,\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"recurringChargeAmount\": 1843.139,\n \"recurringChargeQty\": 1,\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": null,\n \"shippingCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"UPS\",\n \"id\": 17,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"shippingServiceId\": \"02\",\n \"source\": \"publicApi\",\n \"sourceCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0,\n \"rateplan\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"id\": 7,\n \"lastCharge\": null,\n \"name\": \"Monthly\",\n \"nextCharge\": \"2021-03-31 00:00:00\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"productId\": 7,\n \"productName\": \"Product name\",\n \"productRateplanId\": 143,\n \"rateplanCharge\": [\n {\n \"billCycleDay\": {\n \"value\": \"Get subscription by ID.
\n","urlObject":{"path":["subscriptions",":subscription_id"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"rateplan,rateplanCharge,chargeTier,lastBillRun"}],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"3602a443-9cbb-4b97-be01-8f16c0eecef1","name":"Subscription resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id?include=rateplan,rateplanCharge,chargeTier,lastBillRun","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id"],"query":[{"key":"include","value":"rateplan,rateplanCharge,chargeTier,lastBillRun"}],"variable":[{"key":"subscription_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"detail\": null,\n \"id\": 1,\n \"lastBillRun\": null,\n \"lastCharge\": null,\n \"name\": \"Subscription name\",\n \"nextCharge\": \"2021-07-06 00:00:00\",\n \"offlinePaymentId\": null,\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"recurringChargeAmount\": 1843.139,\n \"recurringChargeQty\": 1,\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": null,\n \"shippingCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"UPS\",\n \"id\": 17,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"shippingServiceId\": \"02\",\n \"source\": \"publicApi\",\n \"sourceCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0,\n \"rateplan\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"id\": 7,\n \"lastCharge\": null,\n \"name\": \"Monthly\",\n \"nextCharge\": \"2021-03-31 00:00:00\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"productId\": 7,\n \"productName\": \"Product name\",\n \"productRateplanId\": 143,\n \"rateplanCharge\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n ],\n \"recurringChargeAmount\": -13031293,\n \"recurringChargeQty\": 1,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n ]\n}"},{"id":"7a43e28c-dbe7-437a-b73e-a7c362aeec4c","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id?include=rateplan,rateplanCharge,chargeTier,lastBillRun","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id"],"query":[{"key":"include","value":"rateplan,rateplanCharge,chargeTier,lastBillRun"}],"variable":[{"key":"subscription_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"3bd013e6-f301-48fd-bc0c-21241d692502","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id?include=rateplan,rateplanCharge,chargeTier,lastBillRun","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id"],"query":[{"key":"include","value":"rateplan,rateplanCharge,chargeTier,lastBillRun"}],"variable":[{"key":"subscription_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"d77e9ca1-7857-447a-b199-5c849e89dc7a"},{"name":"Create a Subscription","id":"f3229ab2-029a-49a8-8fec-878ed9f8311a","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create subscription.
\n","urlObject":{"path":["subscriptions"],"host":["{{host}}/{{version}}"],"query":[],"variable":[]}},"response":[{"id":"b62879e2-bcb5-46d9-9581-7eab73dfc51c","name":"A subscription was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyCurrencyId\": 4,\n \"companyGatewayId\": 13,\n \"customerId\": 4,\n \"customerPaymentMethodId\": 113,\n \"detail\": \"New subscription detail\",\n \"effectiveStartDate\": \"2021-05-01\",\n \"name\": \"New subscription name\",\n \"ratePlan\": [\n {\n \"name\": \"Rate Plan name\",\n \"productRatePlanId\": 124,\n \"ratePlanCharge\": [\n {\n \"productRatePlanChargeId\": 170,\n \"billCycleDay\": 42,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"perUnitPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2021-10-10\",\n \"effectiveStartDate\": \"2021-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"name\": \"Charge name\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2021-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 1500,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"uSd\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n }\n ]\n }\n ]\n}"},"url":"{{host}}/{{version}}/subscriptions"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"companyGateway\": [\n {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n }\n ],\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 128,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 55,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"detail\": null,\n \"id\": 1,\n \"lastCharge\": null,\n \"name\": \"Subscription name\",\n \"nextCharge\": \"2021-07-06 00:00:00\",\n \"offlinePaymentId\": null,\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"recurringChargeAmount\": 1843.139,\n \"recurringChargeQty\": 1,\n \"shippingAddress\": {},\n \"shippingAmount\": null,\n \"shippingCompanyIntegration\": {},\n \"shippingServiceId\": null,\n \"source\": \"publicApi\",\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n}"},{"id":"57915b81-244b-4ae2-8ba0-255a13979496","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"billingAddressId\": 143,\n \"companyCurrencyId\": 4,\n \"companyGatewayId\": 13,\n \"customerId\": 4,\n \"customerPaymentMethodId\": 113,\n \"detail\": \"New subscription detail\",\n \"effectiveStartDate\": \"2021-05-01\",\n \"name\": \"New subscription name\",\n \"ratePlan\": [\n {\n \"name\": \"Rate Plan name\",\n \"productRatePlanId\": 124,\n \"ratePlanCharge\": [\n {\n \"productRatePlanChargeId\": 170,\n \"billCycleDay\": 42,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"perUnitPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2021-10-10\",\n \"effectiveStartDate\": \"2021-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"name\": \"Charge name\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2021-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 1500,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"uSd\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n }\n ]\n }\n ]\n}"},"url":"{{host}}/{{version}}/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"727ffb0b-813e-4a36-8756-0149f5a4bb17","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyCurrencyId\": 4,\n \"companyGatewayId\": 13,\n \"customerId\": 4,\n \"customerPaymentMethodId\": 113,\n \"detail\": \"New subscription detail\",\n \"effectiveStartDate\": \"2021-05-01\",\n \"name\": \"New subscription name\",\n \"ratePlan\": [\n {\n \"name\": \"Rate Plan name\",\n \"productRatePlanId\": 124,\n \"ratePlanCharge\": [\n {\n \"productRatePlanChargeId\": 170,\n \"billCycleDay\": 42,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"perUnitPricing\",\n \"chargeType\": \"recurring\",\n \"description\": \"Description 1\",\n \"effectiveEndDate\": \"2021-10-10\",\n \"effectiveStartDate\": \"2021-10-10\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"name\": \"Charge name\",\n \"numberOfPeriods\": 1,\n \"quantity\": 34,\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2021-10-10\",\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"taxable\": true,\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": 1500,\n \"chargeTier\": [\n {\n \"startingUnit\": \"startingUnit1\",\n \"endingUnit\": \"endingUnit1\",\n \"currency\": \"uSd\",\n \"price\": 1251,\n \"priceFormat\": \"priceFormat1\",\n \"tier\": 1\n }\n ]\n }\n ]\n }\n ]\n}"},"url":"{{host}}/{{version}}/subscriptions"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"f3229ab2-029a-49a8-8fec-878ed9f8311a"},{"name":"Update a Subscription","id":"182f5f4f-6923-4b81-9f8c-0dd6c7f4576a","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update subscription by ID.
\n","urlObject":{"path":["subscriptions",":subscription_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"251e7acf-a933-4b0f-b361-b0327daffe82","name":"A Subscription updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"companyCurrencyId\": 4,\n \"customerPaymentMethodId\": 113,\n \"effectiveStartDate\": \"2020-01-01\",\n \"name\": \"Subscription name\",\n \"customerId\": 4,\n \"rateplan\": []\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id"],"variable":[{"key":"subscription_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"detail\": null,\n \"id\": 1,\n \"lastBillRun\": null,\n \"lastCharge\": null,\n \"name\": \"Subscription name\",\n \"nextCharge\": \"2021-07-06 00:00:00\",\n \"offlinePaymentId\": null,\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"recurringChargeAmount\": 1843.139,\n \"recurringChargeQty\": 1,\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": null,\n \"shippingCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"UPS\",\n \"id\": 17,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"shippingServiceId\": \"02\",\n \"source\": \"publicApi\",\n \"sourceCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n}"},{"id":"f1767aca-26c9-4a03-b676-e1ce6f3405ed","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billingAddressId\": 143,\n \"companyCurrencyId\": 4,\n \"customerPaymentMethodId\": 113,\n \"effectiveStartDate\": \"2020-01-01\",\n \"name\": \"Subscription name\",\n \"customerId\": 4,\n \"rateplan\": []\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id"],"variable":[{"key":"subscription_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"6121e0f6-4fee-4b4b-886f-658e0d309512","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"companyCurrencyId\": 4,\n \"customerPaymentMethodId\": 113,\n \"effectiveStartDate\": \"2020-01-01\",\n \"name\": \"Subscription name\",\n \"customerId\": 4,\n \"rateplan\": []\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id"],"variable":[{"key":"subscription_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"186f9bdc-5bb6-41f2-894f-1a2ce733077d","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"companyCurrencyId\": 4,\n \"customerPaymentMethodId\": 113,\n \"effectiveStartDate\": \"2020-01-01\",\n \"name\": \"Subscription name\",\n \"customerId\": 4,\n \"rateplan\": []\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id"],"variable":[{"key":"subscription_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"182f5f4f-6923-4b81-9f8c-0dd6c7f4576a"},{"name":"Delete a Subscription","id":"615a47d1-0f87-4cb3-ab69-0854af6819cc","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Delete subscription.
\n","urlObject":{"path":["subscriptions",":subscription_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"cedc738c-6180-469e-b850-46a8c3d733a3","name":"Subscription deleted.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id"],"variable":[{"key":"subscription_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"be030148-a801-47be-88cc-6148cc7fce1e","name":"Resource not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id"],"variable":[{"key":"subscription_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"42c75632-7057-426d-b360-dcb5ee1d84f2","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id"],"variable":[{"key":"subscription_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"615a47d1-0f87-4cb3-ab69-0854af6819cc"},{"name":"Update a Subscription Status","id":"8dd98c98-c74c-4fd2-a2fe-e59bd88b7001","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Update subscription.
\n","urlObject":{"path":["subscriptions",":subscription_id","status"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"ed08cee1-45f9-427d-8b48-3803f359ac8c","name":"A Subscription updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"active\"\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/status","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","status"],"variable":[{"key":"subscription_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"detail\": null,\n \"id\": 1,\n \"lastBillRun\": null,\n \"lastCharge\": null,\n \"name\": \"Subscription name\",\n \"nextCharge\": \"2021-07-06 00:00:00\",\n \"offlinePaymentId\": null,\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"recurringChargeAmount\": 1843.139,\n \"recurringChargeQty\": 1,\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": null,\n \"shippingCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"UPS\",\n \"id\": 17,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"shippingServiceId\": \"02\",\n \"source\": \"publicApi\",\n \"sourceCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0,\n \"rateplan\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"id\": 7,\n \"lastCharge\": null,\n \"name\": \"Monthly\",\n \"nextCharge\": \"2021-03-31 00:00:00\",\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"productId\": 7,\n \"productName\": \"Product name\",\n \"productRateplanId\": 143,\n \"rateplanCharge\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n ],\n \"recurringChargeAmount\": -13031293,\n \"recurringChargeQty\": 1,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n ]\n}"},{"id":"3708b6ed-2890-4f0e-89f3-4b8d832e1d94","name":"Bad request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"active\"\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/status","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","status"],"variable":[{"key":"subscription_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Valid status: active, requestPayment, paused, archived.\"\n}"},{"id":"3fef6e1f-0f92-4bca-94ca-0ab9ce90ae97","name":"Resource not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"active\"\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/status","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","status"],"variable":[{"key":"subscription_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"7b692d8b-2d7b-40e0-814c-fcae16ef2627","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"active\"\n}"},"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/status","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","status"],"variable":[{"key":"subscription_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"8dd98c98-c74c-4fd2-a2fe-e59bd88b7001"},{"name":"Get all Subscription External Invoices","id":"28122ce4-0e54-4fc7-bc6a-a4e6177b464e","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get all Subscription External Invoices.
\n","urlObject":{"path":["subscriptions",":subscription_id","external-invoices"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Filter by external id
\n","type":"text/plain"},"key":"externalId","value":"12091"},{"disabled":true,"description":{"content":"Order by
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"Sort by
\n","type":"text/plain"},"key":"sortBy","value":"asc"}],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"c0136da4-fb0a-4132-9d61-b633b338f2ca","name":"Subscription invoices response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/external-invoices?externalId=12091&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","external-invoices"],"query":[{"key":"externalId","value":"12091"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"subscription_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"createdAt\": \"2021-04-01 00:00:00\",\n \"externalDetail\": {\n \"order\": {\n \"id\": 12091,\n \"status\": \"Complete\",\n \"cart_id\": \"5cvfdsb16-91fb-4336-85fb-d24326453gtb78ea\",\n \"coupons\": {\n \"url\": \"https://api.bigcommerce.com/stores/test/v2/orders/12091/coupons\",\n \"resource\": \"/orders/12091/coupons\"\n },\n \"products\": {\n \"url\": \"https://api.bigcommerce.com/stores/test/v2/orders/12091/products\",\n \"resource\": \"/orders/12091/products\"\n },\n \"status_id\": 0,\n \"total_tax\": \"7.7100\",\n \"channel_id\": 1,\n \"ip_address\": \"\",\n \"is_deleted\": false,\n \"currency_id\": 1,\n \"customer_id\": 7,\n \"external_id\": null,\n \"items_total\": 2,\n \"staff_notes\": \"\",\n \"date_created\": \"Thu, 01 Apr 2021 13:30:33 +0000\",\n \"date_shipped\": \"\",\n \"order_source\": \"checkout_api\",\n \"subtotal_tax\": \"6.9100\",\n \"total_ex_tax\": \"77.0700\",\n \"currency_code\": \"USD\",\n \"custom_status\": \"Incomplete\",\n \"date_modified\": \"Thu, 01 Apr 2021 13:30:33 +0000\",\n \"ebay_order_id\": \"0\",\n \"geoip_country\": \"\",\n \"items_shipped\": 0,\n \"total_inc_tax\": \"84.7800\",\n \"payment_method\": \"\",\n \"payment_status\": \"\",\n \"billing_address\": {\n \"zip\": \"22923\",\n \"city\": \"Barboursville\",\n \"email\": \"jonh.doe@example.com\",\n \"phone\": \"\",\n \"state\": \"Virginia\",\n \"company\": \"\",\n \"country\": \"United States\",\n \"street_1\": \"123 Main St\",\n \"street_2\": \"\",\n \"last_name\": \"Jonh\",\n \"first_name\": \"Doe\",\n \"form_fields\": [],\n \"country_iso2\": \"US\"\n },\n \"coupon_discount\": \"0.0000\",\n \"customer_locale\": \"en\",\n \"discount_amount\": \"0.0000\",\n \"external_source\": null,\n \"is_email_opt_in\": false,\n \"refunded_amount\": \"0.0000\",\n \"subtotal_ex_tax\": \"69.1200\",\n \"tax_provider_id\": \"FixedTaxProvider\",\n \"credit_card_type\": null,\n \"customer_message\": \"\",\n \"order_is_digital\": false,\n \"subtotal_inc_tax\": \"76.0300\",\n \"handling_cost_tax\": \"0.0000\",\n \"shipping_cost_tax\": \"0.8000\",\n \"wrapping_cost_tax\": \"0.0000\",\n \"base_handling_cost\": \"0.0000\",\n \"base_shipping_cost\": \"7.9500\",\n \"base_wrapping_cost\": \"0.0000\",\n \"geoip_country_iso2\": \"\",\n \"shipping_addresses\": {\n \"url\": \"https://api.bigcommerce.com/stores/test/v2/orders/12091/shipping_addresses\",\n \"resource\": \"/orders/12091/shipping_addresses\"\n },\n \"default_currency_id\": 1,\n \"payment_provider_id\": null,\n \"store_credit_amount\": \"0.0000\",\n \"external_merchant_id\": null,\n \"handling_cost_ex_tax\": \"0.0000\",\n \"shipping_cost_ex_tax\": \"7.9500\",\n \"wrapping_cost_ex_tax\": \"0.0000\",\n \"default_currency_code\": \"USD\",\n \"handling_cost_inc_tax\": \"0.0000\",\n \"shipping_cost_inc_tax\": \"8.7500\",\n \"wrapping_cost_inc_tax\": \"0.0000\",\n \"currency_exchange_rate\": \"1.0000000000\",\n \"shipping_address_count\": 1,\n \"gift_certificate_amount\": \"0.0000\",\n \"handling_cost_tax_class_id\": 2,\n \"shipping_cost_tax_class_id\": 2,\n \"wrapping_cost_tax_class_id\": 3,\n \"store_default_currency_code\": \"USD\",\n \"store_default_to_transactional_exchange_rate\": \"1.0000000000\"\n },\n \"orderProducts\": [\n {\n \"id\": 2003,\n \"sku\": \"\",\n \"upc\": \"\",\n \"name\": \"Prod 1\",\n \"type\": \"physical\",\n \"depth\": \"0.0000\",\n \"width\": \"0.0000\",\n \"height\": \"0.0000\",\n \"weight\": \"1.0000\",\n \"order_id\": 12091,\n \"quantity\": 1,\n \"price_tax\": \"1.2300\",\n \"return_id\": 0,\n \"total_tax\": \"1.2300\",\n \"base_price\": \"12.3400\",\n \"base_total\": \"12.3400\",\n \"event_date\": \"\",\n \"event_name\": null,\n \"product_id\": 1464,\n \"variant_id\": 1773,\n \"external_id\": null,\n \"is_refunded\": false,\n \"ebay_item_id\": \"\",\n \"price_ex_tax\": \"12.3400\",\n \"total_ex_tax\": \"12.3400\",\n \"name_customer\": \"Prod 1\",\n \"name_merchant\": \"Prod 1\",\n \"option_set_id\": 160,\n \"price_inc_tax\": \"13.5700\",\n \"refund_amount\": \"0.0000\",\n \"total_inc_tax\": \"13.5700\",\n \"wrapping_name\": \"\",\n \"cost_price_tax\": \"0.0000\",\n \"base_cost_price\": \"0.0000\",\n \"product_options\": [\n {\n \"id\": 2994,\n \"name\": \"Save-in-subscription1616158689-1464\",\n \"type\": \"Multiple choice\",\n \"value\": \"965\",\n \"option_id\": 372,\n \"display_name\": \"Save in subscription\",\n \"display_style\": \"Dropdown\",\n \"display_value\": \"Monthly\",\n \"order_product_id\": 2003,\n \"product_option_id\": 458,\n \"display_name_customer\": \"Save in subscription\",\n \"display_name_merchant\": \"Save in subscription\",\n \"display_value_customer\": \"Monthly\",\n \"display_value_merchant\": \"Monthly\"\n }\n ],\n \"order_address_id\": 11592,\n \"quantity_shipped\": 0,\n \"wrapping_message\": \"\",\n \"applied_discounts\": [],\n \"cost_price_ex_tax\": \"0.0000\",\n \"quantity_refunded\": 0,\n \"wrapping_cost_tax\": \"0.0000\",\n \"base_wrapping_cost\": \"0.0000\",\n \"bin_picking_number\": \"\",\n \"cost_price_inc_tax\": \"0.0000\",\n \"fulfillment_source\": \"\",\n \"is_bundled_product\": false,\n \"configurable_fields\": [],\n \"ebay_transaction_id\": \"\",\n \"fixed_shipping_cost\": \"0.0000\",\n \"wrapping_cost_ex_tax\": \"0.0000\",\n \"wrapping_cost_inc_tax\": \"0.0000\",\n \"parent_order_product_id\": null\n }\n ]\n },\n \"externalId\": \"12091\",\n \"id\": 1,\n \"invoice\": {\n \"autoCollection\": true,\n \"balanceDue\": \"13.6000\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"comments\": \"comments\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerEmail\": \"jonh.doe@example.com\",\n \"customerName\": \"Jonh Doe\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"customerPhone\": \"404 55 4444\",\n \"dateDue\": \"2021-04-01 00:00:00\",\n \"dateFrom\": \"2021-04-01 00:00:00\",\n \"datePaid\": \"2021-04-01 13:30:36\",\n \"datePaymentRetry\": null,\n \"dateRefund\": null,\n \"dateTo\": \"2021-04-01 13:30:36\",\n \"dateVoid\": null,\n \"detail\": [],\n \"id\": 1,\n \"invoiceNo\": \"1406\",\n \"offlinePaymentId\": \"\",\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"refundAmount\": \"0.0000\",\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": \"12.0000\",\n \"shippingCompanyIntegration\": null,\n \"shippingServiceId\": \"A01\",\n \"shippingServiceName\": \"\",\n \"status\": \"cancel\",\n \"subtotalTaxExc\": \"69.1200\",\n \"subtotalTaxInc\": \"76.8300\",\n \"taxAmount\": \"7.7100\",\n \"taxCompanyIntegration\": null,\n \"taxRate\": \"0.0000\",\n \"terms\": \"\",\n \"total\": \"84.7800\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"success\",\n \"subscription\": {\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"detail\": null,\n \"id\": 1,\n \"lastBillRun\": null,\n \"lastCharge\": null,\n \"name\": \"Subscription name\",\n \"nextCharge\": \"2021-07-06 00:00:00\",\n \"offlinePaymentId\": null,\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"recurringChargeAmount\": 1843.139,\n \"recurringChargeQty\": 1,\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": null,\n \"shippingCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"UPS\",\n \"id\": 17,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"shippingServiceId\": \"02\",\n \"source\": \"publicApi\",\n \"sourceCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n },\n \"updatedAt\": \"2021-04-01 00:00:00\"\n }\n]"},{"id":"4932bcf2-5706-4a84-b39d-d82e491b4846","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/external-invoices?externalId=12091&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","external-invoices"],"query":[{"key":"externalId","value":"12091"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"subscription_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"282a6ffc-66e0-4b37-aaad-07093e2be87a","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/external-invoices?externalId=12091&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","external-invoices"],"query":[{"key":"externalId","value":"12091"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"subscription_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"28122ce4-0e54-4fc7-bc6a-a4e6177b464e"},{"name":"Get all Subscription External Invoices by Company Integration","id":"30eeb2e3-6127-45b0-a4ab-2a3ca816e9da","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get all Subscription External Invoices by Company Integration.
\n","urlObject":{"path":["subscriptions",":subscription_id","external-invoices",":company_integration_id"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Filter by external id
\n","type":"text/plain"},"key":"externalId","value":"12091"},{"disabled":true,"description":{"content":"Order by
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"Sort by
\n","type":"text/plain"},"key":"sortBy","value":"asc"}],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"},{"description":{"content":"(Required) Company Integration Id
\n","type":"text/plain"},"type":"any","value":"4","key":"company_integration_id"}]}},"response":[{"id":"0f25e28f-9166-477e-8c14-1428f5fe3e0c","name":"Subscription invoices response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/external-invoices/:company_integration_id?externalId=12091&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","external-invoices",":company_integration_id"],"query":[{"key":"externalId","value":"12091"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"subscription_id"},{"key":"company_integration_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"createdAt\": \"2021-04-01 00:00:00\",\n \"externalDetail\": {\n \"order\": {\n \"id\": 12091,\n \"status\": \"Complete\",\n \"cart_id\": \"5cvfdsb16-91fb-4336-85fb-d24326453gtb78ea\",\n \"coupons\": {\n \"url\": \"https://api.bigcommerce.com/stores/test/v2/orders/12091/coupons\",\n \"resource\": \"/orders/12091/coupons\"\n },\n \"products\": {\n \"url\": \"https://api.bigcommerce.com/stores/test/v2/orders/12091/products\",\n \"resource\": \"/orders/12091/products\"\n },\n \"status_id\": 0,\n \"total_tax\": \"7.7100\",\n \"channel_id\": 1,\n \"ip_address\": \"\",\n \"is_deleted\": false,\n \"currency_id\": 1,\n \"customer_id\": 7,\n \"external_id\": null,\n \"items_total\": 2,\n \"staff_notes\": \"\",\n \"date_created\": \"Thu, 01 Apr 2021 13:30:33 +0000\",\n \"date_shipped\": \"\",\n \"order_source\": \"checkout_api\",\n \"subtotal_tax\": \"6.9100\",\n \"total_ex_tax\": \"77.0700\",\n \"currency_code\": \"USD\",\n \"custom_status\": \"Incomplete\",\n \"date_modified\": \"Thu, 01 Apr 2021 13:30:33 +0000\",\n \"ebay_order_id\": \"0\",\n \"geoip_country\": \"\",\n \"items_shipped\": 0,\n \"total_inc_tax\": \"84.7800\",\n \"payment_method\": \"\",\n \"payment_status\": \"\",\n \"billing_address\": {\n \"zip\": \"22923\",\n \"city\": \"Barboursville\",\n \"email\": \"jonh.doe@example.com\",\n \"phone\": \"\",\n \"state\": \"Virginia\",\n \"company\": \"\",\n \"country\": \"United States\",\n \"street_1\": \"123 Main St\",\n \"street_2\": \"\",\n \"last_name\": \"Jonh\",\n \"first_name\": \"Doe\",\n \"form_fields\": [],\n \"country_iso2\": \"US\"\n },\n \"coupon_discount\": \"0.0000\",\n \"customer_locale\": \"en\",\n \"discount_amount\": \"0.0000\",\n \"external_source\": null,\n \"is_email_opt_in\": false,\n \"refunded_amount\": \"0.0000\",\n \"subtotal_ex_tax\": \"69.1200\",\n \"tax_provider_id\": \"FixedTaxProvider\",\n \"credit_card_type\": null,\n \"customer_message\": \"\",\n \"order_is_digital\": false,\n \"subtotal_inc_tax\": \"76.0300\",\n \"handling_cost_tax\": \"0.0000\",\n \"shipping_cost_tax\": \"0.8000\",\n \"wrapping_cost_tax\": \"0.0000\",\n \"base_handling_cost\": \"0.0000\",\n \"base_shipping_cost\": \"7.9500\",\n \"base_wrapping_cost\": \"0.0000\",\n \"geoip_country_iso2\": \"\",\n \"shipping_addresses\": {\n \"url\": \"https://api.bigcommerce.com/stores/test/v2/orders/12091/shipping_addresses\",\n \"resource\": \"/orders/12091/shipping_addresses\"\n },\n \"default_currency_id\": 1,\n \"payment_provider_id\": null,\n \"store_credit_amount\": \"0.0000\",\n \"external_merchant_id\": null,\n \"handling_cost_ex_tax\": \"0.0000\",\n \"shipping_cost_ex_tax\": \"7.9500\",\n \"wrapping_cost_ex_tax\": \"0.0000\",\n \"default_currency_code\": \"USD\",\n \"handling_cost_inc_tax\": \"0.0000\",\n \"shipping_cost_inc_tax\": \"8.7500\",\n \"wrapping_cost_inc_tax\": \"0.0000\",\n \"currency_exchange_rate\": \"1.0000000000\",\n \"shipping_address_count\": 1,\n \"gift_certificate_amount\": \"0.0000\",\n \"handling_cost_tax_class_id\": 2,\n \"shipping_cost_tax_class_id\": 2,\n \"wrapping_cost_tax_class_id\": 3,\n \"store_default_currency_code\": \"USD\",\n \"store_default_to_transactional_exchange_rate\": \"1.0000000000\"\n },\n \"orderProducts\": [\n {\n \"id\": 2003,\n \"sku\": \"\",\n \"upc\": \"\",\n \"name\": \"Prod 1\",\n \"type\": \"physical\",\n \"depth\": \"0.0000\",\n \"width\": \"0.0000\",\n \"height\": \"0.0000\",\n \"weight\": \"1.0000\",\n \"order_id\": 12091,\n \"quantity\": 1,\n \"price_tax\": \"1.2300\",\n \"return_id\": 0,\n \"total_tax\": \"1.2300\",\n \"base_price\": \"12.3400\",\n \"base_total\": \"12.3400\",\n \"event_date\": \"\",\n \"event_name\": null,\n \"product_id\": 1464,\n \"variant_id\": 1773,\n \"external_id\": null,\n \"is_refunded\": false,\n \"ebay_item_id\": \"\",\n \"price_ex_tax\": \"12.3400\",\n \"total_ex_tax\": \"12.3400\",\n \"name_customer\": \"Prod 1\",\n \"name_merchant\": \"Prod 1\",\n \"option_set_id\": 160,\n \"price_inc_tax\": \"13.5700\",\n \"refund_amount\": \"0.0000\",\n \"total_inc_tax\": \"13.5700\",\n \"wrapping_name\": \"\",\n \"cost_price_tax\": \"0.0000\",\n \"base_cost_price\": \"0.0000\",\n \"product_options\": [\n {\n \"id\": 2994,\n \"name\": \"Save-in-subscription1616158689-1464\",\n \"type\": \"Multiple choice\",\n \"value\": \"965\",\n \"option_id\": 372,\n \"display_name\": \"Save in subscription\",\n \"display_style\": \"Dropdown\",\n \"display_value\": \"Monthly\",\n \"order_product_id\": 2003,\n \"product_option_id\": 458,\n \"display_name_customer\": \"Save in subscription\",\n \"display_name_merchant\": \"Save in subscription\",\n \"display_value_customer\": \"Monthly\",\n \"display_value_merchant\": \"Monthly\"\n }\n ],\n \"order_address_id\": 11592,\n \"quantity_shipped\": 0,\n \"wrapping_message\": \"\",\n \"applied_discounts\": [],\n \"cost_price_ex_tax\": \"0.0000\",\n \"quantity_refunded\": 0,\n \"wrapping_cost_tax\": \"0.0000\",\n \"base_wrapping_cost\": \"0.0000\",\n \"bin_picking_number\": \"\",\n \"cost_price_inc_tax\": \"0.0000\",\n \"fulfillment_source\": \"\",\n \"is_bundled_product\": false,\n \"configurable_fields\": [],\n \"ebay_transaction_id\": \"\",\n \"fixed_shipping_cost\": \"0.0000\",\n \"wrapping_cost_ex_tax\": \"0.0000\",\n \"wrapping_cost_inc_tax\": \"0.0000\",\n \"parent_order_product_id\": null\n }\n ]\n },\n \"externalId\": \"12091\",\n \"id\": 1,\n \"invoice\": {\n \"autoCollection\": true,\n \"balanceDue\": \"13.6000\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"comments\": \"comments\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerEmail\": \"jonh.doe@example.com\",\n \"customerName\": \"Jonh Doe\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"customerPhone\": \"404 55 4444\",\n \"dateDue\": \"2021-04-01 00:00:00\",\n \"dateFrom\": \"2021-04-01 00:00:00\",\n \"datePaid\": \"2021-04-01 13:30:36\",\n \"datePaymentRetry\": null,\n \"dateRefund\": null,\n \"dateTo\": \"2021-04-01 13:30:36\",\n \"dateVoid\": null,\n \"detail\": [],\n \"id\": 1,\n \"invoiceNo\": \"1406\",\n \"offlinePaymentId\": \"\",\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"refundAmount\": \"0.0000\",\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": \"12.0000\",\n \"shippingCompanyIntegration\": null,\n \"shippingServiceId\": \"A01\",\n \"shippingServiceName\": \"\",\n \"status\": \"cancel\",\n \"subtotalTaxExc\": \"69.1200\",\n \"subtotalTaxInc\": \"76.8300\",\n \"taxAmount\": \"7.7100\",\n \"taxCompanyIntegration\": null,\n \"taxRate\": \"0.0000\",\n \"terms\": \"\",\n \"total\": \"84.7800\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"success\",\n \"subscription\": {\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"detail\": null,\n \"id\": 1,\n \"lastBillRun\": null,\n \"lastCharge\": null,\n \"name\": \"Subscription name\",\n \"nextCharge\": \"2021-07-06 00:00:00\",\n \"offlinePaymentId\": null,\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"recurringChargeAmount\": 1843.139,\n \"recurringChargeQty\": 1,\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": null,\n \"shippingCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"UPS\",\n \"id\": 17,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"shippingServiceId\": \"02\",\n \"source\": \"publicApi\",\n \"sourceCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n },\n \"updatedAt\": \"2021-04-01 00:00:00\",\n \"companyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n }\n]"},{"id":"be95a777-3c3d-4e77-8a60-aff1cfadd0e7","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/external-invoices/:company_integration_id?externalId=12091&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","external-invoices",":company_integration_id"],"query":[{"key":"externalId","value":"12091"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"subscription_id"},{"key":"company_integration_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"db7bd993-da5f-4701-b793-a73d64dbad06","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/external-invoices/:company_integration_id?externalId=12091&orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","external-invoices",":company_integration_id"],"query":[{"key":"externalId","value":"12091"},{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}],"variable":[{"key":"subscription_id"},{"key":"company_integration_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"30eeb2e3-6127-45b0-a4ab-2a3ca816e9da"},{"name":"Get the Subscription invoices","id":"296c736a-9b5b-4377-a77d-f72acacb1949","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get Subscription invoices.
\n","urlObject":{"path":["subscriptions",":subscription_id","invoices"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"02b0fadd-cf50-42b3-a4ad-c32b87a35731","name":"Subscription invoices response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/invoices","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","invoices"],"variable":[{"key":"subscription_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"autoCollection\": true,\n \"balanceDue\": \"13.6000\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"billRuns\": [\n {\n \"amount\": 1,\n \"completedOn\": \"2021-04-01 14:46:03\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"executedOn\": \"2021-04-01 13:00:39\",\n \"id\": 49,\n \"invoiceCount\": 1,\n \"limit\": null,\n \"repeatType\": \"daily\",\n \"status\": \"completed\",\n \"subscriptionCount\": 1,\n \"targetDate\": \"2021-04-01\",\n \"type\": null,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"comments\": \"comments\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerEmail\": \"jonh.doe@example.com\",\n \"customerName\": \"Jonh Doe\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"customerPhone\": \"404 55 4444\",\n \"dateDue\": \"2021-04-01 00:00:00\",\n \"dateFrom\": \"2021-04-01 00:00:00\",\n \"datePaid\": \"2021-04-01 13:30:36\",\n \"datePaymentRetry\": null,\n \"dateRefund\": null,\n \"dateTo\": \"2021-04-01 13:30:36\",\n \"dateVoid\": null,\n \"detail\": [\n {\n \"amount\": \"0.2000\",\n \"chargeCredit\": null,\n \"description\": \"description test\",\n \"id\": 6799,\n \"qty\": 2,\n \"taxAmount\": \"0.0000\",\n \"totalTaxExc\": \"0.4000\",\n \"totalTaxInc\": \"1.6000\",\n \"taxRate\": \"3.0000\",\n \"product\": {\n \"category\": \"physical\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"description\": \"This is a product description.\",\n \"effectiveEndDate\": \"2020-10-11\",\n \"effectiveStartDate\": \"2020-10-08\",\n \"id\": 8,\n \"internalProductId\": null,\n \"name\": \"Product name\",\n \"sku\": \"P-2\",\n \"status\": \"published\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"productRatePlanCharge\": {\n \"billCycleDay\": 1,\n \"billCycleType\": \"defaultFromCustomer\",\n \"billingPeriod\": \"month\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"flatFeePricing\",\n \"chargeTier\": [\n {\n \"active\": true,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"1\",\n \"id\": 70,\n \"price\": \"0.15\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"1\",\n \"tier\": \"1\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": null,\n \"description\": \"Description\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"height\": null,\n \"id\": 79,\n \"isFreeShipping\": false,\n \"listPriceBase\": null,\n \"maxQuantity\": null,\n \"minQuantity\": null,\n \"name\": \"Name\",\n \"numberOfPeriods\": null,\n \"priceIncreasePercentage\": null,\n \"productRateplan\": \"/v1/product-rateplans/7\",\n \"specificBillingPeriod\": 1,\n \"taxable\": false,\n \"taxClass\": null,\n \"taxCode\": \"NT\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": null,\n \"upToPeriodsType\": \"billingPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": null,\n \"weight\": \"1.0000\",\n \"width\": null\n },\n \"ratePlanCharge\": {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n },\n \"subscription\": {\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"detail\": null,\n \"id\": 1,\n \"lastBillRun\": null,\n \"lastCharge\": null,\n \"name\": \"Subscription name\",\n \"nextCharge\": \"2021-07-06 00:00:00\",\n \"offlinePaymentId\": null,\n \"oneTimeChargeAmount\": 0,\n \"oneTimeChargeQty\": 0,\n \"recurringChargeAmount\": 1843.139,\n \"recurringChargeQty\": 1,\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": null,\n \"shippingCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"UPS\",\n \"id\": 17,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"shippingServiceId\": \"02\",\n \"source\": \"publicApi\",\n \"sourceCompanyIntegration\": {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"displayName\": \"Bigcommerce\",\n \"id\": 8,\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"status\": \"active\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"usageChargeAmount\": 0,\n \"usageChargeQty\": 0\n }\n }\n ],\n \"id\": 1,\n \"invoiceNo\": \"1406\",\n \"offlinePaymentId\": \"\",\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"refundAmount\": \"0.0000\",\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": \"12.0000\",\n \"shippingCompanyIntegration\": null,\n \"shippingServiceId\": \"A01\",\n \"shippingServiceName\": \"\",\n \"status\": \"cancel\",\n \"subtotalTaxExc\": \"69.1200\",\n \"subtotalTaxInc\": \"76.8300\",\n \"taxAmount\": \"7.7100\",\n \"taxCompanyIntegration\": null,\n \"taxRate\": \"0.0000\",\n \"terms\": \"\",\n \"total\": \"84.7800\",\n \"transaction\": [\n {\n \"amount\": \"3.2500\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"companyPaymentRun\": null,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentSource\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"errorMessage\": \"\",\n \"id\": 5,\n \"invoiceId\": 1,\n \"kind\": \"desktop\",\n \"parentId\": \"\",\n \"paymentAccountName\": \"Marta Morales\",\n \"paymentAccountNumber\": \"4242\",\n \"paymentExpDate\": \"3/2022\",\n \"paymentMethod\": \"Visa\",\n \"paymentType\": \"card\",\n \"status\": \"settled\",\n \"transactionId\": \"ch_1IdfLAHM3LZNSqFlUZzWo7lZ\",\n \"type\": \"sale\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n]"},{"id":"296bb484-3383-4022-af71-eba1841d83fe","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/invoices","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","invoices"],"variable":[{"key":"subscription_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"0613314f-d8eb-42f1-b24f-ebe9e4d6dc22","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/invoices","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","invoices"],"variable":[{"key":"subscription_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"296c736a-9b5b-4377-a77d-f72acacb1949"},{"name":"Get the Subscription logs","id":"e4d5a2ce-b4bd-411d-ac41-6787089b48d5","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get Subscription logs.
\n","urlObject":{"path":["subscriptions",":subscription_id","logs"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"cd88a33d-ec97-40ba-89a4-91a0b0c67a0b","name":"Subscription logs response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/logs","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","logs"],"variable":[{"key":"subscription_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"createdAt\": \"2021-04-06 19:06:13\",\n \"id\": 1,\n \"jsonContent\": {\n \"request\": [],\n \"subscriptionId\": 4\n },\n \"level\": \"info\",\n \"name\": \"subscription_status_changed\",\n \"message\": \"A subscription status has been changed.\",\n \"source\": \"desktop\",\n \"user\": {\n \"id\": 4,\n \"firstName\": \"Jack\",\n \"lastName\": null,\n \"picture\": \"https://s.gravatar.com/avatar/eb753c9?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fpa.png\",\n \"phoneNum\": null,\n \"username\": \"Jack_user_name\"\n },\n \"updatedAt\": \"2021-04-06 19:06:13\"\n },\n {\n \"createdAt\": \"2021-04-05 15:41:19\",\n \"id\": 2,\n \"jsonContent\": {\n \"customerId\": 4,\n \"subscriptionId\": 4\n },\n \"level\": \"error\",\n \"name\": \"subscription_error_next_bill\",\n \"message\": \"An error occurred while trying get the subscription next bill.\",\n \"source\": \"desktop\",\n \"user\": {\n \"id\": 4,\n \"firstName\": \"Paul\",\n \"lastName\": null,\n \"picture\": \"https://s.gravatar.com/avatar/eb7534d77af41dc8a053d2d5e2F%2Fcdn.auth0.com%2Favatars%2Fpa.png\",\n \"phoneNum\": null,\n \"username\": \"Speedman\"\n },\n \"updatedAt\": \"2021-04-05 15:41:19\"\n }\n]"},{"id":"b780945a-c6df-49c4-ac05-aaf7ae1184b1","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/logs","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","logs"],"variable":[{"key":"subscription_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"ddd2759b-c341-4bef-adca-c61a8e909b5a","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/logs","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","logs"],"variable":[{"key":"subscription_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"e4d5a2ce-b4bd-411d-ac41-6787089b48d5"},{"name":"Get the Subscription next bill","id":"d31f3ae0-9802-4e11-9219-272bbaf69a3e","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get Subscription next bill.
\n","urlObject":{"path":["subscriptions",":subscription_id","nextBill"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Include relations. A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
\n","type":"text/plain"},"key":"include","value":"chargeTier"}],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"4","key":"subscription_id"}]}},"response":[{"id":"a8c2e017-31c4-4e97-a805-ae493720ed38","name":"Subscription next bill response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/nextBill?include=chargeTier","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","nextBill"],"query":[{"key":"include","value":"chargeTier"}],"variable":[{"key":"subscription_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"companyCurrency\": {\n \"companyGateway\": [\n {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\",\n \"isDefault\": true\n }\n ],\n \"conversionRate\": 1,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"fixedRate\": true,\n \"id\": 44,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"grandTotal\": 425.34,\n \"items\": [\n {\n \"billCycleDay\": null,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"tieredPricing\",\n \"chargeTier\": [\n {\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": \"USD\",\n \"endingUnit\": \"endingUnit1\",\n \"id\": 14,\n \"price\": \"12.51\",\n \"priceFormat\": \"priceFormat1\",\n \"startingUnit\": \"startingUnit1\",\n \"tier\": 1,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n ],\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"chargeType\": \"recurring\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"delay\": null,\n \"delayType\": null,\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2020-10-10 00:00:00\",\n \"effectiveStartDate\": \"2020-10-10 00:00:00\",\n \"endDateCondition\": \"subscriptionEnd\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge 1\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2020-10-10 00:00:00\",\n \"status\": \"active\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"usePriceFromSaleChannel\": false,\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n ],\n \"name\": \"Subscription name\",\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": null,\n \"shippingMethod\": {\n \"companyIntegrationId\": 7,\n \"carrierName\": \"Shopify\",\n \"serviceId\": 22,\n \"serviceName\": null\n },\n \"subtotal\": 425.34,\n \"taxAmount\": 0\n}"},{"id":"557ff302-d3b5-4b1a-824a-64b7808821c8","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/nextBill?include=chargeTier","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","nextBill"],"query":[{"key":"include","value":"chargeTier"}],"variable":[{"key":"subscription_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"8a83a08e-1319-44d7-91bb-de4a60f5c811","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/nextBill?include=chargeTier","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","nextBill"],"query":[{"key":"include","value":"chargeTier"}],"variable":[{"key":"subscription_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"d31f3ae0-9802-4e11-9219-272bbaf69a3e"},{"name":"Get Subscriptions upcoming","id":"f20572a9-1c72-47f6-a508-87a5fe9b09a1","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get subscription upcoming by ID.
\n","urlObject":{"path":["subscriptions",":subscription_id","upcoming"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Date since the subscriptions upcoming.
\n","type":"text/plain"},"key":"date","value":"2021-12-31"}],"variable":[{"description":{"content":"(Required) Subscription Id
\n","type":"text/plain"},"type":"any","value":"1","key":"subscription_id"}]}},"response":[{"id":"2656168d-3f38-43f6-8db1-1343125d17a8","name":"Subscription upcoming response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/upcoming?date=2021-12-31","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","upcoming"],"query":[{"key":"date","value":"2021-12-31"}],"variable":[{"key":"subscription_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"company\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"id\": 1,\n \"name\": \"Address book name\",\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"upcomingCharges\": [\n {\n \"date\": \"2021-12-31\",\n \"ratePlans\": [\n {\n \"name\": \"Monthly\",\n \"ratePlanCharges\": [\n {\n \"billCycleDay\": 42,\n \"billCycleType\": \"specificDayOfWeek\",\n \"billingPeriod\": \"week\",\n \"billingPeriodAlignment\": \"alignToCharge\",\n \"billingTiming\": \"inAdvance\",\n \"category\": \"physical\",\n \"chargeModel\": \"perUnitPricing\",\n \"chargeTier\": \"/v1/subscriptions/1?include=chargeTier\",\n \"chargeType\": \"recurring\",\n \"chargedThroughDate\": \"2020-01-06 00:00:00\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"depth\": \"1.0000\",\n \"description\": \"Description 1\",\n \"dimensionalRule\": \"rule1\",\n \"effectiveEndDate\": \"2021-10-10\",\n \"effectiveStartDate\": \"2021-10-10\",\n \"endDateCondition\": \"endDateCondition\",\n \"fixedShippingPrice\": \"20.0000\",\n \"height\": \"1.0000\",\n \"id\": 2777,\n \"isFreeShipping\": false,\n \"listPriceBase\": \"perMonth\",\n \"mrr\": null,\n \"name\": \"Charge name\",\n \"numberOfPeriods\": 1,\n \"originLocation\": \"origin1\",\n \"price\": \"10.00\",\n \"priceIncreasePercentage\": \"8\",\n \"processedThroughDate\": null,\n \"productRateplanChargeId\": 7,\n \"quantity\": 34,\n \"shippingAmount\": null,\n \"shippingGroup\": \"shippGrop1\",\n \"specificBillingPeriod\": 1,\n \"specificEndDate\": \"2021-10-10\",\n \"taxable\": true,\n \"taxClass\": null,\n \"taxCode\": \"taxCode\",\n \"taxMode\": \"taxExclusive\",\n \"updatedAt\": \"2021-03-01 00:00:00\",\n \"upToPeriods\": 1,\n \"upToPeriodsType\": \"billingpPeriods\",\n \"weeklyBillCycleDay\": \"monday\",\n \"weight\": \"1.5000\",\n \"width\": \"1.0000\"\n }\n ]\n }\n ],\n \"shipping\": 0,\n \"subtotal\": 25.02\n }\n ]\n}"},{"id":"bff69d87-ae1c-4f41-a882-442335d954f5","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/upcoming?date=2021-12-31","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","upcoming"],"query":[{"key":"date","value":"2021-12-31"}],"variable":[{"key":"subscription_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"a4974bcb-2480-403d-83b2-16994f0e2908","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/subscriptions/:subscription_id/upcoming?date=2021-12-31","host":["{{host}}/{{version}}"],"path":["subscriptions",":subscription_id","upcoming"],"query":[{"key":"date","value":"2021-12-31"}],"variable":[{"key":"subscription_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"f20572a9-1c72-47f6-a508-87a5fe9b09a1"}],"id":"0826062e-78ec-4381-9c4a-b9575827dfa6","description":"Rebillia Subscriptions allow your customers to subscribe your products or services that have recurring charges. For example, flat fee per month, quarterly per unit charge, or usage-based charges. Subscription charges can also include one-time charges, for example, an activation fee. Once a subscription has been created, you can make amendments on the subscriptions, and you can also cancel it.
\nIn addition to specifying the charges for your subscription, when creating a subscription you must also specify the subscription date, which is the date when you would like the charges for your subscription to take effect, and the bill cycle date, which is the day of the month that your customer is to be billed (for example, the fifth of the month).
\nOnce a subscription has been created, you can make amendments to it. Amendments allow you to make changes to active subscriptions.
\nWhen a subscription ends, you can either renew it or cancel it.
\n\n\nNote. Before you can create subscriptions, you must create a product catalog and customer accounts. The product catalog includes the products that are used by subscriptions, and your customers pay for subscriptions.
\n
Get transaction collection.
\n","urlObject":{"path":["transactions"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Order by
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"Sort by
\n","type":"text/plain"},"key":"sortBy","value":"asc"}],"variable":[]}},"response":[{"id":"ecf12934-f2dc-4dc7-9765-9f45eb1397af","name":"Transaction collection response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/transactions?orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["transactions"],"query":[{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"amount\": \"3.2500\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"companyPaymentRun\": null,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentSource\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"errorMessage\": \"\",\n \"id\": 5,\n \"invoiceId\": 1,\n \"kind\": \"desktop\",\n \"parentId\": \"\",\n \"paymentAccountName\": \"Marta Morales\",\n \"paymentAccountNumber\": \"4242\",\n \"paymentExpDate\": \"3/2022\",\n \"paymentMethod\": \"Visa\",\n \"paymentType\": \"card\",\n \"status\": \"settled\",\n \"transactionId\": \"ch_1IdfLAHM3LZNSqFlUZzWo7lZ\",\n \"type\": \"sale\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n]"},{"id":"5de912af-6727-48b2-8dcc-5f14ba58ea6b","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/transactions?orderBy=id&sortBy=asc","host":["{{host}}/{{version}}"],"path":["transactions"],"query":[{"key":"orderBy","value":"id"},{"key":"sortBy","value":"asc"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"c25b686f-5751-4510-b2f4-258a21a4c31c"},{"name":"Get a Transaction","id":"75ecff84-3650-48c3-883b-8e9c52af0356","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Get transaction by ID.
\n","urlObject":{"path":["transactions",":transaction_id"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Transaction Id
\n","type":"text/plain"},"type":"any","value":"8","key":"transaction_id"}]}},"response":[{"id":"bfa926f9-ca8d-454f-8d03-ea2d3d5451b8","name":"Transaction resource response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/transactions/:transaction_id","host":["{{host}}/{{version}}"],"path":["transactions",":transaction_id"],"variable":[{"key":"transaction_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"transaction\": {\n \"amount\": \"3.2500\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"companyPaymentRun\": null,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentSource\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"errorMessage\": \"\",\n \"id\": 5,\n \"invoiceId\": 1,\n \"kind\": \"desktop\",\n \"parentId\": \"\",\n \"paymentAccountName\": \"Marta Morales\",\n \"paymentAccountNumber\": \"4242\",\n \"paymentExpDate\": \"3/2022\",\n \"paymentMethod\": \"Visa\",\n \"paymentType\": \"card\",\n \"status\": \"settled\",\n \"transactionId\": \"ch_1IdfLAHM3LZNSqFlUZzWo7lZ\",\n \"type\": \"sale\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"dataGateway\": \"\",\n \"invoice\": {\n \"autoCollection\": true,\n \"balanceDue\": \"13.6000\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"comments\": \"comments\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerEmail\": \"jonh.doe@example.com\",\n \"customerName\": \"Jonh Doe\",\n \"customerPaymentMethod\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"customerPhone\": \"404 55 4444\",\n \"dateDue\": \"2021-04-01 00:00:00\",\n \"dateFrom\": \"2021-04-01 00:00:00\",\n \"datePaid\": \"2021-04-01 13:30:36\",\n \"datePaymentRetry\": null,\n \"dateRefund\": null,\n \"dateTo\": \"2021-04-01 13:30:36\",\n \"dateVoid\": null,\n \"detail\": [],\n \"id\": 1,\n \"invoiceNo\": \"1406\",\n \"offlinePaymentId\": \"\",\n \"paymentType\": \"thirdPartyPaymentProvider\",\n \"refundAmount\": \"0.0000\",\n \"shippingAddress\": {\n \"city\": \"Barboursville\",\n \"contactCompany\": null,\n \"contactEmail\": \"contact@example.com\",\n \"contactName\": \"Mike Smith\",\n \"contactPhone\": \"404 55 5555\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"type\": \"residential\",\n \"zip\": \"22923\"\n },\n \"shippingAmount\": \"12.0000\",\n \"shippingCompanyIntegration\": null,\n \"shippingServiceId\": \"A01\",\n \"shippingServiceName\": \"\",\n \"status\": \"cancel\",\n \"subtotalTaxExc\": \"69.1200\",\n \"subtotalTaxInc\": \"76.8300\",\n \"taxAmount\": \"7.7100\",\n \"taxCompanyIntegration\": null,\n \"taxRate\": \"0.0000\",\n \"terms\": \"\",\n \"total\": \"84.7800\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n }\n}"},{"id":"1ee74408-1edf-4217-9267-0fbc5c1c95a2","name":"Resource not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/transactions/:transaction_id","host":["{{host}}/{{version}}"],"path":["transactions",":transaction_id"],"variable":[{"key":"transaction_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"18473095-de8f-482a-80ce-67ee3f423940","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/{{version}}/transactions/:transaction_id","host":["{{host}}/{{version}}"],"path":["transactions",":transaction_id"],"variable":[{"key":"transaction_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"75ecff84-3650-48c3-883b-8e9c52af0356"},{"name":"Create a Refund","id":"b8b97400-6aa9-4b35-b596-cecf5180c74e","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create refund.
\n","urlObject":{"path":["transactions",":transaction_id","refund"],"host":["{{host}}/{{version}}"],"query":[{"disabled":true,"description":{"content":"Amount to refund
\n","type":"text/plain"},"key":"amount","value":"2.5"}],"variable":[{"description":{"content":"(Required) Transaction Id
\n","type":"text/plain"},"type":"any","value":"8","key":"transaction_id"}]}},"response":[{"id":"ef38febf-7d59-48dd-94d9-36936573962f","name":"Transaction refunded","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/{{version}}/transactions/:transaction_id/refund?amount=2.5","host":["{{host}}/{{version}}"],"path":["transactions",":transaction_id","refund"],"query":[{"key":"amount","value":"2.5"}],"variable":[{"key":"transaction_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"amount\": \"3.2500\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"companyPaymentRun\": null,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentSource\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"errorMessage\": \"\",\n \"id\": 5,\n \"invoiceId\": 1,\n \"kind\": \"desktop\",\n \"parentId\": \"\",\n \"paymentAccountName\": \"Marta Morales\",\n \"paymentAccountNumber\": \"4242\",\n \"paymentExpDate\": \"3/2022\",\n \"paymentMethod\": \"Visa\",\n \"paymentType\": \"card\",\n \"status\": \"settled\",\n \"transactionId\": \"ch_1IdfLAHM3LZNSqFlUZzWo7lZ\",\n \"type\": \"sale\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"5ad5f7f1-db20-4290-ad99-93dc200f0c79","name":"Bad request","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/{{version}}/transactions/:transaction_id/refund?amount=2.5","host":["{{host}}/{{version}}"],"path":["transactions",":transaction_id","refund"],"query":[{"key":"amount","value":"2.5"}],"variable":[{"key":"transaction_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_form_attributes\",\n \"message\": \"Invalid form data\"\n}"},{"id":"97665f91-a000-4473-bebb-2041e3e422d5","name":"Resource not found","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/{{version}}/transactions/:transaction_id/refund?amount=2.5","host":["{{host}}/{{version}}"],"path":["transactions",":transaction_id","refund"],"query":[{"key":"amount","value":"2.5"}],"variable":[{"key":"transaction_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"1e90801f-1d86-40fb-80ea-523577130406","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/{{version}}/transactions/:transaction_id/refund?amount=2.5","host":["{{host}}/{{version}}"],"path":["transactions",":transaction_id","refund"],"query":[{"key":"amount","value":"2.5"}],"variable":[{"key":"transaction_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"b8b97400-6aa9-4b35-b596-cecf5180c74e"},{"name":"Void a Transaction","id":"11d80df6-4817-440e-8ae6-d8579779548e","request":{"auth":{"type":"apikey","apikey":{"value":"{{access_token}}","key":"Create void transaction.
\n","urlObject":{"path":["transactions",":transaction_id","void"],"host":["{{host}}/{{version}}"],"query":[],"variable":[{"description":{"content":"(Required) Transaction Id
\n","type":"text/plain"},"type":"any","value":"8","key":"transaction_id"}]}},"response":[{"id":"57008e9f-52a0-436d-b8b9-00c3369ed7a1","name":"Transaction voided","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/{{version}}/transactions/:transaction_id/void","host":["{{host}}/{{version}}"],"path":["transactions",":transaction_id","void"],"variable":[{"key":"transaction_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"amount\": \"3.2500\",\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"companyPaymentRun\": null,\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"currency\": {\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 124,\n \"iso3\": \"USD\",\n \"name\": \"US Dollar\",\n \"numericCode\": 840,\n \"symbol\": null\n },\n \"customer\": {\n \"agent\": null,\n \"businessName\": \"Rebillia LLC\",\n \"createdAt\": \"2021-03-01 00:00:00\",\n \"customerId\": \"\",\n \"email\": \"jonh.doe@example.com\",\n \"firstName\": \"Jonh\",\n \"id\": 4,\n \"lastName\": \"Doe\",\n \"locale\": \"es\",\n \"phoneExt\": null,\n \"phoneNum\": \"404 55 4444\",\n \"preferredCurrency\": \"us\",\n \"status\": \"active\",\n \"taxExempt\": false,\n \"updatedAt\": \"2021-03-01 00:00:00\"\n },\n \"customerPaymentSource\": {\n \"accountName\": \"Marta Morales\",\n \"accountNumber\": \"4242\",\n \"accountType\": \"Visa\",\n \"bankName\": \"\",\n \"billingAddress\": {\n \"city\": \"Barboursville\",\n \"country\": {\n \"alpha2Code\": \"US\",\n \"alpha3Code\": \"USA\",\n \"flag\": \"https://restcountries.eu/data/usa.svg\",\n \"id\": 240,\n \"name\": \"United States of America\",\n \"numericCode\": 840\n },\n \"state\": \"Virginia\",\n \"street1\": \"123 Main St\",\n \"street2\": \"\",\n \"zip\": \"22923\"\n },\n \"companyGateway\": {\n \"credentialsLastUpdate\": \"2020-07-29 20:28:46\",\n \"displayName\": \"Stripe\",\n \"id\": 3412,\n \"status\": \"active\",\n \"type\": \"thirdPartyPaymentProvider\"\n },\n \"expDate\": \"3/2022\",\n \"id\": 44,\n \"routingNumber\": null,\n \"type\": \"card\",\n \"verified\": \"\"\n },\n \"errorMessage\": \"\",\n \"id\": 5,\n \"invoiceId\": 1,\n \"kind\": \"desktop\",\n \"parentId\": \"\",\n \"paymentAccountName\": \"Marta Morales\",\n \"paymentAccountNumber\": \"4242\",\n \"paymentExpDate\": \"3/2022\",\n \"paymentMethod\": \"Visa\",\n \"paymentType\": \"card\",\n \"status\": \"settled\",\n \"transactionId\": \"ch_1IdfLAHM3LZNSqFlUZzWo7lZ\",\n \"type\": \"sale\",\n \"updatedAt\": \"2021-03-01 00:00:00\"\n}"},{"id":"9f75544d-9b50-4385-976b-098cd31752fd","name":"Resource not found","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/{{version}}/transactions/:transaction_id/void","host":["{{host}}/{{version}}"],"path":["transactions",":transaction_id","void"],"variable":[{"key":"transaction_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_not_found_resource\",\n \"message\": \"The resource that try to access not exist in this company.\"\n}"},{"id":"d5e983fb-501f-4c2d-8447-e75d63d8a72d","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{host}}/{{version}}/transactions/:transaction_id/void","host":["{{host}}/{{version}}"],"path":["transactions",":transaction_id","void"],"variable":[{"key":"transaction_id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error_server_api\",\n \"message\": \"In this moment we can not process your request.\"\n}"}],"_postman_id":"11d80df6-4817-440e-8ae6-d8579779548e"}],"id":"b63d4434-6d5d-486f-97a4-57e7010d07aa","description":"