Finalize webhook definition

src/schemas/CustomerIntegratrionErrorObject.yaml

@@ -0,0 +1,37 @@
+type: object
+required:
+  - lago_customer_id
+  - external_customer_id
+  - accounting_provider
+  - accounting_provider_code
+  - provider_error
+properties:
+  lago_customer_id:
+    type: string
+    format: "uuid"
+    description: Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system.
+    example: "1a901a90-1a90-1a90-1a90-1a901a901a90"
+  external_customer_id:
+    type: string
+    description: The customer external unique identifier (provided by your own application)
+    example: "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+  accounting_provider:
+    type: string
+    enum:
+      - anrock
+      - hubspot
+      - netsuite
+      - okta
+      - salesforce
+      - xero
+    description: The type of accounting provider code
+    example: "anrock"
+  accounting_provider_code:
+    type: string
+    description: Code of the accounting provider
+    example: "Netsuite Prod"
+  provider_error:
+    oneOf:
+      - type: string
+      - type: object
+        additionalProperties: true

src/schemas/CustomerPaymentProviderErrorObject.yaml

@@ -0,0 +1,35 @@
+type: object
+required:
+  - lago_customer_id
+  - external_customer_id
+  - payment_provider
+  - payment_provider_code
+  - provider_error
+properties:
+  lago_customer_id:
+    type: string
+    format: "uuid"
+    description: Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system.
+    example: "1a901a90-1a90-1a90-1a90-1a901a901a90"
+  external_customer_id:
+    type: string
+    description: The customer external unique identifier (provided by your own application)
+    example: "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+  payment_provider:
+    type: string
+    enum:
+      - adyen
+      - cashfree
+      - gocardless
+      - stripe
+    description: The type of payment provider
+    example: "stripe"
+  payment_provider_code:
+    type: string
+    description: Code of the payment provider
+    example: "Stripe Prod"
+  provider_error:
+    oneOf:
+      - type: string
+      - type: object
+        additionalProperties: true

src/schemas/CustomerTaxProviderErrorObject.yaml

@@ -0,0 +1,37 @@
+type: object
+required:
+  - lago_customer_id
+  - external_customer_id
+  - tax_provider
+  - tax_provider_code
+  - provider_error
+properties:
+  lago_customer_id:
+    type: string
+    format: "uuid"
+    description: Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system.
+    example: "1a901a90-1a90-1a90-1a90-1a901a901a90"
+  external_customer_id:
+    type: string
+    description: The customer external unique identifier (provided by your own application)
+    example: "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+  tax_provider:
+    type: string
+    enum:
+      - anrock
+      - hubspot
+      - netsuite
+      - okta
+      - salesforce
+      - xero
+    description: The type of tax provider
+    example: "anrock"
+  tax_provider_code:
+    type: string
+    description: Code of the tax provider
+    example: "Stripe Prod"
+  provider_error:
+    oneOf:
+      - type: string
+      - type: object
+        additionalProperties: true

src/schemas/EventErrorsObject.yaml

@@ -0,0 +1,22 @@
+type: object
+required:
+  - status
+  - error
+  - message
+  - event
+properties:
+  status:
+    type: integer
+    description: HTTP status code. It will always be 422
+    example: 422
+  error:
+    type: string
+    description: HTTP error description. It will always be "Unprocessable Entity"
+    example: Unprocessable Entity
+  message:
+    oneOf:
+      - type: string
+      - type: object
+        additionalProperties: true
+  event:
+    $ref: "./EventObject.yaml"

src/schemas/EventsErrorsObject.yaml

@@ -0,0 +1,27 @@
+type: object
+required:
+  - invalid_code
+  - missing_aggregation_property
+  - invalid_filter_values
+properties:
+  invalid_code:
+    type: array
+    items:
+      type: string
+    description: List of event transaction_id with an invalid code
+    example:
+      - transaction_1234567890
+  missing_aggregation_property:
+    type: array
+    items:
+      type: string
+    description: List of event transaction_id with a missing aggregation property
+    example:
+      - transaction_1234567890
+  invalid_filter_values:
+    type: array
+    items:
+      type: string
+    description: List of event transaction_id with invalid filter values
+    example:
+      - transaction_1234567890

src/schemas/FeeTaxProviderErrorObject.yaml

@@ -0,0 +1,27 @@
+type: object
+required:
+  - tax_provider_code
+  - lago_charge_id
+  - event_transaction_id
+  - provider_error
+properties:
+  tax_provider_code:
+    type: string
+    description: Code of the tax provider
+    example: "Stripe Prod"
+  lago_charge_id:
+    type: string
+    format: "uuid"
+    nullable: true
+    description: Unique identifier assigned to the charge that the fee belongs to
+    example: "1a901a90-1a90-1a90-1a90-1a901a901a90"
+  event_transaction_id:
+    type: string
+    nullable: true
+    description: Unique identifier assigned to the transaction. This field is specifically displayed when the fee type is `charge`.
+    example: "transaction_1234567890"
+  provider_error:
+    oneOf:
+      - type: string
+      - type: object
+        additionalProperties: true

src/schemas/IntegrationProviderErrorObject.yaml

@@ -0,0 +1,25 @@
+type: object
+required:
+  - lago_integration_id
+  - provider
+  - provider_code
+  - provider_error
+properties:
+  lago_integration_id:
+    type: string
+    format: "uuid"
+    description: Unique identifier assigned to the integration within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the integration's record within the Lago system.
+    example: "1a901a90-1a90-1a90-1a90-1a901a901a90"
+  provider:
+    type: string
+    description: The type of integration provider
+    example: "netsuite"
+  provider_code:
+    type: string
+    example: "netsuite-eu-1"
+    description: Unique code used to identify an integration connection.
+  provider_error:
+    oneOf:
+      - type: string
+      - type: object
+        additionalProperties: true

src/schemas/InvoicePaymentFailureObject.yaml

@@ -0,0 +1,43 @@
+type: object
+required:
+  - lago_invoice_id
+  - lago_customer_id
+  - external_customer_id
+  - payment_provider
+properties:
+  lago_invoice_id:
+    type: string
+    format: "uuid"
+    description: Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice's record within the Lago system.
+    example: "1a901a90-1a90-1a90-1a90-1a901a901a90"
+  lago_customer_id:
+    type: string
+    format: "uuid"
+    description: Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system.
+    example: "1a901a90-1a90-1a90-1a90-1a901a901a90"
+  external_customer_id:
+    type: string
+    description: The customer external unique identifier (provided by your own application)
+    example: "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+  provider_customer_id:
+    type: string
+    description: Unique identifier of the customer within the payment provider
+    example: "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+  payment_provider:
+    type: string
+    enum:
+      - adyen
+      - cashfree
+      - gocardless
+      - stripe
+    description: The type of payment provider code
+    example: "stripe"
+  payment_provider_code:
+    type: string
+    description: Code of the payment provider
+    example: "Stripe Prod"
+  provider_error:
+    oneOf:
+      - type: string
+      - type: object
+        additionalProperties: true

src/schemas/PaymentProviderErrorObject.yaml

@@ -0,0 +1,38 @@
+type: object
+required:
+  - lago_payment_provider_id
+  - payment_provider_name
+  - payment_provider_code
+  - provider_error
+  - source
+properties:
+  lago_payment_provider_id:
+    type: string
+    format: "uuid"
+    description: Unique identifier assigned to the payment provider within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the payment provider's record within the Lago system.
+    example: "1a901a90-1a90-1a90-1a90-1a901a901a90"
+  payment_provider_name:
+    type: string
+    description: The name of payment provider
+    example: "Stripe Prod"
+  payment_provider_code:
+    type: string
+    description: Code of the payment provider
+    example: "stripe"
+  source:
+    type: string
+    enum:
+      - stripe
+    description: The source of the error
+    example: "stripe"
+  action:
+    type: string
+    enum:
+      - payment_provider.register_webhook
+    description: The action that was being performed when the error occurred
+    example: "payment_provider.register_webhook"
+  provider_error:
+    oneOf:
+      - type: string
+      - type: object
+        additionalProperties: true

src/schemas/SubscriptionWithCustomerObject.yaml

@@ -0,0 +1,8 @@
+allOf:
+  - $ref: "./SubscriptionObject.yaml"
+  - type: object
+    properties:
+      plan:
+        $ref: "./PlanObject.yaml"
+      customer:
+        $ref: "./CustomerObject.yaml"

src/schemas/SubscriptionWithThresholdObject.yaml

@@ -0,0 +1,10 @@
+allOf:
+  - $ref: "./SubscriptionObject.yaml"
+  - type: object
+    properties:
+      plan:
+        $ref: "./PlanObject.yaml"
+      customer:
+        $ref: "./CustomerObject.yaml"
+      usage_threshold:
+        $ref: "./UsageThresholdObject.yaml"