Customers open api

src/resources/customer.yaml

@@ -1,5 +1,5 @@
 parameters:
-  - name: external_customer_id
+  - name: external_id
     in: path
     description: The customer external unique identifier (provided by your own application)
     required: true

src/resources/customer_applied_coupon.yaml

@@ -12,7 +12,7 @@ delete:
       schema:
         type: string
         example: '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba'
-    - name: applied_coupon_id
+    - name: id
       in: path
       description: Unique identifier of the applied coupon, created by Lago.
       required: true

src/resources/customer_checkout_url.yaml

@@ -4,7 +4,7 @@ post:
   summary: Generate a Customer Payment Provider Checkout URL
   description: This endpoint regenerates the Payment Provider Checkout URL of a Customer.
   parameters:
-    - name: external_customer_id
+    - name: customer_external_id
       in: path
       description: The customer external unique identifier (provided by your own application).
       required: true

src/resources/customer_current_usage.yaml

@@ -4,7 +4,7 @@ get:
   summary: Retrieve customer current usage
   description: This endpoint enables the retrieval of the usage-based billing data for a customer within the current period.
   parameters:
-    - name: external_customer_id
+    - name: customer_external_id
       in: path
       description: The customer external unique identifier (provided by your own application).
       required: true

src/resources/customer_past_usage.yaml

@@ -6,7 +6,7 @@ get:
   parameters:
     - $ref: '../parameters/page.yaml'
     - $ref: '../parameters/per_page.yaml'
-    - name: external_customer_id
+    - name: customer_external_id
       in: path
       description: The customer external unique identifier (provided by your own application).
       required: true

src/resources/customer_portal_url.yaml

@@ -7,7 +7,7 @@ get:
 
     This endpoint allows you to fetch the URL that can be embedded to provide customers access to a dedicated portal
   parameters:
-    - name: external_customer_id
+    - name: customer_external_id
       in: path
       description: External ID of the existing customer
       required: true

src/schemas/CustomerBaseObject.yaml

@@ -191,6 +191,10 @@ properties:
     $ref: "./CustomerBillingConfiguration.yaml"
   shipping_address:
     $ref: "./Address.yaml"
+  external_salesforce_id:
+    type: string
+    description: Salesforce ID of this customer.
+    example: "0035g00000ABCdEAA1"
   metadata:
     type: array
     items:

src/schemas/CustomerCheckoutUrl.yaml

@@ -1,5 +1,5 @@
 type: object
-description: .
+description: A URL that directs the customer to the checkout page for the choosen payment provider.
 properties:
   customer:
     type: object

src/schemas/CustomerCreateInput.yaml

@@ -174,40 +174,7 @@ properties:
       integration_customers:
         type: array
         items:
-          type: object
-          properties:
-            id:
-              type: string
-              format: "uuid"
-              example: "1a901a90-1a90-1a90-1a90-1a901a901a90"
-              description: "A unique identifier for the integration customer object in the Lago application."
-            integration_type:
-              type: string
-              example: "netsuite"
-              description: |-
-                The integration type used for accounting and tax syncs.
-                Accepted values: `netsuite, anrok, xero`.
-              enum:
-                - netsuite
-                - anrok
-                - xero
-            integration_code:
-              type: string
-              example: "netsuite-eu-1"
-              description: Unique code used to identify an integration connection.
-            external_customer_id:
-              type: string
-              example: "cus_12345"
-              description: The customer ID within the integration's system. If this field is not provided, Lago has the option to create a new customer record within the integration's system on behalf of the customer.
-            sync_with_provider:
-              type: boolean
-              example: true
-              description: Set this field to `true` if you want to create a customer record in the integration's system. This option is applicable only when the `external_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`
-            subsidiary_id:
-              type: string
-              example: "2"
-              description: This optional field is needed only when working with `netsuite` connection.
-
+          $ref: "./IntegrationCustomer.yaml"
       metadata:
         type: array
         description: Set of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format
@@ -246,3 +213,7 @@ properties:
           type: string
         description: List of unique codes identifying the invoice custom sections.
         example: ["eu_bank_details"]
+      external_salesforce_id:
+        type: string
+        description: Salesforce ID of this customer.
+        example: "0035g00000ABCdEAA1"

src/schemas/CustomerObjectExtended.yaml

@@ -2,15 +2,18 @@ allOf:
   - $ref: './CustomerObject.yaml'
   - type: object
     properties:
-      metadata:
-        type: array
-        items:
-          $ref: './CustomerMetadata.yaml'
       taxes:
         description: List of customer taxes
         type: array
         items:
           $ref: './TaxObject.yaml'
+      vies_check:
+        type: object
+        properties:
+          valid:
+            type: boolean
+            description: "Whether the VIES check was successful"
+            example: true
       applicable_invoice_custom_sections:
         description: The customer’s invoice custom section used for generating invoices.
         type: array