Wiki source code of Customer - DRAFT API
Last modified by Anders Göthberg on 2026/05/25 10:45
| 1 | (% class="jumbotron" %) |
| 2 | ((( |
| 3 | (% class="container" %) |
| 4 | ((( |
| 5 | Integrate to **PayEx Billing Customer API ** |
| 6 | ))) |
| 7 | ))) |
| 8 | |
| 9 | (% id="HChangelog" %) |
| 10 | = Changelog = |
| 11 | |
| 12 | (% border="1" %) |
| 13 | |=**Version**|=**Date**|=**Description**|=**Created by** |
| 14 | |1.0|2025-05-20|((( |
| 15 | Created document |
| 16 | )))|Anders Göthberg |
| 17 | |1.1| |API in production|Anders Göthberg |
| 18 | |
| 19 | (% id="HRoutesegments" %) |
| 20 | = Introduction = |
| 21 | |
| 22 | A link to the general step-by-step implementation guide for setting up a REST API integration with PayEx Ledger Invoice Service can be found [[here >>doc:Main.Invoicing.invoice-service.invoice-service-apis.WebHome]] |
| 23 | |
| 24 | The Billing Customer API is used to create and update billable charges for a company’s end customers, both at the customer level and for each individual subscription |
| 25 | |
| 26 | == Customer API == |
| 27 | |
| 28 | |
| 29 | [[image:1779265422284-899.png||height="424" width="706"]] |
| 30 | |
| 31 | (% id="HRoutedescription" %) |
| 32 | === Route description === |
| 33 | |
| 34 | Each resource in the API corresponds to its own route. All routes are structured according to a specific standard, explained below |
| 35 | |
| 36 | The below route is an example of a route towards resource3Id. To perform operations on this resource, the route must also include the identifiers of its parent resources. |
| 37 | //lf-api.payex.com/billing/**{subdomain}**/v1/**{ownerNo}**/resource1/**{resource1Id}**/resource2/**{resource2Id}**/resource3/**{resource3Id}**// |
| 38 | |
| 39 | (% border="1" %) |
| 40 | |=Route segment|=Description |
| 41 | |subdomain|In this part of the API it will be "billing" |
| 42 | |ownerNo|The ledger identifier/number at PayEx |
| 43 | |resource1Id|Identifier of resource1 (customers) |
| 44 | |resource2Id|identifier of resource2, subresource to resource1 (recurring products or subscriptions) |
| 45 | |resource3Id|identifier of resource3, subresource to resource2 (recurring products) |
| 46 | |
| 47 | (% border="1" %) |
| 48 | Routes that occurs in examples of this documentation will use the following identifiers |
| 49 | |
| 50 | (% border="1" %) |
| 51 | |=(% style="width: 330px;" %)Resource|=(% style="width: 1517px;" %)Identifier |
| 52 | |(% style="width:330px" %)ownerNo|(% style="width:1517px" %)The ledger identifier/number at PayEx |
| 53 | |(% style="width:330px" %)customerNo|(% style="width:1517px" %)Customer number |
| 54 | |(% style="width:330px" %)subscriptionNo|(% style="width:1517px" %)Subscription number (identifier for subscription) |
| 55 | |(% style="width:330px" %)recurring-products|(% style="width:1517px" %)Recurring products on customer or subscription level |
| 56 | |
| 57 | {{display reference="developer:Main.Invoicing.billing.technical-reference.Billing API.Customer.Customer-from-swagger.WebHome"/}} |
| 58 | |
| 59 | === Problem types === |
| 60 | |
| 61 | (% class="box infomessage" %) |
| 62 | ((( |
| 63 | Note, each problem typecode is preceded by** "billing/customer/service"** in this API, e.g. the error "validation" in the table below will appear as typecode **"billing/customer/problems/validation".** |
| 64 | ))) |
| 65 | |
| 66 | (% class="table-bordered table-striped" %) |
| 67 | |=(% style="width: 537px;" %)Problem type (code)|=(% style="width: 172px;" %)Http status|=(% style="width: 796px;" %)Description |
| 68 | |(% style="width:537px" %)validation|(% style="width:172px" %)400|(% style="width:796px" %)occurs if any of the inputvalidation fails, it is described in the problem which parameter that failed the validation |
| 69 | |(% style="width:537px" %)customer-not-found|(% style="width:172px" %)404|(% style="width:796px" %)Customer not found in PayEx Billing |
| 70 | |(% style="width:537px" %)subscription-not-found|(% style="width:172px" %)404|(% style="width:796px" %)Subscription not found on selected customer |