Solvimon paymentSchedules API

openapi: 3.1.0
info:
  title: Configuration alertRules paymentSchedules API
  version: 1.0.0
servers:
- url: https://test.api.solvimon.com
  description: The TEST environment for our API
- url: https://api.solvimon.com
  description: The live environment for our API
tags:
- name: paymentSchedules
paths:
  /v{version}/payment-schedules:
    get:
      operationId: getPaymentSchedules
      summary: Get a list of payment schedules
      description: Requires the PAYMENT_SCHEDULE.VIEW permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: customer_id
        in: query
        description: Filter based of customer ID
        required: false
        schema:
          type: string
      - name: expand[]
        in: query
        description: The id fields of the resources that are going to be expanded.
        required: false
        schema:
          type: array
          items:
            type: string
      - name: limit
        in: query
        description: The amount of records shown in the list
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: The page which is going to be shown
        required: false
        schema:
          type: integer
      - name: order_by
        in: query
        description: The parameter by which the response is ordered.
        required: false
        schema:
          type: string
      - name: order_direction
        in: query
        description: The order direction by which the response is ordered.
        required: false
        schema:
          type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentScheduleResponseWrapper'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    post:
      operationId: postPaymentSchedules
      summary: Create a payment schedule
      description: Requires the PAYMENT_SCHEDULE.CREATE permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSchedule'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentScheduleCreateRequest'
  /v{version}/payment-schedules/init:
    post:
      operationId: postPaymentSchedulesInit
      summary: Initialize resources for a payment schedule
      description: Requires the PAYMENT_SCHEDULE.CREATE, PAYMENT_METHOD.CREATE, PAYMENT_METHOD.UPDATE, CUSTOMER.CREATE or CUSTOMER.UPDATE permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentScheduleInit'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentScheduleInitCreateRequest'
  /v{version}/payment-schedules/{resourceIdOrReference}:
    get:
      operationId: getPaymentSchedulesByResourceIdOrReference
      summary: Get a payment schedule by ID or reference
      description: Requires the PAYMENT_SCHEDULE.VIEW permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: expand[]
        in: query
        description: The id fields of the resources that are going to be expanded.
        required: false
        schema:
          type: array
          items:
            type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSchedule'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    patch:
      operationId: patchPaymentSchedulesByResourceIdOrReference
      summary: Patch a payment schedule.
      description: Requires the PAYMENT_SCHEDULE.VIEW permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSchedule'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentScheduleUpdateRequest'
  /v{version}/payment-schedules/{resourceIdOrReference}/cancel:
    post:
      operationId: postPaymentSchedulesByResourceIdOrReferenceCancel
      summary: Cancel a payment schedule
      description: Requires the PAYMENT_SCHEDULE.UPDATE permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSchedule'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/payment-schedules/{resourceIdOrReference}/pause:
    post:
      operationId: postPaymentSchedulesByResourceIdOrReferencePause
      summary: Pause a payment schedule
      description: Requires the PAYMENT_SCHEDULE.UPDATE permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSchedule'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/payment-schedules/{resourceIdOrReference}/activate:
    post:
      operationId: postPaymentSchedulesByResourceIdOrReferenceActivate
      summary: Activate a payment schedule
      description: Requires the PAYMENT_SCHEDULE.UPDATE permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSchedule'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    SellerDetailsUpdateRequest:
      type: object
      properties:
        seller_customer_id:
          type:
          - string
          - 'null'
          description: Resource ID of type CUSTOMER
      title: SellerDetailsUpdateRequest
    TaxIdValidationValid:
      type: string
      enum:
      - VALID
      - NOT_VALID
      - UNKNOWN
      title: TaxIdValidationValid
    TaxIdValidation:
      type: object
      properties:
        id:
          type: string
        validation_date:
          type: string
        source:
          type: string
        valid:
          $ref: '#/components/schemas/TaxIdValidationValid'
        message:
          type:
          - string
          - 'null'
      title: TaxIdValidation
    PaymentScheduleUpdateRequestStatus:
      type: string
      enum:
      - ACTIVE
      - PAUSED
      - CANCELLED
      - DONE
      title: PaymentScheduleUpdateRequestStatus
    PaymentScheduleRecurringCreateRequest:
      type: object
      properties:
        charge:
          $ref: '#/components/schemas/Charge'
        start_at:
          type: string
          format: date-time
        end_at:
          type:
          - string
          - 'null'
          format: date-time
        period:
          $ref: '#/components/schemas/Period'
      title: PaymentScheduleRecurringCreateRequest
    PaymentScheduleRecurring:
      type: object
      properties:
        charge:
          $ref: '#/components/schemas/Charge'
        start_at:
          type: string
          format: date-time
        end_at:
          type:
          - string
          - 'null'
          format: date-time
        period:
          $ref: '#/components/schemas/Period'
      title: PaymentScheduleRecurring
    PaymentMethodStatus:
      type: string
      enum:
      - SETUP
      - ACTIVE
      - INACTIVE
      - ARCHIVED
      title: PaymentMethodStatus
    LinkedIntegration:
      type: object
      properties:
        id:
          type: string
        link_details:
          type: array
          items:
            $ref: '#/components/schemas/LinkDetail'
      title: LinkedIntegration
    IntegrationDetails:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        reference:
          type:
          - string
          - 'null'
        payment_gateway_variant:
          $ref: '#/components/schemas/IntegrationDetailsPaymentGatewayVariant'
        adyen:
          $ref: '#/components/schemas/AdyenIntegrationDetails'
        stripe:
          $ref: '#/components/schemas/StripeIntegrationDetails'
      title: IntegrationDetails
    PaymentScheduleDunningCreateRequest:
      type: object
      properties:
        enabled:
          type: boolean
      title: PaymentScheduleDunningCreateRequest
    PricingPlanSubscriptionSelectorRuleType:
      type: string
      enum:
      - EQUALS
      - NOT_EQUALS
      - IN
      - NOT_IN
      - GREATER_THAN
      - GREATER_THAN_OR_EQUALS
      - LESS_THAN
      - LESS_THAN_OR_EQUALS
      - EMPTY
      - NOT_EMPTY
      - CONTAINS
      - NOT_CONTAINS
      title: PricingPlanSubscriptionSelectorRuleType
    PaymentMethodUpdateRequestType:
      type: string
      enum:
      - CARD
      - ONLINE_BANKING
      - BUY_NOW_PAY_LATER
      - DIRECT_DEBIT
      - DIGITAL_WALLET
      - UNKNOWN
      title: PaymentMethodUpdateRequestType
    PricingPlanSubscriptionSelectorDataField:
      type: string
      enum:
      - BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY
      - PRICING_PLAN_REFERENCE
      title: PricingPlanSubscriptionSelectorDataField
    PaymentMethodDirectDebit:
      type: object
      properties:
        variant:
          type:
          - string
          - 'null'
        owner_name:
          type:
          - string
          - 'null'
        iban:
          type:
          - string
          - 'null'
        bic:
          type:
          - string
          - 'null'
        country:
          oneOf:
          - $ref: '#/components/schemas/PaymentMethodDirectDebitCountry'
          - type: 'null'
      title: PaymentMethodDirectDebit
    PaymentMethodFallbackUpdateRequest:
      type: object
      properties:
        enabled:
          type: boolean
        payment_method_ids:
          type: array
          items:
            type: string
      title: PaymentMethodFallbackUpdateRequest
    TaxRegistration:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: The id of this tax registration
        description:
          type:
          - string
          - 'null'
          description: The description of this tax registration
        tax_id:
          type:
          - string
          - 'null'
          description: The tax id of this tax registration, e.g. a TIN, VAT id or other tax number
        tax_ids:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/TaxId'
          description: Tax IDs used for tax purposes of the tax registration, e.g. TINs, VAT ids, or other tax number
        registration_number:
          type:
          - string
          - 'null'
          description: The registration number of this tax registration, e.g. a company registration number
        registered_address:
          $ref: '#/components/schemas/Address'
          description: The address of this tax registration, if different from the billing entity. Currently, only the address will be used for tax calculations
      title: TaxRegistration
    PricingPlanSubscriptionSelector:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PricingPlanSubscriptionSelectorData'
        rules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PricingPlanSubscriptionSelectorRule'
        filters:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PricingPlanSubscriptionSelectorFilter'
        fallback:
          oneOf:
          - $ref: '#/components/schemas/PricingPlanSubscriptionSelectorFallback'
          - type: 'null'
          description: The fallback logic what to do when no subscription is found. By default it is LATEST
      title: PricingPlanSubscriptionSelector
    PricingPlanSubscriptionSelectorFilterField:
      type: string
      enum:
      - BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY
      - PRICING_PLAN_REFERENCE
      title: PricingPlanSubscriptionSelectorFilterField
    ApiErrorType:
      type: string
      enum:
      - API_ERROR
      - INVALID_REQUEST
      title: ApiErrorType
    ApiError:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ApiErrorType'
        code:
          $ref: '#/components/schemas/ApiErrorCode'
        field:
          type:
          - string
          - 'null'
        message:
          type: string
        resource_id:
          type:
          - string
          - 'null'
        resource_type:
          oneOf:
          - $ref: '#/components/schemas/ApiErrorResourceType'
          - type: 'null'
      required:
      - type
      - code
      - message
      title: ApiError
    PaymentScheduleInstallmentsUpdateRequest:
      type: object
      properties:
        total_amount:
          $ref: '#/components/schemas/Amount'
        variant:
          $ref: '#/components/schemas/PaymentScheduleInstallmentsUpdateRequestVariant'
        number_of_installments:
          type: integer
        interval:
          $ref: '#/components/schemas/IntervalInstallment'
        fixed:
          $ref: '#/components/schemas/FixedInstallment'
      title: PaymentScheduleInstallmentsUpdateRequest
    PricingPlanSubscriptionSelectorRule:
      type: object
      properties:
        field:
          $ref: '#/components/schemas/PricingPlanSubscriptionSelectorRuleField'
        type:
          $ref: '#/components/schemas/PricingPlanSubscriptionSelectorRuleType'
      title: PricingPlanSubscriptionSelectorRule
    PaymentScheduleCreateRequest:
      type: object
      properties:
        object_type:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        created_at:
          type:
          - string
          - 'null'
        updated_at:
          type:
          - string
          - 'null'
        status:
          oneOf:
          - $ref: '#/components/schemas/PaymentScheduleCreateRequestStatus'
          - type: 'null'
        customer_id:
          type: string
          description: Resource ID of type CUSTOMER
        customer:
          oneOf:
          - $ref: '#/components/schemas/CustomerCreateRequest'
          - type: 'null'
        reference:
          type: string
        description:
          type:
          - string
          - 'null'
        statement_descriptor:
          type:
          - string
          - 'null'
        payment_method_id:
          type: string
          description: Resource ID of type PAYMENT_METHOD
        payment_method:
          oneOf:
          - $ref: '#/components/schemas/PaymentMethodCreateRequest'
          - type: 'null'
        billing_entity_id:
          type: string
          description: Resource ID of type BILLING_ENTITY
        dunning:
          $ref: '#/components/schemas/PaymentScheduleDunningCreateRequest'
        payment_method_fallback:
          $ref: '#/components/schemas/PaymentMethodFallbackCreateRequest'
        type:
          $ref: '#/components/schemas/PaymentScheduleCreateRequestType'
        installments:
          $ref: '#/components/schemas/PaymentScheduleInstallmentsCreateRequest'
        recurring:
          $ref: '#/components/schemas/PaymentScheduleRecurringCreateRequest'
        one_off:
          $ref: '#/components/schemas/PaymentScheduleOneOffCreateRequest'
        seller_details:
          $ref: '#/components/schemas/SellerDetailsCreateRequest'
      required:
      - customer_id
      - reference
      - payment_method_id
      - billing_entity_id
      - type
      title: PaymentScheduleCreateRequest
    PaymentMethodCreateRequestStatus:
      type: string
      enum:
      - SETUP
      - ACTIVE
      - INACTIVE
      - ARCHIVED
      title: PaymentMethodCreateRequestStatus
    PaymentMethodCard:
      type: object
      properties:
        brand:
          oneOf:
          - $ref: '#/components/schemas/PaymentMethodCardBrand'
          - type: 'null'
        name:
          type:
          - string
          - 'null'
        expiry_date:
          $ref: '#/components/schemas/ExpiryDate'
        last_four_digits:
          type:
          - string
          - 'null'
        country:
          type:
          - string
          - 'null'
      title: PaymentMethodCard
    CustomerUpdateRequestRolesItems:
      type: string
      enum:
      - DEFAULT
      - NON_PROCESSING
      - SELF_BILLING
      - SELLER
      - PROCESSING_ONLY
      title: CustomerUpdateRequestRolesItems
    PricingPlanSubscriptionSelectorFallback:
      type: string
      enum:
      - LATEST
      - NONE
      description: The fallback logic what to do when no subscription is found. By default it is LATEST
      title: PricingPlanSubscriptionSelectorFallback
    Charge:
      type: object
      properties:
        charge_at:
          type:
          - string
          - 'null'
          format: date-time
        amount:
          $ref: '#/components/schemas/Amount'
      title: Charge
    NotificationChannelType:
      type: string
      enum:
      - EMAIL
      description: The channel type to use.
      title: NotificationChannelType
    CustomerUpdateRequestType:
      type: string
      enum:
      - ORGANIZATION
      - INDIVIDUAL
      description: The type of customer entity.
      title: CustomerUpdateRequestType
    CustomFieldValue:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Resource ID of type CUSTOM_FIELD
        reference:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        values:
          type:
          - array
          - 'null'
          items:
            type: string
        integration_details:
          oneOf:
          - $ref: '#/components/schemas/IntegrationDetails'
          - type: 'null'
        integration_id:
          type: string
          description: The resource ID of the integration linked to the custom field
      title: CustomFieldValue
    PricingPlanSubscriptionSelectorRuleField:
      type: string
      enum:
      - BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY
      - PRICING_PLAN_REFERENCE
      title: PricingPlanSubscriptionSelectorRuleField
    CustomerCreateRequestStatus:
      type: string
      enum:
      - DRAFT
      - ACTIVE
      - ARCHIVED
      - DEPRECATED
      - CLOSED
      title: CustomerCreateRequestStatus
    Individual:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/Name'
        residential_address:
          $ref: '#/components/schemas/Address'
      title: Individual
    PaymentMethodOnlineBanking:
      type: object
      properties:
        variant:
          type:
          - string
          - 'null'
        owner_name:
          type:
          - string
          - 'null'
        iban:
          type:
          - string
          - 'null'
        bic:
          type:
          - string
          - 'null'
        country:
          oneOf:
          - $ref: '#/components/schemas/PaymentMethodOnlineBankingCountry'
          - type: 'null'
      title: PaymentMethodOnlineBanking
    CustomerType:
      type: string
      enum:
      - ORGANIZATION
      - INDIVIDUAL
      description: The type of customer entity.
      title: CustomerType
    PeriodType:
      type: string
      enum:
      - DAY
      - WEEK
      - MONTH
      - YEAR
      title: PeriodType
    CustomerRolesItems:
      type: string
      enum:
      - DEFAULT
      - NON_PROCESSING
      - SELF_BILLING
      - SELLER
      - PROCESSING_ONLY
      title: CustomerRolesItems
    IntegrationDetailsPaymentGatewayVariant:
      type: string
      enum:
      - ADYEN
      - STRIPE
      title: IntegrationDetailsPaymentGatewayVariant
    FixedInstallment:
      type: object
      properties:
        charges:
          type: array
          items:
            $ref: '#/components/schemas/Charge'
      title: FixedInstallment
    CustomerCreateRequest:
      type: object
      properties:
        object_type:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        created_at:
          type:
          - string
          - 'null'
        parent_customer_id:
          type:
          - string
          - 'null'
          description: The parent of the customer. Only returned when there is a single parent.
        parent_customer_ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: A list of parents of the customer. Will also be returned if there is a single parent.
        reference:
          type: string
          description: A custom reference assigned to the customer.
        status:
          oneOf:
          - $ref: '#/components/schemas/CustomerCreateRequestStatus'
          - type: 'null'
        timezone:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/CustomerCreateRequestType'
          description: The type of customer entity.
        email:
          type: string
          description: The email of the customer.
        notification_preferences:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/NotificationPreference'
          description: Notification preferences for customer-related communications.
        locale:
          type:
          - string
          - 'null'
          description: The locale of the customer. Format is language-country (like en-US).
        individual:
          $ref: '#/components/schemas/Individual'
          description: Additional description of the individual customer type.
        organization:
          $ref: '#/components/schemas/Organization'
          description: Additional description of the organization customer type.
        custom_fields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomFieldValue'
        processing_only:
          type:
          - boolean
          - 'null'
        pricing_plan_subscription_selector:
          $ref: '#/components/schemas/PricingPlanSubscriptionSelector'
          description: Settings to influence dynamically the subscription to use for the ingest data.
        linked_integrations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/LinkedIntegration'
        roles:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomerCreateRequest

# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/solvimon/refs/heads/main/openapi/solvimon-paymentschedules-api-openapi.yml