{ "uuid": "681f3d63-2cb6-476a-9b40-15de992c3b81", "lastMigration": 29, "name": "API Reference: Billing", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "7e921599-9f8b-4a37-8707-d9ebcbbb3bc6", "documentation": "List charge metrics by time range", "method": "get", "endpoint": "charge-metrics/data/charge-metrics", "responses": [ { "uuid": "0077cacc-8f8c-4603-a53c-b4a3ac38f2fb", "body": "", "latency": 0, "statusCode": 200, "label": "", "headers": [ { "key": "Content-Type", "value": "application/json-seq" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "991217f5-a67e-43a3-81fa-1b9d9deae1cf", "body": "", "latency": 0, "statusCode": 400, "label": "Invalid Parameters", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7c5f9bb3-6ead-4ae5-8f13-90fbfdccbc49", "body": "", "latency": 0, "statusCode": 429, "label": "Rate limited", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Retry-After", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c129113a-451c-4e7b-93a3-3c11891fcf61", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Error", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ca048ec1-9e43-4a69-ad41-a02db4c286cb", "documentation": "List discount allocation details by time range", "method": "get", "endpoint": "charge-metrics/data/charge-metrics-discount-allocation-detail", "responses": [ { "uuid": "5795f8fb-8a69-4397-8f11-b4a836371bd7", "body": "{\n \"amendmentId\": \"\",\n \"amendmentType\": \"\",\n \"chargeMetricsId\": \"\",\n \"chargeNumber\": \"\",\n \"createdOn\": \"{{faker 'date.recent' 365}}\",\n \"currency\": \"\",\n \"deleted\": {{faker 'datatype.boolean'}},\n \"discountChargeNumber\": \"\",\n \"discountMrr\": {{faker 'number.int' max=99999}},\n \"discountTcv\": {{faker 'number.int' max=99999}},\n \"endDate\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\",\n \"id\": \"\",\n \"invoiceOwnerAccountNumber\": \"\",\n \"productId\": \"\",\n \"productRatePlanChargeId\": \"\",\n \"productRatePlanId\": \"\",\n \"ratePlanChargeId\": \"\",\n \"startDate\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\",\n \"subscriptionName\": \"\",\n \"subscriptionOwnerAccountNumber\": \"\",\n \"updatedOn\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3ff36573-fd2a-4f7f-b435-42b0e43d1f1c", "body": "", "latency": 0, "statusCode": 400, "label": "Invalid Parameters", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bdfac0e2-02ae-46e4-95eb-5af2dd347635", "body": "", "latency": 0, "statusCode": 429, "label": "Rate limited", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Retry-After", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0a900392-ffcc-4d35-91e3-bb19d4e8b7bd", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Error", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "464ece28-51d4-4d27-b9ee-607f455152f3", "documentation": "List event triggers", "method": "get", "endpoint": "events/event-triggers", "responses": [ { "uuid": "8e7528d6-1d21-4a3f-8690-92b073308afd", "body": "", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d8ee6bf0-949b-45f2-b169-215b53dde261", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "aa3c0f4d-e3ce-49d1-b114-dc7444daadc6", "body": "", "latency": 0, "statusCode": 500, "label": "Server Error", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "43675e99-6dcf-4eaa-911e-2545e3f6ab06", "documentation": "Create an event trigger", "method": "post", "endpoint": "events/event-triggers", "responses": [ { "uuid": "ab847ad1-7c85-453c-8fb7-5ed83f61cfff", "body": "", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "931ea5dc-1f44-4f3b-86e7-f5c5714c25ac", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9fee3b71-8976-402a-9e0a-0747985bc0ae", "body": "", "latency": 0, "statusCode": 500, "label": "Server Error", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f4323ab6-47d1-4921-af18-32fba37bbb7e", "documentation": "Delete an event trigger", "method": "delete", "endpoint": "events/event-triggers/:id", "responses": [ { "uuid": "790f40b8-fff4-41dc-adaf-093764539bd1", "body": "", "latency": 0, "statusCode": 204, "label": "No Content", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e9d84316-20d1-4a0c-9352-c939f635ea0f", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "76b4126e-09b7-4059-aaeb-fe4dac6f2b03", "body": "", "latency": 0, "statusCode": 500, "label": "Server Error", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6d3c070d-0e0c-4956-a81d-475c9ab174a0", "documentation": "Retrieve an event trigger", "method": "get", "endpoint": "events/event-triggers/:id", "responses": [ { "uuid": "9a11ce1c-7ad7-4677-9e82-b44d2251ffb3", "body": "", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "79c14811-b364-4388-a65a-7d1423c53bb7", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "da8fb334-1625-4759-8897-a41bfdec3cea", "body": "", "latency": 0, "statusCode": 500, "label": "Server Error", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "618ab7c0-e99c-492a-a11d-e942a5c4bf07", "documentation": "Update an event trigger", "method": "put", "endpoint": "events/event-triggers/:id", "responses": [ { "uuid": "a9d36b37-c1ed-4bcd-b625-e263949200c5", "body": "", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e0e55503-8017-403f-9a09-1d51a35ffaa5", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "19d64c33-e435-4e89-8caa-1ef0edaffb9e", "body": "", "latency": 0, "statusCode": 500, "label": "Server Error", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "RateLimit-Limit", "value": "" }, { "key": "RateLimit-Remaining", "value": "" }, { "key": "RateLimit-Reset", "value": "" }, { "key": "Zuora-Request-Id", "value": "" }, { "key": "Zuora-Track-Id", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ba6cac9f-b8d3-45c9-8f4c-f830919e937e", "documentation": "List email templates", "method": "get", "endpoint": "notifications/email-templates", "responses": [ { "uuid": "e3750e05-43fb-4913-a60f-1dda4e32d9ab", "body": "{\n \"data\": [\n {\n \"active\": true,\n \"bccEmailAddress\": \"user@example.com\",\n \"ccEmailAddress\": \"user@example.com\",\n \"ccEmailType\": \"SpecificEmails\",\n \"createdBy\": \"6e569e1e05f040eda51a927b140c0ac3\",\n \"createdOn\": \"2017-04-18T07:36:19.798Z\",\n \"description\": \"Email when an account is edited\",\n \"emailBody\": \"Dear user,
the account Example Co. Ltd.\",\n \"emailSubject\": \"Account the account Example Co. Ltd.\",\n \"emailSubject\": \"Account the account Example Co. Ltd.\",\n \"emailSubject\": \"Account the account Example Co. Ltd.\",\n \"emailSubject\": \"Account