The payment API is a server2server API. Authentication is provided via HTTP Basic Auth. \nCredentials MUST never be leaked, which means, these credentials can't be used in apps, Javascript, client-side etc.
\nThe consuming service is responsible, for properly authenticating users.
\nObjects might have complex child-objects. Per default, these child objects are referenced by their ID. However, in certain cases it makes sense, to fully resolve (expand) the child object in order to prevent additional API calls.
\nExpansion of objects is expensive and can be slow if heavily being used. Only expand objects, if you really need the data.
\nExpansion uses the \"dot syntax\" e.g. order.items.product.plan will expand all objects on the path. Collection properties are called \"items\". If you want to expand a specific sub-property of all items, specify the path like items.product.
\nYou can specify multiple properties to be expanded. It's not required to specify the top-level element in the path.
\nExample
\nGET /api/order/1?expand[]=items.product.plan&expand[]=payment_method\nitems expandable
Subscription items in this order. Items follow the following schema:
product expandable
Product accociated with that item.
items expandable
Order items in this order. Items follow the following schema:
\n\nid string
\n
Unique ID of the item
product_id int
ID of the product accociated with that item
Valid value \"pdf\", \"email\", \"html\"
\n","type":"text/plain"},"key":"format","value":"pdf"}],"variable":[{"description":{"content":"ID of the invoice
\n","type":"text/plain"},"type":"string","value":"1337","key":"id"}]}},"response":[],"_postman_id":"38dc92fe-64fc-4fbf-90c8-f8469231b38a"},{"name":"List all invoices for an order","id":"3fd15fbf-2f96-4697-bd5e-509694e69e27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/orders/:order_id/invoices","urlObject":{"path":["orders",":order_id","invoices"],"query":[],"variable":[{"description":{"content":"ID of the order
\n","type":"text/plain"},"type":"string","value":"WsRfhdQs13","key":"order_id"}]}},"response":[],"_postman_id":"3fd15fbf-2f96-4697-bd5e-509694e69e27"}],"id":"47b28359-c77e-4f22-97d3-932673aad21a","_postman_id":"47b28359-c77e-4f22-97d3-932673aad21a","description":""},{"name":"Create Order with additional \"Addon\" Products","id":"c7cc6edb-d5b6-4e0f-bb09-5b4ad06e7fb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"click_id\" : \"xyz12345\",\n \"currency\": \"usd\",\n \"country_code\": \"us\",\n \"email\": \"jon@doe.com\",\n \"items\": [\n {\n \"product_id\": 101\n },\n {\n \"product_id\" : 100\n }\n ],\n \"language\" : \"en\",\n \"meta_data\" :{ \n \"affiliate\":\"demo\"\n },\n \"name\": \"Jon Doe\",\n \"partners_id\": 1,\n \"payment_method_id\": 1,\n \"region\" : \"us\",\n \"zip_code\": \"12345\"\n \n}"},"url":"{{baseURL}}/orders/","description":"Creates an order with one or multiple items. Depending on the payment provider, additional actions need to be performed, in order to fullfill the order, like redirecting the user to a specific url or executing additional Javascript functions provided by the payment provider's SDK.
\nIf the order requires additional actions to collect the payment, an additional payload of type requiresOrderActionPayload is present and has the following format:
\n\"jwt\": \"jwtToken\",\n\"actionType\": \"STRIPE_CONFIRM_SETUP_INTENT\",\n\"actionPayload\": \"setup_intent_secret\",\n\"order_id\": 1\nactionType required
Depending on the payment provider, it can contain the following values
actionPayload required
Depending on actionType
Orders are being created, once the user decides to start a purchase. The API will always try to immediately collect the payment for the order. Depending on the payment provider, additional steps are required to collect the payment, like redirecting the user to a checkout page or performing SCA (3D Secure) authentication.
\nIf an order was successfully paid, a subscription is created. Renewals of orders will result in invoices to be generated and sent to the customer.
\n","event":[{"listen":"prerequest","script":{"id":"a7418d1f-6944-4fb7-b4c0-92ccf61c9e7c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a74751a9-703d-4662-a784-f4a2e30ab3b1","type":"text/javascript","exec":[""]}}],"_postman_id":"27460ba9-e27f-465d-a8f5-27abc4944944"},{"name":"Subscriptions","item":[{"name":"Fetch all subscriptions of a user","id":"161ff5a3-e615-40fe-82d8-2f167b9da9cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseURL}}/subscriptions/?user_id=krn::iam::xvpn:user:e376e2ee-b407-408b-8179-2f6e9ee7b637","description":"Fetches all subscription of a user
\nResponse: Array of Subscription Schema
\n","urlObject":{"path":["subscriptions",""],"host":["{{baseURL}}"],"query":[{"description":{"content":"User-ID of the user, which subscriptions should be fetched
\n","type":"text/plain"},"key":"user_id","value":"krn::iam::xvpn:user:e376e2ee-b407-408b-8179-2f6e9ee7b637"}],"variable":[]}},"response":[{"id":"fec6a818-5616-452e-9d00-61b9c56fb8bd","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseURL}}/subscriptions/?user_id=1","host":["{{baseURL}}"],"path":["subscriptions",""],"query":[{"key":"user_id","value":"1","description":"User-ID of the user, which subscriptions should be fetched"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"max-age=0"},{"key":"Date","value":"Thu, 17 Sep 2020 19:39:00 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Expires","value":"Thu, 17 Sep 2020 19:39:00 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"subscription\",\n \"id\": 1,\n \"created_at\": \"2020-09-04T13:18:34.000000Z\",\n \"updated_at\": \"2020-09-04T13:18:34.000000Z\",\n \"current_interval_start\": \"2020-01-01T15:18:22.000000Z\",\n \"current_interval_end\": \"2020-01-04T15:18:29.000000Z\",\n \"items\": {\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"subscription_item\",\n \"id\": 1,\n \"status\": \"PAID\",\n \"autorenewal_enabled\": true,\n \"created_at\": \"2020-09-04T13:31:41.000000Z\",\n \"updated_at\": \"2020-09-17T10:49:08.000000Z\",\n \"product\": 100\n },\n {\n \"object\": \"subscription_item\",\n \"id\": 2,\n \"status\": \"PAID\",\n \"autorenewal_enabled\": true,\n \"created_at\": \"2020-09-04T13:31:45.000000Z\",\n \"updated_at\": \"2020-09-17T10:49:08.000000Z\",\n \"product\": 101\n }\n ]\n }\n }\n ]\n}"}],"_postman_id":"161ff5a3-e615-40fe-82d8-2f167b9da9cd"},{"name":"Fetch specific subscription","id":"7d4a6008-5b97-4511-810f-5767ca2f1eb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseURL}}/subscriptions/:id?expand[]=items.product.name","description":"Fetches a subscription by ID.
\nResponse: See Subscription Schema
\n","urlObject":{"path":["subscriptions",":id"],"host":["{{baseURL}}"],"query":[{"key":"expand[]","value":"items.product.name"}],"variable":[{"description":{"content":"ID of the subscription
\n","type":"text/plain"},"type":"string","value":"1","key":"id"}]}},"response":[{"id":"58e683a1-2382-48f2-a5fb-5f8dc63dd548","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseURL}}/subscriptions/:id","host":["{{baseURL}}"],"path":["subscriptions",":id"],"variable":[{"key":"id","value":"1","description":"ID of the subscription"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"max-age=0"},{"key":"Date","value":"Thu, 17 Sep 2020 18:55:36 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Expires","value":"Thu, 17 Sep 2020 18:55:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"object\": \"subscription\",\n \"id\": 1,\n \"created_at\": \"2020-09-04T13:18:34.000000Z\",\n \"updated_at\": \"2020-09-04T13:18:34.000000Z\",\n \"current_interval_start\": \"2020-01-01T15:18:22.000000Z\",\n \"current_interval_end\": \"2020-01-04T15:18:29.000000Z\",\n \"items\": {\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"subscription_item\",\n \"id\": 1,\n \"status\": \"PAID\",\n \"autorenewal_enabled\": true,\n \"created_at\": \"2020-09-04T13:31:41.000000Z\",\n \"updated_at\": \"2020-09-17T10:49:08.000000Z\",\n \"product\": 100\n },\n {\n \"object\": \"subscription_item\",\n \"id\": 2,\n \"status\": \"PAID\",\n \"autorenewal_enabled\": true,\n \"created_at\": \"2020-09-04T13:31:45.000000Z\",\n \"updated_at\": \"2020-09-17T10:49:08.000000Z\",\n \"product\": 101\n }\n ]\n }\n }\n}"}],"_postman_id":"7d4a6008-5b97-4511-810f-5767ca2f1eb8"},{"name":"Change the auto-renewal for a specific subscription item","id":"858b84f7-fbd3-4be4-92fd-0b0c1cfff746","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"autorenewal_enabled\": false\n}"},"url":"{{baseURL}}/subscriptions/:subscription_id/items/:item_id?expand[]=product","urlObject":{"path":["subscriptions",":subscription_id","items",":item_id"],"host":["{{baseURL}}"],"query":[{"key":"expand[]","value":"product"}],"variable":[{"description":{"content":"ID of the subscription
\n","type":"text/plain"},"type":"string","value":"1","key":"subscription_id"},{"description":{"content":"ID of the item in the subscription
\n","type":"text/plain"},"type":"string","value":"1","key":"item_id"}]}},"response":[],"_postman_id":"858b84f7-fbd3-4be4-92fd-0b0c1cfff746"}],"id":"98bc9735-22d9-488c-9eb5-91e7c2282e47","description":"Upon succesful payment of an order, a subscription is being created. Subscriptions can contain multiple items, which all share the same interval. These items can be auto-renewing, which means, they will automatically trigger an additional payment, if the current subscription period has expired.
\n","event":[{"listen":"prerequest","script":{"id":"0d4a23ab-81f0-4536-8c41-3f4b448784bc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fd3ee6ba-3c9e-4f55-b79f-12a145309fd4","type":"text/javascript","exec":[""]}}],"_postman_id":"98bc9735-22d9-488c-9eb5-91e7c2282e47"}],"event":[{"listen":"prerequest","script":{"id":"9f9df754-1323-46b9-a0b6-cbc6cd8aa243","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dc644dfc-d675-40ec-8f42-d10da4e07ec7","type":"text/javascript","exec":[""]}}]}