{"info":{"_postman_id":"5531be3a-83dc-454f-b4e2-331723fd60bf","name":"AURA Gateway Integrations","description":"

How to get started

\n

A staging portal login will be given to you along with the URL for the AURA portal. This will give you access to both your clientId and clientSecret to generate a token and start interacting with the AURA Panic API.

\n
    \n
  1. Login to your AURA portal
    2. \n
  2. Click on the 'integration' tab
    3. \n
  3. Under the 'integration' tab, click on 'view applications'. Your clientId and clientSecret can be seen from here
    4. \n
\n\n\n

Responder Simulator

\n

The responder simulator within the tools tab allows you to go through each stage of the panic flow. The simulator allows you to simulate a real or test panic.

\n

When simulating a panic with a newly registered customer, you will need to post a test panic first in order to verify that customer before you will be able to simulate a real panic.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"23453558","collectionId":"5531be3a-83dc-454f-b4e2-331723fd60bf","publishedId":"2s93m33iXq","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-05-22T10:25:08.000Z"},"item":[{"name":"AURA White-Label Application Payment Gateway","item":[{"name":"Authentication","item":[{"name":"Server Token","id":"c4e6e270-0576-40ec-8641-14e57a8aeae4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"clientId\":\"xxx\",\n\t\"clientSecret\":\"123abc321\"\n}"},"url":"https://{{panicApiUrl}}/v2/oauth/token","description":"

Fetches an authorization token using API keys.

\n","urlObject":{"protocol":"https","path":["v2","oauth","token"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"71ac63ad-e7d5-4808-affc-3bdec816270a","name":"Success 200","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"clientId\":\"xxx\",\n\t\"clientSecret\":\"xxx\"\n}"},"url":"https://{{panicApiUrl}}/v2/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1085"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"date","value":"Thu, 04 Aug 2022 13:48:32 GMT"},{"key":"etag","value":"W/\"43d-chf0Pn9KoHA+C/J+M8cTSg\""},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"xxx\",\n \"expiresIn\": 2147483647,\n \"tokenType\": \"Bearer\"\n}"},{"id":"6053c437-4ba7-4c2a-b1fe-ca66cc581bf3","name":"Invalid clientId or clientSecret 400","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"clientId\":\"xxx\",\n\t\"clientSecret\":\"123abc321\"\n}"},"url":"https://{{panicApiUrl}}/v2/oauth/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"date","value":"Thu, 06 Oct 2022 11:43:41 GMT"},{"key":"etag","value":"W/\"2b-BtnDBcVLf5mXABQzF2+SDQ\""},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Could not authenticate clientId\"\n}"}],"_postman_id":"c4e6e270-0576-40ec-8641-14e57a8aeae4"}],"id":"3abd6bae-0581-478d-842e-479eb9410480","_postman_id":"3abd6bae-0581-478d-842e-479eb9410480","description":""},{"name":"Viewing Subscription Types","item":[{"name":"View Subscription types & limitations","id":"d0bf5d9c-41c6-4157-be25-bfaf1db73fb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"url":"https://{{panicApiUrl}}/v2/subscriptions/subscriptionTypes","description":"

This allows you to view all active subscriptionTypes offered by AURA for your customerSource.

\n

AURA offers both single subscriptions and family subscription types.

\n

When issuing subscriptions via your payment gateway, WEB_SIGNUP_SINGLE or WEB_SIGNUP_FAMILY are the subscription types that must be issued to the customer. These subscription type ids can be found within the response to this request.

\n

Please take note that family subscriptions work with dependants. Examples of how to implement this can be seen here.

\n","urlObject":{"protocol":"https","path":["v2","subscriptions","subscriptionTypes"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"be9a93eb-bd8f-45f3-98c0-c8e72d8162f4","name":"Subscription Types - 200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"url":"https://{{panicApiUrl}}/v2/subscriptions/subscriptionTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"5472"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"1560-7iXeW36Tnyung+VAmCi1tA\""},{"key":"x-ratelimit-reset","value":"1665396200"},{"key":"date","value":"Mon, 10 Oct 2022 10:02:33 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully returned subscriptionTypes\",\n \"subscriptionTypes\": [\n {\n \"id\": 1,\n \"description\": \"Coupon-Code single subscription\",\n \"value\": \"COUPON_SINGLE\",\n \"createdAt\": \"2019-03-05T13:06:51.235Z\",\n \"updatedAt\": \"2019-03-05T13:06:51.235Z\",\n \"numberOfAllowedDependents\": null,\n \"recurringBilling\": false\n },\n {\n \"id\": 2,\n \"description\": \"API single subscription\",\n \"value\": \"API_SINGLE\",\n \"createdAt\": \"2019-04-04T08:03:29.253Z\",\n \"updatedAt\": \"2019-04-04T08:03:29.253Z\",\n \"numberOfAllowedDependents\": null,\n \"recurringBilling\": false\n },\n {\n \"id\": 3,\n \"description\": \"SMS single subscription\",\n \"value\": \"SMS_SINGLE\",\n \"createdAt\": \"2019-07-23T12:00:51.859Z\",\n \"updatedAt\": \"2019-07-23T12:00:51.859Z\",\n \"numberOfAllowedDependents\": null,\n \"recurringBilling\": false\n },\n {\n \"id\": 4,\n \"description\": \"Web-signup single subscription\",\n \"value\": \"WEB_SIGNUP_SINGLE\",\n \"createdAt\": \"2019-07-30T11:15:14.237Z\",\n \"updatedAt\": \"2019-07-30T11:15:14.237Z\",\n \"numberOfAllowedDependents\": null,\n \"recurringBilling\": false\n },\n {\n \"id\": 5,\n \"description\": \"WhatsApp single subscription\",\n \"value\": \"WHATSAPP_SINGLE\",\n \"createdAt\": \"2020-06-29T07:53:31.538Z\",\n \"updatedAt\": \"2020-06-29T07:53:31.538Z\",\n \"numberOfAllowedDependents\": null,\n \"recurringBilling\": true\n },\n {\n \"id\": 6,\n \"description\": \"Call-Centre single subscription\",\n \"value\": \"CALL_CENTRE_SINGLE\",\n \"createdAt\": \"2020-12-21T11:58:08.732Z\",\n \"updatedAt\": \"2020-12-21T11:58:08.732Z\",\n \"numberOfAllowedDependents\": null,\n \"recurringBilling\": false\n },\n {\n \"id\": 7,\n \"description\": \"Stripe single subscription\",\n \"value\": \"STRIPE_SINGLE\",\n \"createdAt\": \"2021-03-30T09:30:08.120Z\",\n \"updatedAt\": \"2021-03-30T09:30:08.120Z\",\n \"numberOfAllowedDependents\": null,\n \"recurringBilling\": true\n },\n {\n \"id\": 8,\n \"description\": \"Stripe family subscription\",\n \"value\": \"STRIPE_FAMILY\",\n \"createdAt\": \"2021-03-30T09:30:08.120Z\",\n \"updatedAt\": \"2021-03-30T09:30:08.120Z\",\n \"numberOfAllowedDependents\": \"4\",\n \"recurringBilling\": true\n },\n {\n \"id\": 11,\n \"description\": \"Coupon-Code family subscription\",\n \"value\": \"COUPON_FAMILY\",\n \"createdAt\": \"2021-04-28T06:20:57.877Z\",\n \"updatedAt\": \"2021-04-28T06:20:57.877Z\",\n \"numberOfAllowedDependents\": \"4\",\n \"recurringBilling\": false\n },\n {\n \"id\": 12,\n \"description\": \"API family subscription\",\n \"value\": \"API_FAMILY\",\n \"createdAt\": \"2021-04-28T06:20:57.877Z\",\n \"updatedAt\": \"2021-04-28T06:20:57.877Z\",\n \"numberOfAllowedDependents\": \"4\",\n \"recurringBilling\": false\n },\n {\n \"id\": 13,\n \"description\": \"SMS family subscription\",\n \"value\": \"SMS_FAMILY\",\n \"createdAt\": \"2021-04-28T06:20:57.877Z\",\n \"updatedAt\": \"2021-04-28T06:20:57.877Z\",\n \"numberOfAllowedDependents\": \"4\",\n \"recurringBilling\": false\n },\n {\n \"id\": 14,\n \"description\": \"Web-Signup family subscription\",\n \"value\": \"WEB_SIGNUP_FAMILY\",\n \"createdAt\": \"2021-04-28T06:20:57.877Z\",\n \"updatedAt\": \"2021-04-28T06:20:57.877Z\",\n \"numberOfAllowedDependents\": \"4\",\n \"recurringBilling\": false\n },\n {\n \"id\": 10,\n \"description\": \"WhatsApp family subscription\",\n \"value\": \"WHATSAPP_FAMILY\",\n \"createdAt\": \"2021-04-08T10:07:23.000Z\",\n \"updatedAt\": \"2021-04-08T10:07:23.000Z\",\n \"numberOfAllowedDependents\": \"4\",\n \"recurringBilling\": false\n },\n {\n \"id\": 16,\n \"description\": \"Call-Centre family subscription\",\n \"value\": \"CALL_CENTRE_FAMILY\",\n \"createdAt\": \"2021-04-28T06:20:57.877Z\",\n \"updatedAt\": \"2021-04-28T06:20:57.877Z\",\n \"numberOfAllowedDependents\": \"4\",\n \"recurringBilling\": false\n },\n {\n \"id\": 17,\n \"description\": \"Tracker CareGuard for Me\",\n \"value\": \"TRACKER_CG_SINGLE\",\n \"createdAt\": \"2021-05-05T11:25:08.000Z\",\n \"updatedAt\": \"2021-05-05T11:25:08.000Z\",\n \"numberOfAllowedDependents\": null,\n \"recurringBilling\": true\n },\n {\n \"id\": 18,\n \"description\": \"Tracker CareGuard for Me + One\",\n \"value\": \"TRACKER_CG_DUAL\",\n \"createdAt\": \"2021-05-05T11:25:37.000Z\",\n \"updatedAt\": \"2021-05-05T11:25:37.000Z\",\n \"numberOfAllowedDependents\": \"1\",\n \"recurringBilling\": true\n },\n {\n \"id\": 19,\n \"description\": \"Tracker CareGuard Family \",\n \"value\": \"TRACKER_CG_FAMILY\",\n \"createdAt\": \"2021-05-05T11:26:08.000Z\",\n \"updatedAt\": \"2021-05-05T11:26:08.000Z\",\n \"numberOfAllowedDependents\": \"4\",\n \"recurringBilling\": true\n },\n {\n \"id\": 20,\n \"description\": \"Tracker Careguard Fleet Subscription\",\n \"value\": \"TRACKER_BUSINESS_MULTI\",\n \"createdAt\": \"2021-11-29T14:51:10.577Z\",\n \"updatedAt\": \"2021-11-29T14:51:10.577Z\",\n \"numberOfAllowedDependents\": \"1000\",\n \"recurringBilling\": true\n },\n {\n \"id\": 21,\n \"description\": \"M-PESA Single Subscription\",\n \"value\": \"M-PESA_SINGLE\",\n \"createdAt\": \"2022-04-05T10:18:53.948Z\",\n \"updatedAt\": \"2022-04-05T10:18:53.948Z\",\n \"numberOfAllowedDependents\": null,\n \"recurringBilling\": true\n },\n {\n \"id\": 22,\n \"description\": \"M-PESA Family Subscription\",\n \"value\": \"M-PESA_FAMILLY\",\n \"createdAt\": \"2022-04-05T10:18:53.948Z\",\n \"updatedAt\": \"2022-04-05T10:18:53.948Z\",\n \"numberOfAllowedDependents\": \"4\",\n \"recurringBilling\": true\n },\n {\n \"id\": 23,\n \"description\": \"Payfast single Subscription\",\n \"value\": \"PAYFAST_SINGLE\",\n \"createdAt\": \"2022-06-01T13:18:07.609Z\",\n \"updatedAt\": \"2022-06-01T13:18:07.609Z\",\n \"numberOfAllowedDependents\": null,\n \"recurringBilling\": true\n },\n {\n \"id\": 24,\n \"description\": \"Payfast Family Subscription\",\n \"value\": \"PAYFAST_FAMILY\",\n \"createdAt\": \"2022-06-01T13:18:07.609Z\",\n \"updatedAt\": \"2022-06-01T13:18:07.609Z\",\n \"numberOfAllowedDependents\": \"4\",\n \"recurringBilling\": true\n },\n {\n \"id\": 25,\n \"description\": \"API dual subscription\",\n \"value\": \"TFG_DUAL\",\n \"createdAt\": \"2022-05-30T13:04:16.000Z\",\n \"updatedAt\": \"2022-05-30T13:04:16.000Z\",\n \"numberOfAllowedDependents\": \"1\",\n \"recurringBilling\": false\n },\n {\n \"id\": 26,\n \"description\": \"Pre-Defined Location Subscription\",\n \"value\": \"PRE_DEFINED_LOCATION\",\n \"createdAt\": \"2022-06-09T10:31:07.904Z\",\n \"updatedAt\": \"2022-06-09T10:31:07.904Z\",\n \"numberOfAllowedDependents\": null,\n \"recurringBilling\": false\n },\n {\n \"id\": 27,\n \"description\": \"Tracker CareGuard Business Single Subscription\",\n \"value\": \"TRACKER_CG_BUSINESS_SINGLE\",\n \"createdAt\": \"2022-06-08T13:12:26.000Z\",\n \"updatedAt\": \"2022-06-08T13:12:26.000Z\",\n \"numberOfAllowedDependents\": null,\n \"recurringBilling\": true\n }\n ]\n}"}],"_postman_id":"d0bf5d9c-41c6-4157-be25-bfaf1db73fb1"}],"id":"0f00f29d-43e3-4f9e-9339-87f63f9ba42a","_postman_id":"0f00f29d-43e3-4f9e-9339-87f63f9ba42a","description":""},{"name":"Managing Subscriptions","item":[{"name":"Activate a single user subscription","id":"6533488d-6b56-42b0-a3ab-4c52a7d4e62a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 164650,\n \"subscriptionTypeId\": 4,\n \"validFrom\": \"2024-03-19T00:00:00.000Z\",\n \"validTo\": \"2123-08-05T06:00:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions","description":"

WEB_SIGNUP_SINGLE subscriptionTypeId values:
Staging: 4
Production: 4

\n","urlObject":{"protocol":"https","path":["v2","subscriptions"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"d3b739e2-b67b-419c-aad1-ee0ea6dfa336","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 164650,\n \"subscriptionTypeId\": 4,\n \"validFrom\": \"2024-03-19T00:00:00.000Z\",\n \"validTo\": \"2123-08-05T06:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{panicApiUrl}}/v2/subscriptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Tue, 19 Mar 2024 09:23:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"373"},{"key":"Connection","value":"keep-alive"},{"key":"etag","value":"W/\"175-nqwWddMsD8eTKRlKrAPcABqrB/o\""},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully activated customer subscription\",\n \"subscription\": {\n \"id\": 313243,\n \"subscriptionTypeId\": 4,\n \"validFrom\": \"2024-03-19T00:00:00.000Z\",\n \"validTo\": \"2123-08-05T06:00:00.000Z\",\n \"updatedAt\": \"2024-03-19T09:23:54.821Z\",\n \"createdAt\": \"2024-03-19T09:23:54.821Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"subscriptionToken\": null,\n \"customerId\": 164650\n },\n \"dependantLinks\": []\n}"}],"_postman_id":"6533488d-6b56-42b0-a3ab-4c52a7d4e62a"},{"name":"Activate a family subscription","id":"10498924-cbbe-41db-8f04-aebb75054b01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 181076,\n \"dependantCustomerIds\": [\n 181077,\n 181078\n ],\n \"subscriptionTypeId\": 14,\n \"validFrom\": \"2024-03-19T00:00:00.000Z\",\n \"validTo\": \"2122-08-05T06:00:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions","description":"

WEB_SIGNUP_FAMILY subscriptionTypeId values:
Staging: 14
Production: 41

\n","urlObject":{"protocol":"https","path":["v2","subscriptions"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"c9e10eca-2573-4838-b693-5841d3d11bed","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 123accessToken321","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 181076,\n \"dependantCustomerIds\": [\n 181077,\n 181078\n ],\n \"subscriptionTypeId\": 14,\n \"validFrom\": \"2024-03-19T00:00:00.000Z\",\n \"validTo\": \"2122-08-05T06:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://staging-panic.aura.services/panic-api/v2/subscriptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Tue, 19 Mar 2024 09:20:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"699"},{"key":"Connection","value":"keep-alive"},{"key":"etag","value":"W/\"2bb-f/NxAvGM146LSCyjdnvxJF9jOkw\""},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully activated customer subscription\",\n \"subscription\": {\n \"id\": 313241,\n \"subscriptionTypeId\": 14,\n \"validFrom\": \"2024-03-19T00:00:00.000Z\",\n \"validTo\": \"2122-08-05T06:00:00.000Z\",\n \"updatedAt\": \"2024-03-19T09:20:44.999Z\",\n \"createdAt\": \"2024-03-19T09:20:44.999Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"subscriptionToken\": null,\n \"customerId\": 181076\n },\n \"dependantLinks\": [\n {\n \"id\": 202756,\n \"customerId\": 181077,\n \"subscriptionId\": 313241,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2024-03-19T09:20:45.058Z\",\n \"createdAt\": \"2024-03-19T09:20:45.058Z\"\n },\n {\n \"id\": 202757,\n \"customerId\": 181078,\n \"subscriptionId\": 313241,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2024-03-19T09:20:45.065Z\",\n \"createdAt\": \"2024-03-19T09:20:45.065Z\"\n }\n ]\n}"}],"_postman_id":"10498924-cbbe-41db-8f04-aebb75054b01"},{"name":"Edit an existing user's subscription","id":"7f2e6f5a-0071-48b3-a49c-64b41aa8084c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"validTo\": \"2023-12-22T21:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}","description":"

An existing user's subscription can be shortened or lengthened by editing the Valid To date assoicated with the user's current subscription.

\n

This would only be applicable to main members or customers with single subscriptions.

\n

Note: The ValidTo date cannot be earlier than the current date.

\n","urlObject":{"protocol":"https","path":["v2","subscriptions","{{mainMemberSubId}}"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"a6c1b3ff-6cdc-4dce-8c3d-32587989e419","name":"200 Success","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"validTo\": \"2023-12-22T21:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"446"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"1be-kTa7+3e0WVwcxzecQh/1uA\""},{"key":"x-ratelimit-reset","value":"1701428853"},{"key":"date","value":"Fri, 01 Dec 2023 11:06:48 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": [\n {\n \"id\": 187142,\n \"customerId\": 166789,\n \"subscriptionId\": 295147,\n \"relationship\": \"MAIN\",\n \"createdAt\": \"2023-12-01T11:03:11.454Z\",\n \"updatedAt\": \"2023-12-01T11:03:11.454Z\"\n }\n ],\n \"subscription\": [\n {\n \"id\": 295147,\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2023-12-01T00:00:00.000Z\",\n \"validTo\": \"2023-12-22T21:59:00.000Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"createdAt\": \"2023-12-01T11:03:11.433Z\",\n \"updatedAt\": \"2023-12-01T11:06:48.807Z\",\n \"subscriptionToken\": null\n }\n ]\n}"},{"id":"7b84c2cc-22f2-43a0-9a3f-5134bbe9d966","name":"400 Valid To date cannot be earlier than the current date","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"validTo\": \"2023-11-19T21:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"41-3kPfsXJRQ3vQSBYz84nk9A\""},{"key":"x-ratelimit-reset","value":"1701428793"},{"key":"date","value":"Fri, 01 Dec 2023 11:05:46 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"ValidTo date cannot be earlier than the current date\"\n}"},{"id":"d8b15abd-98bf-4fc6-9e6f-6db5b46d435d","name":"404 subscriptionId not found","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"validTo\": \"2023-12-22T21:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"119"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"77-DwLLMI9ORHI8DGrSZSEwPg\""},{"key":"x-ratelimit-reset","value":"1701428973"},{"key":"date","value":"Fri, 01 Dec 2023 11:09:11 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"All customers linked to the subscription are not valid, please check customers linked to the subscription \"\n}"}],"_postman_id":"7f2e6f5a-0071-48b3-a49c-64b41aa8084c"},{"name":"Add a dependant","id":"6067f47d-b557-4677-9579-13fef93ff6c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 143893,\n 143903,\n 143904\n ],\n \"validTo\": \"2122-08-08T21:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}","description":"

Dependants are stored in an array.

\n

To add a new dependant to a subscription, all previous dependant customerId's and the new dependant customerId must be sent in the request.

\n

If the previously active dependants are not sent in the PUT request they will be removed from the array.

\n","urlObject":{"protocol":"https","path":["v2","subscriptions","{{mainMemberSubId}}"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"1476071c-4f5b-4e9a-b026-13f2b0104b80","name":"200 Success","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 143893,\n 143903,\n 143904\n ],\n \"validTo\": \"2122-08-08T21:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"778"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"30a-61LUiC6HMgE5QOFfZ+a4fA\""},{"key":"x-ratelimit-reset","value":"1659954725"},{"key":"date","value":"Mon, 08 Aug 2022 10:31:09 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": [\n {\n \"id\": 153657,\n \"customerId\": 143893,\n \"subscriptionId\": 152284,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2022-08-08T10:31:09.728Z\",\n \"createdAt\": \"2022-08-08T10:31:09.728Z\"\n },\n {\n \"id\": 153658,\n \"customerId\": 143903,\n \"subscriptionId\": 152284,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2022-08-08T10:31:09.739Z\",\n \"createdAt\": \"2022-08-08T10:31:09.739Z\"\n },\n {\n \"id\": 153659,\n \"customerId\": 143904,\n \"subscriptionId\": 152284,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2022-08-08T10:31:09.745Z\",\n \"createdAt\": \"2022-08-08T10:31:09.745Z\"\n }\n ],\n \"subscription\": [\n {\n \"id\": 152284,\n \"subscriptionTypeId\": 12,\n \"validFrom\": \"2022-08-08T06:00:00.995Z\",\n \"validTo\": \"2122-08-08T21:59:00.000Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"createdAt\": \"2022-08-08T10:24:32.265Z\",\n \"updatedAt\": \"2022-08-08T10:31:09.753Z\",\n \"subscriptionToken\": null\n }\n ]\n}"},{"id":"e8a6b94a-6a4a-40a0-bd29-5b3fff074252","name":"400 ValidTo Date is in the past","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhenAiOiJvOFMwaGRqQnExaHhqbHZpWU9ISFZtN0ZzSFQ1bEV3OSIsImd0eSI6ImNsaWVudC1jcmVkZW50aWFscyIsImlhdCI6MTY5NjU5ODMwMiwiZXhwIjozODQ0MDgxOTQ5LCJhdWQiOiJodHRwczovL3N0YWdpbmctYXVyYS1wYW5pYy8iLCJpc3MiOiJodHRwczovL3N0YWdpbmctYXVyYS5zZXJ2aWNlcyIsInN1YiI6Im84UzBoZGpCcTFoeGpsdmlZT0hIVm03RnNIVDVsRXc5QGNsaWVudHMifQ.kKzOcsqtBH_b_PlW3hPzRP_tmtp_0DCrjXc-DJ65-Pn-_qEAJH958JiYLWFnf3zGpAZ7wfCfm8Cbpe40reoZBmdxfLCD4bYseWQgVCUrxZVttxRmO83N2-V23xgT5yEGELke3snDWhh4clBB1NUgyGjG-e2Q4sW4VSrCms5MgURVVMCFoZMzmy6j0DgK9MaSsrr5wplu7D8mWK2tw5S6ktOCugpXAc7vSgPrbC2D-hnHCZvifv9-jls_ql4dh1QH1x-e0PhA4KAbG-8VeM8LAgf8othiCvRZVeqtTUA2dKVjpltwbVUaDCOMvx2CldqYdhK40VDT4c9NZXaP76Tw0HtRDi5MiOjlW7Lltm6gGSPiFGsAOBKh4ben1QYALNmLGbh-ZgiD-Pp6W0ZqNsiVReJv9QDBRRwgxHaFAa4pE1pIZZ_kzrLb4s-d2KxWKhsHjCUkaIO7EX5pVwuQesv0P1W-cNL1rhBTZ-0FteGDomRFTZppCARJ0s3T97zaJ5niB9FDlDI8uT53gvbCae17Y6uWrNs_tDtue8feQoAuIv850QLmLa_z768_Ok42pS1-SvI2Uh2YIRHMhfLYvW8WzvtcKcEKHMbHW9RGb0_1YTgcuOt7k54wsFdnw3WoZ-bknYP1YcwTGgAXNqDcQuao_rdgEorUjclc0-HXpcnWXoU","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 164651\n ],\n \"validTo\": \"2021-08-08T21:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/285866"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"41-3kPfsXJRQ3vQSBYz84nk9A\""},{"key":"x-ratelimit-reset","value":"1696599348"},{"key":"date","value":"Fri, 06 Oct 2023 13:34:47 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"ValidTo date cannot be earlier than the current date\"\n}"},{"id":"6f081aba-f76e-454d-b75e-173eb996a5fa","name":"401 Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 143893,\n 143903,\n 143904\n ],\n \"validTo\": \"2122-08-08T21:59:00.000Z\"\n}"},"url":"http://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"30"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"1e-sHVIX2eXNyCSMmqfj+CwgQ\""},{"key":"x-ratelimit-reset","value":"1683810529"},{"key":"date","value":"Thu, 11 May 2023 13:08:42 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"invalid signature\"\n}"},{"id":"057ba24a-6d6f-44da-bc87-0c2cb2ca3451","name":"404 URL Not Found","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 143893,\n 143903,\n 143904\n ],\n \"validTo\": \"2122-08-08T21:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscription/{{mainMemberSubId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"date","value":"Thu, 11 May 2023 13:19:50 GMT"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"Cannot GET /panic-api/v2/subscription/152284\n"},{"id":"2ab08bd9-ce6f-4dee-8816-845267709872","name":"404 mainMemberSubId Not Found","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 143893,\n 143903,\n 143904\n ],\n \"validTo\": \"2122-08-08T21:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"119"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"77-DwLLMI9ORHI8DGrSZSEwPg\""},{"key":"x-ratelimit-reset","value":"1683811404"},{"key":"date","value":"Thu, 11 May 2023 13:22:32 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"All customers linked to the subscription are not valid, please check customers linked to the subscription \"\n}"},{"id":"9d1d189a-cd1c-426d-b8db-1d03c486645a","name":"409 Dependant Customer Id Not Found","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhenAiOiJvOFMwaGRqQnExaHhqbHZpWU9ISFZtN0ZzSFQ1bEV3OSIsImd0eSI6ImNsaWVudC1jcmVkZW50aWFscyIsImlhdCI6MTY5NjU5ODMwMiwiZXhwIjozODQ0MDgxOTQ5LCJhdWQiOiJodHRwczovL3N0YWdpbmctYXVyYS1wYW5pYy8iLCJpc3MiOiJodHRwczovL3N0YWdpbmctYXVyYS5zZXJ2aWNlcyIsInN1YiI6Im84UzBoZGpCcTFoeGpsdmlZT0hIVm03RnNIVDVsRXc5QGNsaWVudHMifQ.kKzOcsqtBH_b_PlW3hPzRP_tmtp_0DCrjXc-DJ65-Pn-_qEAJH958JiYLWFnf3zGpAZ7wfCfm8Cbpe40reoZBmdxfLCD4bYseWQgVCUrxZVttxRmO83N2-V23xgT5yEGELke3snDWhh4clBB1NUgyGjG-e2Q4sW4VSrCms5MgURVVMCFoZMzmy6j0DgK9MaSsrr5wplu7D8mWK2tw5S6ktOCugpXAc7vSgPrbC2D-hnHCZvifv9-jls_ql4dh1QH1x-e0PhA4KAbG-8VeM8LAgf8othiCvRZVeqtTUA2dKVjpltwbVUaDCOMvx2CldqYdhK40VDT4c9NZXaP76Tw0HtRDi5MiOjlW7Lltm6gGSPiFGsAOBKh4ben1QYALNmLGbh-ZgiD-Pp6W0ZqNsiVReJv9QDBRRwgxHaFAa4pE1pIZZ_kzrLb4s-d2KxWKhsHjCUkaIO7EX5pVwuQesv0P1W-cNL1rhBTZ-0FteGDomRFTZppCARJ0s3T97zaJ5niB9FDlDI8uT53gvbCae17Y6uWrNs_tDtue8feQoAuIv850QLmLa_z768_Ok42pS1-SvI2Uh2YIRHMhfLYvW8WzvtcKcEKHMbHW9RGb0_1YTgcuOt7k54wsFdnw3WoZ-bknYP1YcwTGgAXNqDcQuao_rdgEorUjclc0-HXpcnWXoU","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 99999,\n 164651\n ],\n \"validTo\": \"2123-08-08T21:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/285866"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"99"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"63-0O194JtA98b13+UoIvwnOA\""},{"key":"x-ratelimit-reset","value":"1696598755"},{"key":"date","value":"Fri, 06 Oct 2023 13:24:54 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Dependant Customer with id 99999 not found, please check request.\",\n \"subscription\": null\n}"},{"id":"032d90b3-f0fb-4159-b1e3-01ef374934ea","name":"409 Dependant Customer Id has existing subscription","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhenAiOiJvOFMwaGRqQnExaHhqbHZpWU9ISFZtN0ZzSFQ1bEV3OSIsImd0eSI6ImNsaWVudC1jcmVkZW50aWFscyIsImlhdCI6MTY5NjU5ODMwMiwiZXhwIjozODQ0MDgxOTQ5LCJhdWQiOiJodHRwczovL3N0YWdpbmctYXVyYS1wYW5pYy8iLCJpc3MiOiJodHRwczovL3N0YWdpbmctYXVyYS5zZXJ2aWNlcyIsInN1YiI6Im84UzBoZGpCcTFoeGpsdmlZT0hIVm03RnNIVDVsRXc5QGNsaWVudHMifQ.kKzOcsqtBH_b_PlW3hPzRP_tmtp_0DCrjXc-DJ65-Pn-_qEAJH958JiYLWFnf3zGpAZ7wfCfm8Cbpe40reoZBmdxfLCD4bYseWQgVCUrxZVttxRmO83N2-V23xgT5yEGELke3snDWhh4clBB1NUgyGjG-e2Q4sW4VSrCms5MgURVVMCFoZMzmy6j0DgK9MaSsrr5wplu7D8mWK2tw5S6ktOCugpXAc7vSgPrbC2D-hnHCZvifv9-jls_ql4dh1QH1x-e0PhA4KAbG-8VeM8LAgf8othiCvRZVeqtTUA2dKVjpltwbVUaDCOMvx2CldqYdhK40VDT4c9NZXaP76Tw0HtRDi5MiOjlW7Lltm6gGSPiFGsAOBKh4ben1QYALNmLGbh-ZgiD-Pp6W0ZqNsiVReJv9QDBRRwgxHaFAa4pE1pIZZ_kzrLb4s-d2KxWKhsHjCUkaIO7EX5pVwuQesv0P1W-cNL1rhBTZ-0FteGDomRFTZppCARJ0s3T97zaJ5niB9FDlDI8uT53gvbCae17Y6uWrNs_tDtue8feQoAuIv850QLmLa_z768_Ok42pS1-SvI2Uh2YIRHMhfLYvW8WzvtcKcEKHMbHW9RGb0_1YTgcuOt7k54wsFdnw3WoZ-bknYP1YcwTGgAXNqDcQuao_rdgEorUjclc0-HXpcnWXoU","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 164651\n ],\n \"validTo\": \"2123-08-08T21:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/280764"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"124"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"7c-ZWFIzABW5ZTfEZepDIr/Cg\""},{"key":"x-ratelimit-reset","value":"1696599160"},{"key":"date","value":"Fri, 06 Oct 2023 13:31:39 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Subscription for dependant customer with id 164651 does not belong to subscription 280764 \",\n \"subscription\": null\n}"}],"_postman_id":"6067f47d-b557-4677-9579-13fef93ff6c5"},{"name":"Remove a dependant","id":"b33f3b63-1b74-4441-a2fe-a48d1ff3c1f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 143893,\n 143903\n ],\n \"validTo\": \"2122-08-08T06:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}","description":"

Dependants are stored in an array.

\n

To remove a dependant from a subscription, all previous dependant customerId's other than the customerId to remove will have to be sent in the request.

\n

If the previously active dependants are not sent in the PUT request they will be removed from the array.

\n

In the example below customerId 143904 from adding a dependant was left out of the put request to remove their subscription.

\n","urlObject":{"protocol":"https","path":["v2","subscriptions","{{mainMemberSubId}}"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"7b9694db-fa77-4a1c-9a6f-66fc3b7056c3","name":"200 Success","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 143893,\n 143903\n ],\n \"validTo\": \"2122-08-08T06:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"615"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"267-08ZkMrUKFCH0cUjpvfDKjA\""},{"key":"x-ratelimit-reset","value":"1659954605"},{"key":"date","value":"Mon, 08 Aug 2022 10:29:10 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": [\n {\n \"id\": 153652,\n \"customerId\": 143893,\n \"subscriptionId\": 152284,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2022-08-08T10:29:11.036Z\",\n \"createdAt\": \"2022-08-08T10:29:11.036Z\"\n },\n {\n \"id\": 153653,\n \"customerId\": 143903,\n \"subscriptionId\": 152284,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2022-08-08T10:29:11.066Z\",\n \"createdAt\": \"2022-08-08T10:29:11.066Z\"\n }\n ],\n \"subscription\": [\n {\n \"id\": 152284,\n \"subscriptionTypeId\": 12,\n \"validFrom\": \"2022-08-08T06:00:00.995Z\",\n \"validTo\": \"2122-08-08T06:59:00.000Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"createdAt\": \"2022-08-08T10:24:32.265Z\",\n \"updatedAt\": \"2022-08-08T10:29:11.076Z\",\n \"subscriptionToken\": null\n }\n ]\n}"},{"id":"93cfeb9d-dfba-4481-88ec-d5d434f826e3","name":"401 Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 143893,\n 143903\n ],\n \"validTo\": \"2122-08-08T06:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"30"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"1e-sHVIX2eXNyCSMmqfj+CwgQ\""},{"key":"x-ratelimit-reset","value":"1683810553"},{"key":"date","value":"Thu, 11 May 2023 13:08:22 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"invalid signature\"\n}"},{"id":"47b728e7-8664-4e6c-94db-e9a61d498178","name":"404 URL Not Found","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 143893,\n 143903\n ],\n \"validTo\": \"2122-08-08T06:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscription/{{mainMemberSubId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"date","value":"Thu, 11 May 2023 13:20:54 GMT"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"Cannot GET /panic-api/v2/subscription/152284\n"},{"id":"a96143ec-1cdf-4063-b6cb-6c1772a98809","name":"404 Subsciption Not Found For mainMemberSubId","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 143893,\n 143903\n ],\n \"validTo\": \"2122-08-08T06:59:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"35-u3jrMaf5jEvUrw0abXrT5g\""},{"key":"x-ratelimit-reset","value":"1683811524"},{"key":"date","value":"Thu, 11 May 2023 13:24:23 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"Subscription not found for this customer\"\n}"}],"_postman_id":"b33f3b63-1b74-4441-a2fe-a48d1ff3c1f1"},{"name":"Remove a single subscription","id":"fcef9fb3-5c0a-4c67-bdfd-bb73788c6602","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"url":"https://{{panicApiUrl}}/v2/subscriptions/{{subscriptionId}}","description":"

This removes an active subscription from a customer

\n","urlObject":{"protocol":"https","path":["v2","subscriptions","{{subscriptionId}}"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"052a59b5-0c3e-4891-b721-cdac7954e081","name":"200 Response","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"url":"http://{{panicApiUrl}}/v2/subscriptions/{{subscriptionId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"72"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"48-fCX5f8ThoN4IrfsqJii+kQ\""},{"key":"x-ratelimit-reset","value":"1659953531"},{"key":"date","value":"Mon, 08 Aug 2022 10:11:24 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully deleted subscription\",\n \"subscriptionToken\": null\n}"}],"_postman_id":"fcef9fb3-5c0a-4c67-bdfd-bb73788c6602"},{"name":"Remove a family subscription","id":"21e2890d-cb19-4408-b038-793fc553ccf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"url":"http://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}","description":"

By cancelling the main members subscription, all dependant subscriptions will be cancelled as well. To remove a dependant from a subscription please see 'Remove a dependant'

\n","urlObject":{"protocol":"http","path":["v2","subscriptions","{{mainMemberSubId}}"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"64772f97-8c8c-43ff-9c52-ff830d36f213","name":"200 Response","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"url":"http://{{panicApiUrl}}/v2/subscriptions/{{familySubId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"72"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"48-fCX5f8ThoN4IrfsqJii+kQ\""},{"key":"x-ratelimit-reset","value":"1659953771"},{"key":"date","value":"Mon, 08 Aug 2022 10:15:57 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully deleted subscription\",\n \"subscriptionToken\": null\n}"}],"_postman_id":"21e2890d-cb19-4408-b038-793fc553ccf0"}],"id":"48757f51-a3b1-417b-9510-ec49054decf1","description":"

After viewing what subscription types are available it is time to create a subscription for the customer based on a successful payment.

\n
    \n
  1. Decode the JWT Token to get the customerId
    2. \n
  2. Store the customerId and link it to the integration customer so that the integrator can tie their customer back to AURA to query
    3. \n
  3. Use the customerId and the JWT token to create a subscription using the below methods
    4. \n
\n

You can double check your work on the AURA staging portal login associated to your customerSource to ensure all is working as expected

\n

After you have created the subscription:

\n
    \n
  1. The customer needs to be re-directed to the redirectUrl that was originally sent through in the original URL parameters.
    2. \n
  2. Over and above this, we also need to attach either success=true if the payment was successful or success=false if the payment was unsuccessful.
    3. \n
  3. The redirect handler validates the requests and allows the application to wait for the validation to happen
      \n
    1. The application closes the in app webview and the customer gets navigated to the exit screen.
      2. \n
    \n
    4. \n
\n

Renewing & cancelling subscriptions:

\n

When payment renewal comes in, via the payment gateway, the integrator needs to process this request and update the customer's subscription using edit a customer's subscription.

\n

Similarly, if a user's payment renewal fails or they opt out - the users subscription must be cancelled.

\n

If a user's subscription has been cancelled, but the customer wants to re-subscribe, a new subscription must be issued to that customer ID. AURA doesn't allow recovery of a deleted subscription.

\n","_postman_id":"48757f51-a3b1-417b-9510-ec49054decf1"}],"id":"e34cc50f-7010-4737-90a2-390c33d7595a","description":"

AURA allows an integrator to build a customer payment handler that we will include in your white label application.

\n\"AURA%20web%20based%20subscription%20overview\"\n\n

The sign up handler will be responsible for navigating a customer to the payment gateway with the required information, handling the response and calling back to both the signup handler implementation with the tokenized card information as well as to the AURA payment handler instructing it whether the payment was a success or not.

\n

The white label will register the customer on your behalf during the login process.

\n

When redirecting to the URL provided by the integrator AURA will include a JWT access token and a redirect URL as query parameters when re-directing to the integrators sign up handler. The access token can be decoded to obtain the corresponding customerId which can then be used to activate a subscription from within the signup handler upon successful payment.

\n\"Example%20of%20customerId%20from%20decoded%20token.\"\n\n

Once the payment completes or fails, the signup handler needs to redirect the customer back to the AURA payment handler using the redirect URL.

\n

An example of the redirect url: https://my.paymentgateway.com?token=xxxxx&redirectUrl=https://qfmf6t8egc.execute-api.eu-west-1.amazonaws.com/staging/v2/process?success=true

\n

Note the token and success=true in the redirect URL.

\n

At this point the expectations for the integrator are:

\n
    \n

  1. Handle a payment or a process to validate that the customer is eligible for a subscription

    \n
    2. \n

  2. Create the subscription for the customer

    \n
    3. \n
\n","_postman_id":"e34cc50f-7010-4737-90a2-390c33d7595a"},{"name":"IoT Device Gateway","item":[{"name":"User registration & Management","item":[{"name":"Register a new customer with an active subscription","id":"8922ba70-13ef-4393-b4aa-2cf4b0bd7ef0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"Testy\",\n \"surname\": \"McTesty\",\n \"mobile\": \"+27821231232\",\n \"gender\": \"male\",\n \"email\": \"test@gmail.com\",\n \"duressCode\": \"Tomato Sauce\"\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"businessName\": \"Liberty\",\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"bloodtype\": \"A-\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\"\n },\n \"subscription\": {\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2022-08-08T06:37:17.995Z\",\n \"validTo\": \"2122-08-08T21:59:00.000Z\"\n }\n}"},"url":"https://{{panicApiUrl}}/v2/customers","description":"

As seen in the example below a customer can be created with or without a subscription object. If you do not include the subscription object when registering a customer the subscription can be added later. Please note a customer cannot create a panic without an active subscription

\n

The minimum requirement for registering a customer is a valid mobile number

\n

Please take note of the customerId returned when creating a customer. This is needed to interact with the AURA api

\n

SubscriptionTypeId's:

\n

Staging
API_Single: 2 (A single user)
API_Family: 12 (1 Primary member, up to 4 dependants)(Refer to subscription management for more details as to how to utilise this.

\n

Production:
API_Single: 2
API_Family: 44

\n

AURA's API subscriptions are time based and use the below variables to define it:
validFrom - When the subscription starts, cannot be before todays date
validTo - When the subscription ends, a date in the future
Please note times are UTC based

\n

OpenApi reference

\n","urlObject":{"protocol":"https","path":["v2","customers"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"cdcf1cff-12c5-4182-8a23-31d43b2cedbf","name":"200 Response - customer created with subscription successfully","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"Testy\",\n \"surname\": \"McTesty\",\n \"mobile\": \"+27821231235\",\n \"gender\": \"male\",\n \"email\": \"test@gmail.com\",\n \"duressCode\": \"Tomato Sauce\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"businessName\": \"Liberty\",\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"bloodtype\": \"A-\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\"\n },\n \"subscription\": {\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2023-02-27T00:37:17.995Z\",\n \"validTo\": \"2122-08-08T21:59:00.000Z\"\n }\n}"},"url":"https://{{panicApiUrl}}/v2/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1291"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"50b-GfzRmzUvNnEE2WunZPJA8Q\""},{"key":"x-ratelimit-reset","value":"1677508281"},{"key":"date","value":"Mon, 27 Feb 2023 14:31:06 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully registered customer\",\n \"customer\": {\n \"id\": 154813,\n \"name\": \"Testy\",\n \"surname\": \"McTesty\",\n \"mobile\": \"+27821231235\",\n \"gender\": \"male\",\n \"email\": \"test@gmail.com\",\n \"duressCode\": \"Tomato Sauce\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"businessName\": \"Liberty\",\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\",\n \"customerSourceId\": 225,\n \"auth0UserId\": \"94de245c-08b9-4c6b-a25f-0d52e872cd0b\",\n \"updatedAt\": \"2023-02-27T14:31:06.373Z\",\n \"createdAt\": \"2023-02-27T14:31:06.373Z\",\n \"imageId\": null,\n \"customerTypeId\": null,\n \"referredByCodeId\": null,\n \"referredByCustomerId\": null,\n \"authOtp\": null,\n \"authOtpValidUntil\": null,\n \"_search\": null,\n \"stripeCustomerId\": null,\n \"bloodType\": null,\n \"subscriptions\": [\n {\n \"id\": 166172,\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2023-02-27T00:37:17.995Z\",\n \"validTo\": \"2122-08-08T21:59:00.000Z\",\n \"updatedAt\": \"2023-02-27T14:31:06.412Z\",\n \"createdAt\": \"2023-02-27T14:31:06.412Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"subscriptionToken\": null,\n \"customerId\": 154813\n }\n ]\n }\n}"},{"id":"a4da9100-ccaf-42b6-9d49-bfe2f75838c7","name":"400 Response - validFrom cannot be earlier than the current date","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"Testy\",\n \"surname\": \"McTesty\",\n \"mobile\": \"+27821231238\",\n \"gender\": \"male\",\n \"email\": \"test@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"businessName\": \"Liberty\",\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"bloodtype\": \"A-\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\"\n },\n \"subscription\": {\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2022-08-08T06:37:17.995Z\",\n \"validTo\": \"2122-08-08T21:59:00.000Z\"\n }\n}"},"url":"https://{{panicApiUrl}}/v2/customers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"67"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"43-rcsphetTgUadndCiYV0Kpg\""},{"key":"x-ratelimit-reset","value":"1664180102"},{"key":"date","value":"Mon, 26 Sep 2022 08:14:01 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"ValidFrom date cannot be earlier than the current date\"\n}"},{"id":"d051254c-a48a-442c-aa36-bb520a36040d","name":"409 Response - Customer already exists","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"Testy\",\n \"surname\": \"McTesty\",\n \"mobile\": \"+27821231238\",\n \"gender\": \"male\",\n \"email\": \"test@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"businessName\": \"Liberty\",\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"bloodtype\": \"A-\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\"\n },\n \"subscription\": {\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2022-09-26T08:00:00.995Z\",\n \"validTo\": \"2122-08-08T21:59:00.000Z\"\n }\n}"},"url":"https://{{panicApiUrl}}/v2/customers"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2635"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"a4b-hX5MGN62MKiE50A0KLBsGA\""},{"key":"x-ratelimit-reset","value":"1664180491"},{"key":"date","value":"Mon, 26 Sep 2022 08:20:30 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer already exists\",\n \"customer\": {\n \"id\": 143905,\n \"name\": \"Testy\",\n \"surname\": \"McTesty\",\n \"mobile\": \"+27821231238\",\n \"gender\": \"male\",\n \"email\": \"test@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"customerSourceId\": 249,\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"auth0UserId\": \"59f092e2-7253-4767-8727-db59890f8d57\",\n \"imageId\": null,\n \"businessName\": \"Liberty\",\n \"customerTypeId\": null,\n \"referredByCodeId\": null,\n \"referredByCustomerId\": null,\n \"authOtp\": null,\n \"authOtpValidUntil\": null,\n \"stripeCustomerId\": null,\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"nextOfKinName\": \"Anna\",\n \"bloodType\": null,\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\",\n \"createdAt\": \"2022-08-08T09:56:53.496Z\",\n \"updatedAt\": \"2022-08-08T09:56:53.496Z\",\n \"customersSubscriptionLinks\": [\n {\n \"id\": 153637,\n \"customerId\": 143905,\n \"subscriptionId\": 152280,\n \"relationship\": \"MAIN\",\n \"createdAt\": \"2022-08-08T09:56:53.511Z\",\n \"updatedAt\": \"2022-08-08T09:56:53.511Z\",\n \"subscription\": {\n \"id\": 152280,\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2022-08-08T06:37:17.995Z\",\n \"validTo\": \"2122-08-08T21:59:00.000Z\",\n \"CancelledDate\": \"2022-08-08T09:57:41.285Z\",\n \"CancelledReason\": \"test\",\n \"subscriptionToken\": null,\n \"createdAt\": \"2022-08-08T09:56:53.504Z\",\n \"updatedAt\": \"2022-08-08T09:57:41.286Z\"\n }\n },\n {\n \"id\": 153643,\n \"customerId\": 143905,\n \"subscriptionId\": 152282,\n \"relationship\": \"MAIN\",\n \"createdAt\": \"2022-08-08T10:05:42.529Z\",\n \"updatedAt\": \"2022-08-08T10:05:42.529Z\",\n \"subscription\": {\n \"id\": 152282,\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2022-08-08T06:00:17.995Z\",\n \"validTo\": \"2123-08-05T06:00:00.000Z\",\n \"CancelledDate\": \"2022-08-08T10:11:24.980Z\",\n \"CancelledReason\": null,\n \"subscriptionToken\": null,\n \"createdAt\": \"2022-08-08T10:05:42.518Z\",\n \"updatedAt\": \"2022-08-08T10:11:24.980Z\"\n }\n },\n {\n \"id\": 153660,\n \"customerId\": 143905,\n \"subscriptionId\": 152285,\n \"relationship\": \"MAIN\",\n \"createdAt\": \"2022-08-08T12:51:56.615Z\",\n \"updatedAt\": \"2022-08-08T12:51:56.615Z\",\n \"subscription\": {\n \"id\": 152285,\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2022-08-08T06:00:17.995Z\",\n \"validTo\": \"2123-08-05T06:00:00.000Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"subscriptionToken\": null,\n \"createdAt\": \"2022-08-08T12:51:56.606Z\",\n \"updatedAt\": \"2022-08-08T12:51:56.606Z\",\n \"customerId\": 143905\n }\n }\n ],\n \"subscriptions\": [\n {\n \"id\": 152285,\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2022-08-08T06:00:17.995Z\",\n \"validTo\": \"2123-08-05T06:00:00.000Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"subscriptionToken\": null,\n \"createdAt\": \"2022-08-08T12:51:56.606Z\",\n \"updatedAt\": \"2022-08-08T12:51:56.606Z\",\n \"customerId\": 143905\n }\n ]\n }\n}"},{"id":"54ecb39f-52b9-4146-af2c-5e4041d67998","name":"400 Response - ValidTo date cannot be earlier than current date","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"Testy\",\n \"surname\": \"McTesty\",\n \"mobile\": \"+27821231238\",\n \"gender\": \"male\",\n \"email\": \"test@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"businessName\": \"Liberty\",\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"bloodtype\": \"A-\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\"\n },\n \"subscription\": {\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2022-09-26T08:00:00.995Z\",\n \"validTo\": \"2021-08-08T21:59:00.000Z\"\n }\n}"},"url":"https://{{panicApiUrl}}/v2/customers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"41-3kPfsXJRQ3vQSBYz84nk9A\""},{"key":"x-ratelimit-reset","value":"1664180491"},{"key":"date","value":"Mon, 26 Sep 2022 08:20:47 GMT"},{"key":"x-ratelimit-remaining","value":"28"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"ValidTo date cannot be earlier than the current date\"\n}"},{"id":"c43bb4e7-4e30-4d59-93ae-ef0e60e70676","name":"Register a new customer with an active subscription","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhenAiOiJ1bk1OZUlhMnltTWZpYnN2N0xQelpydTlxVW1uQ1pzcCIsImd0eSI6ImNsaWVudC1jcmVkZW50aWFscyIsImlhdCI6MTY3NzU4Nzc5OSwiZXhwIjozODI1MDcxNDQ2LCJhdWQiOiJodHRwczovL3N0YWdpbmctYXVyYS1wYW5pYy8iLCJpc3MiOiJodHRwczovL3N0YWdpbmctYXVyYS5zZXJ2aWNlcyIsInN1YiI6InVuTU5lSWEyeW1NZmlic3Y3TFB6WnJ1OXFVbW5DWnNwQGNsaWVudHMifQ.KYVJpQLcN2JWOjLaxPTzIYP-CbXbOHVj9_6fdibcLqTvXA4Br634qIiBr0PLXAKbACVrVBAxGHLxDeksTC2MpfUYf4p6X1mXxhj3b9toaDkw9pSG_7dxaQAHZwlplDHhaJlWdGG2vuvNUtQ8N7y774HG2_xzKH1UrE9jMtPFqbFL4U9oQ0RGuhu2e5vbKZtYTbohJFC0xzlS3gkheZvDrwdMyaknLEmEi3ZoaViv5N4KmLmAn0yJJaKkJ8EfFmdp3MXNfRpAiZJ47B_FpoYU35sQQ-Mux5m6C-XuqOcr8yOQrQQYRs-aJ72pm_Gdkf9ZGZpRLaFhZ8fGgx-fs0fEmFhvkP40FrkCPEidr10243JUnpkS4Ht4rwzxNfqMwXmMHZPNnKWnaS135ZmdWQTivNeeNUhjMDBJgF6BlE2NnQpjhjxbMKY2gvVTTLbrA3IzKlqNW9IE-3-w2qe5q08HFfK4rEU2_naGjumRgOGvvO3ZC2oQZz8H5S4gt6VnzF4jTK-XreQYV6Yj2j_h3MR-_k0t8Aa1v2TJb4r4E25ZmUIGb3_RfR8N_jpZAKIC5Tszy1rj2XlC8JI3Rp4jF5EPiSAuYGLdxJ_2sRgtYVA-BXCgikchHsQmvqzSv8ps59ZUkhYuQucSOCyiBHmAWVnfZfiQb95EvonhzjHt9u6XvaA","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"Testy\",\n \"surname\": \"McTesty\",\n \"mobile\": \"+27821231232\",\n \"gender\": \"male\",\n \"email\": \"test@gmail.com\",\n \"duressCode\": \"Tomato Sauce\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"businessName\": \"Liberty\",\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"bloodtype\": \"A-\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\"\n }\n}"},"url":"https://{{panicApiUrl}}/v2/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1012"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"3f4-sCETYApTlTGyIATcgXjC5g\""},{"key":"x-ratelimit-reset","value":"1677588056"},{"key":"date","value":"Tue, 28 Feb 2023 12:40:10 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully registered customer\",\n \"customer\": {\n \"id\": 155165,\n \"name\": \"Testy\",\n \"surname\": \"McTesty\",\n \"mobile\": \"+27821231232\",\n \"gender\": \"male\",\n \"email\": \"test@gmail.com\",\n \"duressCode\": \"Tomato Sauce\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"businessName\": \"Liberty\",\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\",\n \"customerSourceId\": 268,\n \"auth0UserId\": \"278c1b78-8814-4f81-8afd-468cc777f22f\",\n \"updatedAt\": \"2023-02-28T12:40:10.680Z\",\n \"createdAt\": \"2023-02-28T12:40:10.680Z\",\n \"imageId\": null,\n \"customerTypeId\": null,\n \"referredByCodeId\": null,\n \"referredByCustomerId\": null,\n \"authOtp\": null,\n \"authOtpValidUntil\": null,\n \"_search\": null,\n \"stripeCustomerId\": null,\n \"bloodType\": null,\n \"subscriptions\": []\n }\n}"}],"_postman_id":"8922ba70-13ef-4393-b4aa-2cf4b0bd7ef0"},{"name":"Register a new customer without a subscription","id":"7295cb88-a6b9-4d7c-b895-c3d13b426de4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"Testy\",\n \"surname\": \"McTesty\",\n \"mobile\": \"+27821231232\",\n \"gender\": \"male\",\n \"email\": \"test@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"businessName\": \"Liberty\",\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"bloodtype\": \"A-\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\"\n }\n}"},"url":"https://{{panicApiUrl}}/v2/customers","description":"

As seen in the example below a customer can be created with or without a subscription object. If you do not include the subscription object when registering a customer the subscription can be added later.

\n

Please take note of the customerId returned when creating a customer. This is needed to interact further with the AURA API.

\n

SubscriptionTypeId's:

\n

Staging
API_Single: 2
API_Family: 12

\n

Production:
API_Single: 2
API_Family: 44

\n

validFrom - cannot be before todays date
validTo - date in future when subscription ends
Please note times are UTC based

\n

OpenApi reference

\n","urlObject":{"protocol":"https","path":["v2","customers"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"04633de8-c206-4f2b-8168-1c8eed502cce","name":"200 - registered customer without a subscription","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"Testy\",\n \"surname\": \"McTesty\",\n \"mobile\": \"+27821231232\",\n \"gender\": \"male\",\n \"email\": \"test@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"businessName\": \"Liberty\",\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"bloodtype\": \"A-\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\"\n }\n}"},"url":"https://{{panicApiUrl}}/v2/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"984"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"3d8-mp4xFlnwaDr04cUnMrIq5A\""},{"key":"x-ratelimit-reset","value":"1662367481"},{"key":"date","value":"Mon, 05 Sep 2022 08:44:00 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully registered customer\",\n \"customer\": {\n \"id\": 145979,\n \"name\": \"Testy\",\n \"surname\": \"McTesty\",\n \"mobile\": \"+27821231232\",\n \"gender\": \"male\",\n \"email\": \"test@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"businessName\": \"Liberty\",\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\",\n \"customerSourceId\": 249,\n \"auth0UserId\": \"94f43abf-5c88-40d9-9e63-adf2d0ca2108\",\n \"updatedAt\": \"2022-09-05T08:44:00.937Z\",\n \"createdAt\": \"2022-09-05T08:44:00.937Z\",\n \"imageId\": null,\n \"customerTypeId\": null,\n \"referredByCodeId\": null,\n \"referredByCustomerId\": null,\n \"authOtp\": null,\n \"authOtpValidUntil\": null,\n \"_search\": null,\n \"stripeCustomerId\": null,\n \"bloodType\": null,\n \"subscriptions\": []\n }\n}"},{"id":"a649cd86-89bf-4990-b795-83c3a6986a26","name":"409 - Customer already exists","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"Testy\",\n \"surname\": \"McTesty\",\n \"mobile\": \"+27821231232\",\n \"gender\": \"male\",\n \"email\": \"test@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"businessName\": \"Liberty\",\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"bloodtype\": \"A-\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\"\n }\n}"},"url":"https://{{panicApiUrl}}/v2/customers"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1001"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"3e9-Vs6n2MydvcaG2Of05iuJ5g\""},{"key":"x-ratelimit-reset","value":"1664183665"},{"key":"date","value":"Mon, 26 Sep 2022 09:13:38 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer already exists with no active subscription\",\n \"customer\": {\n \"id\": 145979,\n \"name\": \"Testy\",\n \"surname\": \"McTesty\",\n \"mobile\": \"+27821231232\",\n \"gender\": \"male\",\n \"email\": \"test@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"customerSourceId\": 249,\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"auth0UserId\": \"94f43abf-5c88-40d9-9e63-adf2d0ca2108\",\n \"imageId\": null,\n \"businessName\": \"Liberty\",\n \"customerTypeId\": null,\n \"referredByCodeId\": null,\n \"referredByCustomerId\": null,\n \"authOtp\": null,\n \"authOtpValidUntil\": null,\n \"stripeCustomerId\": null,\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"nextOfKinName\": \"Anna\",\n \"bloodType\": null,\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\",\n \"createdAt\": \"2022-09-05T08:44:00.937Z\",\n \"updatedAt\": \"2022-09-05T08:44:00.937Z\",\n \"customersSubscriptionLinks\": []\n }\n}"}],"_postman_id":"7295cb88-a6b9-4d7c-b895-c3d13b426de4"},{"name":"Edit an existing customer's profile","id":"27acacd5-fee8-4c8a-80e7-e80e150c62c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"Alice\",\n \"surname\": \"Curtis\",\n \"mobile\": \"+27823214322\",\n \"gender\": \"male\",\n \"email\": \"myEmailHasChanged@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"businessName\": \"Black Rock\",\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"bloodtype\": \"A+\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\"\n }\n}"},"url":"https://{{panicApiUrl}}/v2/customers/{{customerId}}","description":"

Editing an existing customers profile

\n","urlObject":{"protocol":"https","path":["v2","customers","{{customerId}}"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"98c4c6fe-8cf1-4020-a505-fbe9b26d0a89","name":"200 response","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"Alice\",\n \"surname\": \"Curtis\",\n \"mobile\": \"+27823214321\",\n \"gender\": \"male\",\n \"email\": \"myEmailHasChanged@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"businessName\": \"Black Rock\",\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinName\": \"Anna\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"bloodtype\": \"A-\",\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\"\n }\n}"},"url":"http://{{panicApiUrl}}/v2/customers/{{customerId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"977"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"3d1-0w2LRs4eNC2SJ6l0VZEdhQ\""},{"key":"x-ratelimit-reset","value":"1659687181"},{"key":"date","value":"Fri, 05 Aug 2022 08:12:08 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully updated customer\",\n \"customer\": {\n \"id\": 143892,\n \"name\": \"Alice\",\n \"surname\": \"Curtis\",\n \"mobile\": \"+27823214321\",\n \"gender\": \"male\",\n \"email\": \"myEmailHasChanged@gmail.com\",\n \"createdAt\": \"2022-08-05T07:11:38.813Z\",\n \"updatedAt\": \"2022-08-05T08:12:09.201Z\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"auth0UserId\": \"18367826-d0c6-4a8c-966f-fd862e87f7f2\",\n \"customerSourceId\": 249,\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"imageId\": null,\n \"customerTypeId\": null,\n \"businessName\": \"Black Rock\",\n \"referredByCodeId\": null,\n \"referredByCustomerId\": null,\n \"authOtp\": null,\n \"authOtpValidUntil\": null,\n \"_search\": null,\n \"stripeCustomerId\": null,\n \"medicalConditions\": \"Arthritis\",\n \"medications\": \"StilPayne\",\n \"allergies\": \"Shellfish\",\n \"medicalAidNumber\": \"123456\",\n \"medicalAidScheme\": \"ProfMed\",\n \"nextOfKinNumber\": \"+27831231234\",\n \"nextOfKinName\": \"Anna\",\n \"bloodType\": null,\n \"familyDoctorPhoneNumber\": \"+27841231234\",\n \"medicalOther\": \"Body does not react well to serums\"\n }\n}"}],"_postman_id":"27acacd5-fee8-4c8a-80e7-e80e150c62c4"},{"name":"'Soft' delete a customer profile","id":"35320426-fb9c-4d61-a907-bf455a488b4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{panicApiUrl}}/v2/customers/{{customerId}}/delete","description":"

Should a user wish to delete their profile, this request will replace all user information with *'s. Here are more details about it:

\n
    \n
  1. Upon the execution of this request, all details pertaining to that customer profile will be replaced with \"* * *\". This includes name, surname, mobile number, email address, date of birth, gender, all vehicle details and all medical details.
    2. \n
  2. If profile deletion is triggered whilst a user still has an active subscription, this request will automatically cancel their subscription and provide this reason for cancellation: \"User deleted their profile\".
      \n
    1. The cancelled date of the subscription will be updated with the timestamp of when profile deletion was triggered.
      2. \n
    \n
    3. \n
  3. All callout requests that AURA has recieved from a user will be retained. However, all user information that can be seen within callout reports will be replaced with \"* * *\".
    4. \n
\n","urlObject":{"protocol":"https","path":["v2","customers","{{customerId}}","delete"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"48f2e3d6-6a3d-4bc7-9f53-482dd5b3d12d","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 123accessToken321","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://staging-panic.aura.services/panic-api/v2/customers/{{customerId}}/delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"42"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"2a-6qzKjQIorlKxMwdk0tnHQA\""},{"key":"x-ratelimit-reset","value":"1685546647"},{"key":"date","value":"Wed, 31 May 2023 15:23:35 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully deleted profile\"\n}"},{"id":"32615948-4dbf-49d4-8b23-3daab7de6798","name":"404 CustomerId Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{panicApiUrl}}/v2/customers/{{customerId}}/delete"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"32"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"20-kldabZ+7DjhXLyNT8mk68A\""},{"key":"x-ratelimit-reset","value":"1685547832"},{"key":"date","value":"Wed, 31 May 2023 15:43:14 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"Customer not found.\"\n}"}],"_postman_id":"35320426-fb9c-4d61-a907-bf455a488b4c"}],"id":"d92967eb-66db-477c-becb-ed8004502917","description":"

This section relates to user registration & management.

\n","_postman_id":"d92967eb-66db-477c-becb-ed8004502917"},{"name":"Subscription Management","item":[{"name":"Activate a single customer subscription","id":"7a0a3593-bfd4-44f7-87d7-bcdddd67776e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 155596,\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2023-03-09T00:00:17.995Z\",\n \"validTo\": \"2123-08-05T06:00:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions","description":"

You will be able to link a subscription to a customer via their AURA customerId.

\n

API_single subscription values

\n

SubscriptionTypeId\nStaging: 2\nProduction: 12

\n","urlObject":{"protocol":"https","path":["v2","subscriptions"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"0d9198a1-225d-4c5c-84f6-c7aa2b03755b","name":"200 - subscription created successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 143893,\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2022-08-05T06:00:17.995Z\",\n \"validTo\": \"2023-08-05T06:00:00.000Z\"\n}"},"url":"http://{{panicApiUrl}}/v2/subscriptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"373"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"175-97EoUccso4tndF4uNefYUg\""},{"key":"x-ratelimit-reset","value":"1659689816"},{"key":"date","value":"Fri, 05 Aug 2022 08:56:49 GMT"},{"key":"x-ratelimit-remaining","value":"28"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully activated customer subscription\",\n \"subscription\": {\n \"id\": 152263,\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2022-08-05T06:00:17.995Z\",\n \"validTo\": \"2023-08-05T06:00:00.000Z\",\n \"updatedAt\": \"2022-08-05T08:56:49.300Z\",\n \"createdAt\": \"2022-08-05T08:56:49.300Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"subscriptionToken\": null,\n \"customerId\": 143893\n },\n \"dependantLinks\": []\n}"},{"id":"70c4c6a1-1d66-4297-911e-f4772df809b3","name":"409 - Subscription for customer already exists","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 143905,\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2022-08-08T06:00:17.995Z\",\n \"validTo\": \"2123-08-05T06:00:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"574"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"23e-7o1z61hNvW9u5ph9YSr8YA\""},{"key":"x-ratelimit-reset","value":"1664184010"},{"key":"date","value":"Mon, 26 Sep 2022 09:19:15 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Subscription for main customer with id 143905 already exists\",\n \"subscription\": {\n \"id\": 152285,\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2022-08-08T06:00:17.995Z\",\n \"validTo\": \"2123-08-05T06:00:00.000Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"subscriptionToken\": null,\n \"createdAt\": \"2022-08-08T12:51:56.606Z\",\n \"updatedAt\": \"2022-08-08T12:51:56.606Z\",\n \"subscriptionType\": {\n \"id\": 2,\n \"description\": \"API single subscription\",\n \"value\": \"API_SINGLE\",\n \"createdAt\": \"2019-04-04T08:03:29.253Z\",\n \"updatedAt\": \"2019-04-04T08:03:29.253Z\",\n \"numberOfAllowedDependents\": null,\n \"recurringBilling\": false\n }\n }\n}"},{"id":"0b82bc13-5469-4c33-8e08-c6aa935860e3","name":"404 - customerId does not exist","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 143908,\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2022-08-08T06:00:17.995Z\",\n \"validTo\": \"2123-08-05T06:00:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"32"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"20-kldabZ+7DjhXLyNT8mk68A\""},{"key":"x-ratelimit-reset","value":"1664184077"},{"key":"date","value":"Mon, 26 Sep 2022 09:20:16 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"Customer not found.\"\n}"},{"id":"cac10cd4-0b7e-409f-9461-422fac8085f9","name":"400 - Incorrect subscription type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 143905,\n \"subscriptionTypeId\": 6842,\n \"validFrom\": \"2022-08-08T06:00:17.995Z\",\n \"validTo\": \"2123-08-05T06:00:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"90"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"5a-o67n3+ocM0nKSyFvg7EjeA\""},{"key":"x-ratelimit-reset","value":"1664184169"},{"key":"date","value":"Mon, 26 Sep 2022 09:22:47 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"The subscriptionType does not exist for the SubscriptionTypeId in the request\"\n}"},{"id":"385382f6-8d0a-4500-a824-3bc72ef81efe","name":"400 - validFrom date in the past","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 143905,\n \"subscriptionTypeId\": 2,\n \"validFrom\": \"2022-08-08T06:00:17.995Z\",\n \"validTo\": \"2123-08-05T06:00:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"80"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"50-fxEq0r72Vf/g5WFjCK6bIQ\""},{"key":"x-ratelimit-reset","value":"1664184246"},{"key":"date","value":"Mon, 26 Sep 2022 09:23:05 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"Date ranges cannot be in the past. Please enter a valid date range.\"\n}"}],"_postman_id":"7a0a3593-bfd4-44f7-87d7-bcdddd67776e"},{"name":"Activate a family subscription","id":"4866bcc4-510c-4b44-8742-b0fd269e0f72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 1438999,\n \"dependantCustomerIds\": [\n 143893,\n 143903,\n 143904\n ],\n \"subscriptionTypeId\": 12,\n \"validFrom\": \"2023-03-09T00:00:00.995Z\",\n \"validTo\": \"2122-08-05T06:00:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions","description":"

As mentioned above family subscriptions are also available for use.

\n

The dependants are included in the dependantCustomerId array.

\n

If the MainMembers subscription is cancelled all the dependants subscriptions will be cancelled.

\n","urlObject":{"protocol":"https","path":["v2","subscriptions"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"aff19ebc-1769-4e34-a178-6ccb6202b078","name":"200 - Successfully created a family subscription","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 143892,\n \"dependantCustomerIds\": [\n 143893,\n 143903,\n 143904\n ],\n \"subscriptionTypeId\": 12,\n \"validFrom\": \"2022-08-08T06:00:00.995Z\",\n \"validTo\": \"2122-08-05T06:00:00.000Z\"\n}"},"url":"http://{{panicApiUrl}}/v2/subscriptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"862"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"35e-4CIwp8nK3iX6BHFOeUMA+g\""},{"key":"x-ratelimit-reset","value":"1659953231"},{"key":"date","value":"Mon, 08 Aug 2022 10:07:08 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully activated customer subscription\",\n \"subscription\": {\n \"id\": 152283,\n \"subscriptionTypeId\": 12,\n \"validFrom\": \"2022-08-08T06:00:00.995Z\",\n \"validTo\": \"2122-08-05T06:00:00.000Z\",\n \"updatedAt\": \"2022-08-08T10:07:09.260Z\",\n \"createdAt\": \"2022-08-08T10:07:09.260Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"subscriptionToken\": null,\n \"customerId\": 143892\n },\n \"dependantLinks\": [\n {\n \"id\": 153645,\n \"customerId\": 143893,\n \"subscriptionId\": 152283,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2022-08-08T10:07:09.286Z\",\n \"createdAt\": \"2022-08-08T10:07:09.286Z\"\n },\n {\n \"id\": 153646,\n \"customerId\": 143903,\n \"subscriptionId\": 152283,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2022-08-08T10:07:09.300Z\",\n \"createdAt\": \"2022-08-08T10:07:09.300Z\"\n },\n {\n \"id\": 153647,\n \"customerId\": 143904,\n \"subscriptionId\": 152283,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2022-08-08T10:07:09.307Z\",\n \"createdAt\": \"2022-08-08T10:07:09.307Z\"\n }\n ]\n}"},{"id":"2216ae5e-d7ff-4006-abe2-6899fca5fc6a","name":"400 - mainMember customerId does not exist","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 1438999,\n \"dependantCustomerIds\": [\n 143893,\n 143903,\n 143904\n ],\n \"subscriptionTypeId\": 12,\n \"validFrom\": \"2022-08-08T06:00:00.995Z\",\n \"validTo\": \"2122-08-05T06:00:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"35-yT8grTFbkrVQ9JGaxH01dA\""},{"key":"x-ratelimit-reset","value":"1664184469"},{"key":"date","value":"Mon, 26 Sep 2022 09:26:57 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"Customer with id 1438999, does not exist\"\n}"},{"id":"444491ae-ddd0-478e-9ae3-55bc42b7a3ad","name":"409 - dependant customerId does not exist","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 143892,\n \"dependantCustomerIds\": [\n 1438931,\n 1439031,\n 1439041\n ],\n \"subscriptionTypeId\": 12,\n \"validFrom\": \"2022-08-08T06:00:00.995Z\",\n \"validTo\": \"2122-08-05T06:00:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"101"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"65-Wu/+z0nM8CCqEE6Go8kZ5w\""},{"key":"x-ratelimit-reset","value":"1664184469"},{"key":"date","value":"Mon, 26 Sep 2022 09:27:15 GMT"},{"key":"x-ratelimit-remaining","value":"28"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Dependant Customer with id 1438931 not found, please check request.\",\n \"subscription\": null\n}"},{"id":"02acc93e-9d35-4e1e-854c-85897537c55c","name":"400 - The subscriptionType does not support dependants","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 143892,\n \"dependantCustomerIds\": [\n 143893,\n 143903,\n 143904\n ],\n \"subscriptionTypeId\": 6842,\n \"validFrom\": \"2022-08-08T06:00:00.995Z\",\n \"validTo\": \"2122-08-05T06:00:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"90"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"5a-o67n3+ocM0nKSyFvg7EjeA\""},{"key":"x-ratelimit-reset","value":"1664184469"},{"key":"date","value":"Mon, 26 Sep 2022 09:27:36 GMT"},{"key":"x-ratelimit-remaining","value":"27"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"The subscriptionType does not exist for the SubscriptionTypeId in the request\"\n}"},{"id":"7c684bad-90ef-4826-b2d1-f07a3ff10e93","name":"400 - validFrom date before the current date","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 143892,\n \"dependantCustomerIds\": [\n 143893,\n 143903,\n 143904\n ],\n \"subscriptionTypeId\": 12,\n \"validFrom\": \"2022-08-08T06:00:00.995Z\",\n \"validTo\": \"2122-08-05T06:00:00.000Z\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"80"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"50-fxEq0r72Vf/g5WFjCK6bIQ\""},{"key":"x-ratelimit-reset","value":"1664184530"},{"key":"date","value":"Mon, 26 Sep 2022 09:27:49 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"Date ranges cannot be in the past. Please enter a valid date range.\"\n}"}],"_postman_id":"4866bcc4-510c-4b44-8742-b0fd269e0f72"},{"name":"Remove a single subscription","id":"b2717e65-8d74-4d06-ba56-9f5b617e359a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Customer no longer active\"\n}"},"url":"https://{{panicApiUrl}}/v2/subscriptions/{{subscriptionId}}","description":"

This removes an active subscription from a customer.

\n

It is important to note that gathering cancellation reasons are critical as it allows the business to understand the reasoning of their users

\n","urlObject":{"protocol":"https","path":["v2","subscriptions","{{subscriptionId}}"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"093c4660-3a8b-4323-acda-a54c0ba9f729","name":"200 Response","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"url":"http://{{panicApiUrl}}/v2/subscriptions/{{subscriptionId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"72"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"48-fCX5f8ThoN4IrfsqJii+kQ\""},{"key":"x-ratelimit-reset","value":"1659953531"},{"key":"date","value":"Mon, 08 Aug 2022 10:11:24 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully deleted subscription\",\n \"subscriptionToken\": null\n}"}],"_postman_id":"b2717e65-8d74-4d06-ba56-9f5b617e359a"},{"name":"Remove a family subscription","id":"d2ddd6a5-b54d-4df1-9488-60c037afd818","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Customer no longer active\"\n}"},"url":"http://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}","description":"

By cancelling the main members subscription, all dependant subscriptions will be cancelled as well. To remove a dependant from a subscription please see 'Remove a dependant'

\n","urlObject":{"protocol":"http","path":["v2","subscriptions","{{mainMemberSubId}}"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"8780f163-4e3c-4a66-aebb-04fddc241af9","name":"200 Response","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"url":"http://{{panicApiUrl}}/v2/subscriptions/{{familySubId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"72"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"48-fCX5f8ThoN4IrfsqJii+kQ\""},{"key":"x-ratelimit-reset","value":"1659953771"},{"key":"date","value":"Mon, 08 Aug 2022 10:15:57 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully deleted subscription\",\n \"subscriptionToken\": null\n}"}],"_postman_id":"d2ddd6a5-b54d-4df1-9488-60c037afd818"},{"name":"Add a dependant","id":"d711dc3c-e680-4f49-89b5-584c04f6e85d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 143893,\n 143903,\n 143904\n ],\n \"validTo\": \"2122-08-08T21:59:00.000Z\"\n}"},"url":"http://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}","description":"

Dependants are stored in an array.

\n

To add a new dependant to a subscription all previous dependant customerId's plus the new dependant customerId will have to be sent in the request.

\n

If the previously active dependants are not sent in the PUT request they will be removed from the array.

\n","urlObject":{"protocol":"http","path":["v2","subscriptions","{{mainMemberSubId}}"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"b3ecbfcf-4543-4541-9903-aa2cac13bf97","name":"200 Response","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 143893,\n 143903,\n 143904\n ],\n \"validTo\": \"2122-08-08T21:59:00.000Z\"\n}"},"url":"http://{{panicApiUrl}}/v2/subscriptions/{{familySubId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"778"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"30a-61LUiC6HMgE5QOFfZ+a4fA\""},{"key":"x-ratelimit-reset","value":"1659954725"},{"key":"date","value":"Mon, 08 Aug 2022 10:31:09 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": [\n {\n \"id\": 153657,\n \"customerId\": 143893,\n \"subscriptionId\": 152284,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2022-08-08T10:31:09.728Z\",\n \"createdAt\": \"2022-08-08T10:31:09.728Z\"\n },\n {\n \"id\": 153658,\n \"customerId\": 143903,\n \"subscriptionId\": 152284,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2022-08-08T10:31:09.739Z\",\n \"createdAt\": \"2022-08-08T10:31:09.739Z\"\n },\n {\n \"id\": 153659,\n \"customerId\": 143904,\n \"subscriptionId\": 152284,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2022-08-08T10:31:09.745Z\",\n \"createdAt\": \"2022-08-08T10:31:09.745Z\"\n }\n ],\n \"subscription\": [\n {\n \"id\": 152284,\n \"subscriptionTypeId\": 12,\n \"validFrom\": \"2022-08-08T06:00:00.995Z\",\n \"validTo\": \"2122-08-08T21:59:00.000Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"createdAt\": \"2022-08-08T10:24:32.265Z\",\n \"updatedAt\": \"2022-08-08T10:31:09.753Z\",\n \"subscriptionToken\": null\n }\n ]\n}"}],"_postman_id":"d711dc3c-e680-4f49-89b5-584c04f6e85d"},{"name":"Remove a dependant","id":"4c85bdcd-06dd-48c5-94de-4c338685380e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 143893,\n 143903\n ],\n \"validTo\": \"2122-08-08T06:59:00.000Z\"\n}"},"url":"http://{{panicApiUrl}}/v2/subscriptions/{{mainMemberSubId}}","description":"

Dependants are stored in an array.

\n

To remove a dependant from a subscription all previous dependant customerId's other than the customerId to remove will have to be sent in the request.

\n

If the previously active dependants are not sent in the PUT request they will be removed from the array.

\n

In the example below customerId 143904 from adding a dependant was left out of the put request to remove their subscription

\n","urlObject":{"protocol":"http","path":["v2","subscriptions","{{mainMemberSubId}}"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"c8acb715-1e3f-46de-811a-ec893e8797e6","name":"200 response","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dependantCustomerIds\": [\n 143893,\n 143903\n ],\n \"validTo\": \"2122-08-08T06:59:00.000Z\"\n}"},"url":"http://{{panicApiUrl}}/v2/subscriptions/{{familySubId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"615"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"267-08ZkMrUKFCH0cUjpvfDKjA\""},{"key":"x-ratelimit-reset","value":"1659954605"},{"key":"date","value":"Mon, 08 Aug 2022 10:29:10 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"script-src 'self' https://js.stripe.com https://checkout.stripe.com 'unsafe-inline';connect-src 'self' https://checkout.stripe.com https://api.stripe.com;img-src 'self' https://*.stripe.com https: data:;frame-src 'self' https://checkout.stripe.com https://js.stripe.com https://hooks.stripe.com;default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';object-src 'none';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": [\n {\n \"id\": 153652,\n \"customerId\": 143893,\n \"subscriptionId\": 152284,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2022-08-08T10:29:11.036Z\",\n \"createdAt\": \"2022-08-08T10:29:11.036Z\"\n },\n {\n \"id\": 153653,\n \"customerId\": 143903,\n \"subscriptionId\": 152284,\n \"relationship\": \"DEPENDANT\",\n \"updatedAt\": \"2022-08-08T10:29:11.066Z\",\n \"createdAt\": \"2022-08-08T10:29:11.066Z\"\n }\n ],\n \"subscription\": [\n {\n \"id\": 152284,\n \"subscriptionTypeId\": 12,\n \"validFrom\": \"2022-08-08T06:00:00.995Z\",\n \"validTo\": \"2122-08-08T06:59:00.000Z\",\n \"CancelledDate\": null,\n \"CancelledReason\": null,\n \"createdAt\": \"2022-08-08T10:24:32.265Z\",\n \"updatedAt\": \"2022-08-08T10:29:11.076Z\",\n \"subscriptionToken\": null\n }\n ]\n}"}],"_postman_id":"4c85bdcd-06dd-48c5-94de-4c338685380e"},{"name":"View Subscription types & limitations","id":"e9976a8f-4e68-411f-b155-60c099d08f31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"url":"https://{{panicApiUrl}}/v2/subscriptions/subscriptionTypes","description":"

This allows you to view all active subscriptionTypes offered by AURA

\n","urlObject":{"protocol":"https","path":["v2","subscriptions","subscriptionTypes"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9976a8f-4e68-411f-b155-60c099d08f31"}],"id":"866aa7cb-1720-4f04-a43c-07aaec6ed309","description":"

This section will focus on subscription management

\n","_postman_id":"866aa7cb-1720-4f04-a43c-07aaec6ed309"},{"name":"Link an IoT device to a customer","id":"87561699-90c8-43fe-a75c-78a98b6badb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 48,\n \"deviceSerial\": \"111111111111111AAABBBB\",\n \"deviceAlias\": \"Panic Button\",\n \"deviceSupplier\": \"Supplier\",\n \"firmwareVersion\": 1\n}"},"url":"https://{{panicApiUrl}}/v2/devices","description":"

This allows an integrator to link an IoT device to a registered customer.

\n

Your IoT device needs to be registered with AURA before you can link it to a customer as is highlighted above in the 'Getting Started' section.

\n

Your device serial is a value that is inputted in the body of this request for the first time as well as the device alias and firmware version.

\n

The value that you pass for the device serial in this request will automatically become the value of the deviceId which is a required piece of information for all callout requests.

\n

Take note of the deviceTypeId for the IoT device you have linked to the customer in the API response, as this Id will be needed to post callout requests.

\n","urlObject":{"protocol":"https","path":["v2","devices"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"3f49fbf0-2e27-48f8-962e-8c1b8ba6aa24","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 157886,\n \"deviceSerial\": \"1234567890\",\n \"deviceAlias\": \"Panic Button\",\n \"deviceSupplier\": \"Supplier\",\n \"firmwareVersion\": 1\n}"},"url":"https://staging-panic.aura.services/panic-api/v2/devices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"374"},{"key":"Connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"etag","value":"W/\"176-f5rmasLlDuYYnrVEsYHXZQ\""},{"key":"x-ratelimit-reset","value":"1686060803"},{"key":"date","value":"Tue, 06 Jun 2023 14:12:24 GMT"},{"key":"x-ratelimit-remaining","value":"29"},{"key":"x-ratelimit-limit","value":"30"},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"defaultLocation\": null,\n \"healthCheckLastReceivedDate\": null,\n \"batteryLevel\": null,\n \"batteryLevelLastReceivedDate\": null,\n \"id\": 118,\n \"deviceTypeId\": 7,\n \"alias\": \"Panic Button\",\n \"firmwareVersion\": \"1\",\n \"customerId\": 157886,\n \"deviceId\": \"1234567890\",\n \"deviceSerial\": \"1234567890\",\n \"customerSourceId\": 310,\n \"updatedAt\": \"2023-06-06T14:12:24.292Z\",\n \"createdAt\": \"2023-06-06T14:12:24.292Z\",\n \"_search\": null\n}"},{"id":"adf96086-e472-4237-9e26-50256c1c7ad4","name":"404 Customer Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 73839,\n \"deviceSerial\": \"H8870\",\n \"deviceAlias\": \"Panic Button\",\n \"deviceSupplier\": \"Supplier\",\n \"firmwareVersion\": 1\n}"},"url":"https://{{panicApiUrl}}/v2/devices"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Tue, 30 Jan 2024 08:46:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"32"},{"key":"Connection","value":"keep-alive"},{"key":"etag","value":"W/\"20-ayp7bAepdeC6ew5WQGAvoRPhJ9U\""},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": \"Customer not found.\"\n}"}],"_postman_id":"87561699-90c8-43fe-a75c-78a98b6badb1"},{"name":"Creating a callout","id":"48d18bdb-0908-48c0-817e-1809c2354528","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{panicApiToken}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\"location\":{\n\"latitude\":-26.091925068187997,\n\"longitude\":28.08404904124237,\n\"accuracy\":70\n},\n\"device_id\":262179391,\n\"device_type_id\":4,\n\"message_type\":1\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent","description":"

This will generate a new callout from the IoT device. When AURA recieves this callout, our ringing algorithim will automaically start dispatching the nearest responder to the location recieved.

\n

device_id - Used to identify the device by mimicing the device serial

\n

device_type_id - Specific to the model of the IoT device

\n

message_type: This defines the type of event to request

\n","urlObject":{"protocol":"https","path":["v2","deviceEvent"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"19a971b9-a7b2-406a-8d4f-7ae2a6444564","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\"location\":{\n\"latitude\":23.1122,\n\"longitude\":78.2211,\n\"accuracy\":70\n},\n\"device_id\":13,\n\"device_type_id\":4,\n\"message_type\":3\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Thu, 02 Mar 2023 07:58:47 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"277"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Event successfully processed...\",\"input\":{\"location\":{\"latitude\":23.1122,\"longitude\":78.2211,\"accuracy\":70},\"device_id\":13,\"device_type_id\":4,\"message_type\":3},\"resolvedAuraEvent\":{\"eventTypes\":\"CALLOUT_CANCELLED\",\"eventResponse\":{\"calloutId\":69803,\"deviceId\":13}}}"},{"id":"a34b252b-7198-4f27-bb84-b5f11c9c3abc","name":"401 Unauthorised","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\"location\":{\n\"latitude\":23.1122,\n\"longitude\":78.2211,\n\"accuracy\":70\n},\n\"device_id\":13,\n\"device_type_id\":4,\n\"message_type\":3\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Thu, 02 Mar 2023 08:05:44 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":{\"message\":\"invalid signature\"}}"},{"id":"83ca6cd7-3290-420b-879b-817727443498","name":"500 No customer linked to device ID","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\"location\":{\n\"latitude\":23.1122,\n\"longitude\":78.2211,\n\"accuracy\":70\n},\n\"device_id\":13749494,\n\"device_type_id\":4,\n\"message_type\":3\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Thu, 02 Mar 2023 08:06:40 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"177"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Something went wrong with the request...\",\"error\":{\"message\":\"Request failed with status code 404\",\"data\":{\"message\":\"No customer found linked to device 13749494\"}}}"},{"id":"3c2903e5-795a-4f3d-b17a-16d6b5753f71","name":"404 Message type does not exist","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\"location\":{\n\"latitude\":23.1122,\n\"longitude\":78.2211,\n\"accuracy\":70\n},\n\"device_id\":13,\n\"device_type_id\":4,\n\"message_type\":9\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Not Found","code":404,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Thu, 02 Mar 2023 08:28:17 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"185"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"There is no default event in deviceTemplate.\",\"input\":{\"location\":{\"latitude\":23.1122,\"longitude\":78.2211,\"accuracy\":70},\"device_id\":13,\"device_type_id\":4,\"message_type\":9}}"}],"_postman_id":"48d18bdb-0908-48c0-817e-1809c2354528"},{"name":"Update the location of a callout","id":"994a53f6-5be5-4024-93e8-5f20e53d3754","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{panicApiToken}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"latitude\":-26.10163720422094,\n\"longitude\":28.0719469143228,\n\"accuracy\":70,\n\"device_id\":262179391,\n\"device_type_id\":4,\n\"message_type\":2\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent","description":"

Once a callout has been created AURA will need to be polled with location updates from the device until you recieve a 500 response - \"No open callout for customer with id XXX\"

\n

Polling with location updates is recommended to be between 5-20 seconds to ensure location accuracy for the responder.

\n

Once the callout reaches a 'closed' status there is no longer a need for location updates to be sent.

\n

device_id - Used to identify the device by mimicing the device serial

\n

device_type_id - Specific to the model of the IoT device

\n

message_type: This defines the type of event to request

\n","urlObject":{"protocol":"https","path":["v2","deviceEvent"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"5838561e-b072-430a-9faf-0163c36fd7f7","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"latitude\":24.1122,\n\"longitude\":79.2211,\n\"accuracy\":70,\n\"device_id\":13,\n\"device_type_id\":4,\n\"message_type\":2\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Mon, 06 Mar 2023 08:11:36 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"240"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Event successfully processed...\",\"input\":{\"latitude\":24.1122,\"longitude\":79.2211,\"accuracy\":70,\"device_id\":13,\"device_type_id\":4,\"message_type\":2},\"resolvedAuraEvent\":{\"eventTypes\":\"CALLOUT_LOCATION_UPDATED\",\"eventResponse\":{}}}"},{"id":"194efa95-85cd-4772-9143-ad95da0bcb73","name":"401 Unauthorised","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"latitude\":24.1122,\n\"longitude\":79.2211,\n\"accuracy\":70,\n\"device_id\":13,\n\"device_type_id\":4,\n\"message_type\":2\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Mon, 06 Mar 2023 08:15:46 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":{\"message\":\"invalid signature\"}}"},{"id":"4f2ef9dc-4121-4db7-8bcb-e99fbc32a81e","name":"500 No customer linked to device ID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"latitude\":24.1122,\n\"longitude\":79.2211,\n\"accuracy\":70,\n\"device_id\":132,\n\"device_type_id\":4,\n\"message_type\":2\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Mon, 06 Mar 2023 08:17:13 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"172"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Something went wrong with the request...\",\"error\":{\"message\":\"Request failed with status code 404\",\"data\":{\"message\":\"No customer found linked to device 132\"}}}"},{"id":"bfb36da2-d722-4d26-bede-3a870d6895b9","name":"404 Message type does not exist","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"latitude\":24.1122,\n\"longitude\":79.2211,\n\"accuracy\":70,\n\"device_id\":13,\n\"device_type_id\":4,\n\"message_type\":9\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Not Found","code":404,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Mon, 06 Mar 2023 08:19:09 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"172"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"There is no default event in deviceTemplate.\",\"input\":{\"latitude\":24.1122,\"longitude\":79.2211,\"accuracy\":70,\"device_id\":13,\"device_type_id\":4,\"message_type\":9}}"},{"id":"9abcef50-d1b1-42c3-a9d4-016d29f8f7a6","name":"500 Callout has been closed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"latitude\":-26.10163720422094,\n\"longitude\":28.0719469143228,\n\"accuracy\":70,\n\"device_id\":13,\n\"device_type_id\":4,\n\"message_type\":2\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Mon, 06 Mar 2023 11:01:45 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"176"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Something went wrong with the request...\",\"error\":{\"message\":\"Request failed with status code 404\",\"data\":{\"errors\":\"No open callout for customer with id 148695\"}}}"}],"_postman_id":"994a53f6-5be5-4024-93e8-5f20e53d3754"},{"name":"Cancel a callout","id":"25346638-08e5-44e8-8e89-ded9f05a9194","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{panicApiToken}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"device_id\":262179391,\n\"device_type_id\":4,\n\"message_type\":3\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent","description":"

This request will cancel an existing callout.

\n

Note: This request is seen as a 'soft dismissal'. This means that the callout will not reach a closed status when executing this request. The AURA control centre will confirm this with the end-user via their duress code. If the correct duress code is given, AURA will close the callout. If the incorrect duress code is given we will continue to dispatch as per normal.

\n

device_id - Used to identify the device by mimicing the device serial

\n

device_type_id - Specific to the model of the IoT device

\n

message_type: This defines the type of event to request

\n","urlObject":{"protocol":"https","path":["v2","deviceEvent"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"8c56909a-a781-4718-b3e0-1dc7d94c87be","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"device_id\":13,\n\"device_type_id\":4,\n\"message_type\":3\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Thu, 02 Mar 2023 08:03:00 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"211"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Event successfully processed...\",\"input\":{\"device_id\":13,\"device_type_id\":4,\"message_type\":3},\"resolvedAuraEvent\":{\"eventTypes\":\"CALLOUT_CANCELLED\",\"eventResponse\":{\"calloutId\":69803,\"deviceId\":13}}}"},{"id":"6cea8f45-48e6-4912-8ab3-1c8fc06a75dc","name":"401 Unauthorised","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"device_id\":13,\n\"device_type_id\":4,\n\"message_type\":3\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Thu, 02 Mar 2023 08:03:51 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":{\"message\":\"invalid signature\"}}"},{"id":"b7b96e1b-413c-4d23-897d-ea4996321fd2","name":"500 No customer linked to device ID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"device_id\":13754576,\n\"device_type_id\":4,\n\"message_type\":3\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Thu, 02 Mar 2023 08:08:11 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"177"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Something went wrong with the request...\",\"error\":{\"message\":\"Request failed with status code 404\",\"data\":{\"message\":\"No customer found linked to device 13754576\"}}}"},{"id":"9a6e99dc-6d0e-4bf2-a66a-fa07e918cfa4","name":"404 Message type does not exist","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"device_id\":13,\n\"device_type_id\":4,\n\"message_type\":9\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Not Found","code":404,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Thu, 02 Mar 2023 08:31:17 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"125"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"There is no default event in deviceTemplate.\",\"input\":{\"device_id\":13754576,\"device_type_id\":4,\"message_type\":9}}"}],"_postman_id":"25346638-08e5-44e8-8e89-ded9f05a9194"},{"name":"Return a specifc callout","id":"08da6c03-84e2-4a52-88b5-4a0f7014923b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{panicApiUrl}}/v2/callouts/{{calloutId}}","description":"

Allows an integrator to return all information for a specific callout ID.

\n","urlObject":{"protocol":"https","path":["v2","callouts","{{calloutId}}"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"32d8fe00-a77b-43b6-b5fe-924882b58f22","name":"200 Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{panicApiUrl}}/v2/callouts/{{calloutId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Tue, 30 Jan 2024 08:21:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1270"},{"key":"Connection","value":"keep-alive"},{"key":"etag","value":"W/\"4f6-Wy33dt1x0o4pje9JqAxpH12Ksr0\""},{"key":"x-xss-protection","value":"0"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"access-control-allow-origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully fetched Callout\",\n \"callout\": {\n \"id\": 73399,\n \"status\": \"created\",\n \"cancelledByCustomer\": false,\n \"dispatchRequired\": true,\n \"internalTest\": false,\n \"verified\": true,\n \"externalRefId\": null,\n \"customer\": {\n \"id\": 157886,\n \"name\": \"Tommy\",\n \"surname\": \"Shelby\",\n \"mobile\": \"+27897776650\",\n \"gender\": \"male\",\n \"email\": \"myEmailHasChanged@gmail.com\",\n \"vehicleMake\": \"Toyota\",\n \"vehicleModel\": \"Corolla\",\n \"vehicleColour\": \"white\",\n \"vehicleLicensePlate\": \"AB12CDGP\",\n \"dateOfBirth\": \"1993-09-25T00:00:00Z\",\n \"auth0UserId\": \"1e9aec33-b3aa-43cd-99a7-a8e92dc3fb9c\",\n \"imageId\": null,\n \"businessName\": \"55\",\n \"customerTypeId\": null\n },\n \"incidentInformation\": [\n {\n \"calloutId\": 73399,\n \"status\": \"created\",\n \"createdAt\": \"2024-01-30T08:21:20.278Z\",\n \"calloutClassification\": {\n \"id\": 1,\n \"value\": \"REAL\"\n },\n \"verified\": true,\n \"responseType\": {\n \"id\": 3,\n \"value\": \"DEMO\"\n },\n \"incidentDetails\": null,\n \"typeOfEmergency\": null,\n \"incidentcategory\": null,\n \"calloutCurrentLocation\": {\n \"latitude\": \"26.17935\",\n \"longitude\": \"28.189708333333\",\n \"formattedAddress\": null,\n \"region\": null,\n \"city\": null,\n \"country\": null,\n \"description\": null,\n \"placeId\": null,\n \"calloutLocationType\": null\n },\n \"dispatchInformation\": {\n \"responderDispatchedAt\": null,\n \"responderArrivedAt\": null,\n \"responderCompletedAt\": null,\n \"responder\": null,\n \"supplier\": null,\n \"calloutResponseEta\": null,\n \"responderRoute\": null\n },\n \"calloutEvents\": []\n }\n ]\n }\n}"}],"_postman_id":"08da6c03-84e2-4a52-88b5-4a0f7014923b"},{"name":"Recieve a device battery update","id":"146b4762-1aad-4f42-81fe-98016d90a63c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\"battery\":70,\n\"device_id\":13,\n\"device_type_id\":4,\n\"message_type\":4\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent","description":"

This request will recieve the battery level of the IoT device.

\n

Note: This is not a health check

\n

battery: This value represents what the battery level/percentage is of the IoT device when sending the reqeust.

\n

device_id - Used to identify the device by mimicing the device serial

\n

device_type_id - Specific to the model of the IoT device

\n

message_type: This defines the type of event to request

\n","urlObject":{"protocol":"https","path":["v2","deviceEvent"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"7534f227-2f4e-4e18-9e0d-f83ccced1ff7","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\"battery\":15,\n\"device_id\":13,\n\"device_type_id\":4,\n\"message_type\":4\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Fri, 03 Mar 2023 13:39:38 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"262"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Event successfully processed...\",\"input\":{\"battery\":15,\"device_id\":13,\"device_type_id\":4,\"message_type\":4},\"resolvedAuraEvent\":{\"eventTypes\":\"DEVICE_BATTERY_INFO_RECEIVED\",\"eventResponse\":{\"deviceId\":13,\"isHeartbeatMessage\":false,\"batteryLevel\":15}}}"},{"id":"108b71b7-9674-4661-a1c5-9f7a1ccfc830","name":"401 Unauthorised","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\"battery\":15,\n\"device_id\":13,\n\"device_type_id\":4,\n\"message_type\":4\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Mon, 06 Mar 2023 08:04:40 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":{\"message\":\"invalid signature\"}}"},{"id":"071f93ef-17d2-422c-ba85-10fc0b237f7a","name":"500 No customer linked to device ID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\"battery\":15,\n\"device_id\":138474,\n\"device_type_id\":4,\n\"message_type\":4\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Mon, 06 Mar 2023 08:05:17 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"175"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Something went wrong with the request...\",\"error\":{\"message\":\"Request failed with status code 404\",\"data\":{\"message\":\"No customer found linked to device 138474\"}}}"},{"id":"d5360248-556a-4165-b317-527a40b312d6","name":"404 Message type does not exist","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\"battery\":15,\n\"device_id\":13,\n\"device_type_id\":4,\n\"message_type\":41\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Not Found","code":404,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Mon, 06 Mar 2023 08:06:26 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"133"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"There is no default event in deviceTemplate.\",\"input\":{\"battery\":15,\"device_id\":13,\"device_type_id\":4,\"message_type\":41}}"}],"_postman_id":"146b4762-1aad-4f42-81fe-98016d90a63c"},{"name":"Recieve a device health check","id":"ff89ec3d-4fad-4928-8e1c-eb79b3f01275","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"device_id\": \"1234567890\",\n \"message_type\": \"4\",\n \"device_type_id\": 7,\n \"isHeartbeatMessage\": true\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent","description":"

This request will recieve a health check/heartbeat of the IoT device.

\n

isHeartbeatMessage: True indiciates that this is a hearbeat, not a battery update.

\n

device_id: This specifies the supplier of the device.

\n

device_type_id: This specifies the model of the device.

\n

message_type: This defines the type of event to request.

\n","urlObject":{"protocol":"https","path":["v2","deviceEvent"],"host":["{{panicApiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"19d33342-85db-4bf2-8a5e-4cd0052b0db1","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"device_id\": \"1234567890\",\n \"message_type\": \"Gryf4\",\n \"device_type_id\": 7,\n \"isHeartbeatMessage\": true\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Wed, 07 Jun 2023 14:52:45 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"302"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Event successfully processed...\",\"input\":{\"device_id\":\"1234567890\",\"message_type\":4,\"device_type_id\":7,\"isHeartbeatMessage\":true},\"resolvedAuraEvent\":{\"eventTypes\":\"DEVICE_BATTERY_INFO_RECEIVED\",\"eventResponse\":{\"deviceId\":\"1234567890\",\"isHeartbeatMessage\":true,\"batteryLevel\":null}}}"},{"id":"d139bb0c-532f-49ec-9798-666cc239624f","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer iheoie","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"device_id\": \"1234567890\",\n \"message_type\": \"4\",\n \"device_type_id\": 7,\n \"isHeartbeatMessage\": true\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Mon, 12 Jun 2023 08:50:06 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"50"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":{\"message\":\"Malformed Json Web Token\"}}"},{"id":"eb3d693b-a46e-4fac-a995-e0d4d6c12c0a","name":"500 No Customer Linked to Device Id","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"device_id\": \"12345678\",\n \"message_type\": \"Gryf4\",\n \"device_type_id\": 7,\n \"isHeartbeatMessage\": true\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Mon, 12 Jun 2023 08:58:30 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"177"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Something went wrong with the request...\",\"error\":{\"message\":\"Request failed with status code 404\",\"data\":{\"message\":\"No customer found linked to device 12345678\"}}}"},{"id":"812ac91c-c29a-4cf7-a56f-5c1dd9ca129c","name":"404 No Device Type Id Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"device_id\": \"1234567890\",\n \"message_type\": \"Gryf4\",\n \"device_type_id\": 9,\n \"isHeartbeatMessage\": true\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Not Found","code":404,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Mon, 12 Jun 2023 08:59:14 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"259"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Device template is not found for this auraDeviceTypeId. Please contact AURA support to set up a new deviceTemplate with this auraDeviceTypeId.\",\"input\":{\"device_id\":\"1234567890\",\"message_type\":\"Gryf4\",\"device_type_id\":9,\"isHeartbeatMessage\":true}}"},{"id":"8fede484-482e-4753-81c1-c75189626501","name":"404 Message Type Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"device_id\": \"1234567890\",\n \"message_type\": \"9\",\n \"device_type_id\": 7,\n \"isHeartbeatMessage\": true\n}"},"url":"https://{{panicApiUrl}}/v2/deviceEvent"},"status":"Not Found","code":404,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"awselb/2.0"},{"key":"Date","value":"Mon, 12 Jun 2023 08:59:50 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"160"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"There is no default event in deviceTemplate.\",\"input\":{\"device_id\":\"1234567890\",\"message_type\":\"Gry4\",\"device_type_id\":7,\"isHeartbeatMessage\":true}}"}],"_postman_id":"ff89ec3d-4fad-4928-8e1c-eb79b3f01275"}],"id":"a5b6d27f-94c1-469d-b865-a05a050f9617","description":"

Getting started

\n

This guide will outline the process of integrating your IOT device into AURA's white label offerings.

\n

To start processing requests via AURA's API you will need:

\n
    \n
  1. Your offering to be created on AURA's staging environment to test (Brand & device name.)
    2. \n
  2. Your clientId and clientSecret to generate an auth token.
    3. \n
  3. A summary of what message from your IOT device links to AURA's compulsory status's / actions (listed below) (E.g. 2f = NEW_CALLOUT, 4h = CALLOUT_LOCATION_UPDATED)
    4. \n
\n

If you have not spoken to the integration team please reach out to the below mail addresses:

\n

integrations@aura.services

\n

We will need to create your offering on our Database before you start. We will provide you with both:

\n

deviceId - This will be the serial number of your device

\n

device_type_id - Specific to the model of your device (AURA will replicate the serial number of the device for this - please note: We cannot accept a serial number that starts with: 0 OR + OR any letter)

\n

deviceSupplier - Specific to the brand of your device

\n

Note: There is currently no endpoint that returns all device_type_ids, which are required to post callout requests from an IoT device. AURA will give you all device_type_ids associated to any/all IoT devices that have been registered to you.

\n

We can then test the solution in our sandbox environment (staging) before going live.

\n

AURA has a standardised set of status's that will need to be mapped to messages received from your device. Here is a summary of the compulsory status's:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
message_typeDescription
NEW_CALLOUTCreating a panic on AURA's platform
CALLOUT_LOCATION_UPDATEDpolling AURA with location updates (15-20 seconds) after the callout is created
CALLOUT_CANCELLEDThis is cancelling a callout after creating one. Please note this is a soft dismissal and will still need to be confirmed by our control centre with the end user via a call. We would reference the users defined duressCode to confirm the cancellation
DEVICE_BATTERY_INFO_RECEIVEDThis would reference the battery level of the device or a health check pulse. An integrator can choose to have this status recieve a battery % or a heartbeat, but you cannot cater for both.

The expectation here is for the integrator to inform us which route they would like to go in regards to this event.
IGNORED_MESSAGEThis would be mapped to any message sent from the device to AURA that does not line up with any of our requirements
\n
","_postman_id":"a5b6d27f-94c1-469d-b865-a05a050f9617"}]}