Forget a customer | Solvimon

curl -X POST https://test.api.solvimon.com/v1/customers//forget \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "reference": "CUST-20240520-001",
  "type": "ORGANIZATION",
  "email": "contact@acmecorp.com",
  "roles": [
    "DEFAULT"
  ],
  "object_type": "customer",
  "id": "c1234567-89ab-4def-0123-456789abcdef",
  "created_at": "2024-05-20T10:15:30Z",
  "parent_customer_id": "p9876543-21ba-4fed-3210-fedcba987654",
  "parent_customer_ids": [
    "p9876543-21ba-4fed-3210-fedcba987654",
    "p1234567-89ab-4def-0123-456789abcdef"
  ],
  "status": "DRAFT",
  "timezone": "America/New_York",
  "notification_preferences": [
    {
      "type": "INVOICE",
      "channels": [
        {
          "type": "EMAIL",
          "enabled": true
        }
      ]
    }
  ],
  "locale": "en-US",
  "individual": {
    "name": {
      "first_name": "Jane",
      "last_name": "Doe",
      "infix": "van"
    },
    "residential_address": {
      "line1": "123 Maple Street",
      "line2": "Apt 4B",
      "city": "Springfield",
      "postal_code": "01103",
      "state": "MA",
      "country": "US"
    }
  },
  "organization": {
    "legal_name": "Acme Corporation",
    "tax_id": "12-3456789",
    "tax_ids": [
      {
        "id": "US123456789",
        "type": "EIN"
      }
    ],
    "registration_number": "REG-987654321",
    "tax_exempt": false,
    "tax_exempt_note": "",
    "registered_address": {
      "line1": "456 Industrial Way",
      "line2": "Suite 100",
      "city": "Metropolis",
      "postal_code": "54321",
      "state": "NY",
      "country": "US"
    }
  },
  "custom_fields": [
    {
      "id": "cf001",
      "reference": "preferred_contact_method",
      "value": "email",
      "values": [
        "email",
        "phone"
      ],
      "integration_details": {
        "payment_gateway_variant": "ADYEN",
        "id": "intg001",
        "reference": "stripe_gateway",
        "adyen": {
          "recurring_detail_reference": "recurring_123456"
        },
        "stripe": {
          "payment_method_id": "pm_1GqIC8Lz0qyl6XeWz7a1b2c3"
        }
      }
    }
  ],
  "processing_only": false,
  "pricing_plan_subscription_selector": {
    "data": [
      {
        "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
        "value": "US"
      }
    ],
    "rules": [
      {
        "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
        "type": "EQUALS"
      }
    ],
    "filters": [
      {
        "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
        "type": "EQUALS",
        "value": "US"
      }
    ],
    "fallback": "LATEST"
  },
  "linked_integrations": [
    {
      "id": "intg_link_001",
      "link_details": [
        {
          "url": "https://dashboard.stripe.com/customers/cus_ABC123",
          "custom_field_name": "stripe_customer_link"
        }
      ]
    }
  ]
}

Requires the CUSTOMER.UPDATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdOrReferencestringRequiredDefaults to

The ID or reference of the resource.

Response

referencestringformat: "^\S+$"0-256 characters

A custom reference assigned to the customer.

typeenum

The type of customer entity.

Allowed values:

emailstringformat: "(\S*@\S*\..*)"0-256 characters

The email of the customer.

roleslist of enums

Allowed values:

object_typestring or nullRead-only

idstring or nullRead-only

created_atstring or nullRead-only

parent_customer_idstring or null

The parent of the customer. Only returned when there is a single parent.

parent_customer_idslist of strings or null

A list of parents of the customer. Will also be returned if there is a single parent.

statusenum or null

Allowed values:

timezonestring or null

notification_preferenceslist of objects or null

Notification preferences for customer-related communications.

localestring or null

The locale of the customer. Format is language-country (like en-US).

individualobject

Additional description of the individual customer type.

organizationobject

Additional description of the organization customer type.

custom_fieldslist of objects or null

processing_onlyboolean or null

pricing_plan_subscription_selectorobject

Settings to influence dynamically the subscription to use for the ingest data.

linked_integrationslist of objects or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors