Light APIv1.0.0

API / Reference / Customers

Archive customer

POST https://api.light.inc/v1/customers/{customerId}/archive

Archive the given customer

Authorization

Send one of these on every request. See Authentication for how to get credentials.

  • API key

    Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

  • Bearer token

Path parameters

  • customerId string · uuidrequired

Response

  • id string · uuid

    Unique identifier for the object

  • name string

    Name of the customer

  • email string

    Email address of the customer

  • address object

    • country string

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of UNDEFINED AC AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU IC ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NT NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

    • city string

    • state string

    • zipcode string

    • street string

    • street2 string

  • billingAddress object

    • country string

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of UNDEFINED AC AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU IC ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NT NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

    • city string

    • state string

    • zipcode string

    • street string

    • street2 string

  • shippingAddress object

    • country string

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of UNDEFINED AC AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU IC ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NT NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

    • city string

    • state string

    • zipcode string

    • street string

    • street2 string

  • status string

    Current status of the customer

    • ACTIVE - The customer is active and can be used in invoices and contracts
    • ARCHIVED - The customer is archived and cannot be used in new invoices or contracts

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of ACTIVE ARCHIVED

  • description string

    Description or notes about the customer

  • vatNumber string

    VAT number of the customer

  • businessRegistrationNumber string

    Business registration number of the customer

  • easCode string

    Electronic Address Scheme code used for sending e-invoices

  • einvoiceAddress string

    E-invoice address for the customer

  • einvoiceNetwork string

    E-invoice network the customer is registered on

    • FR_PA - France Plateforme Agréée (Chorus Pro / Annuaire) e-invoice network
    • MYDATA - Greece myDATA e-invoice network
    • NEMHANDEL - NemHandel e-invoice network
    • PEPPOL - Peppol e-invoice network
    • PORTUGUESE_TAX_REPORTING - Portuguese tax reporting (ATCUD) e-invoice network
    • SDI - SDI (Sistema di Interscambio) e-invoice network
    • VERIFACTU - Spain VERI*FACTU tax reporting e-invoice network

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of FR_PA MYDATA NEMHANDEL PEPPOL PORTUGUESE_TAX_REPORTING SDI VERIFACTU

  • type string

    Type of customer

    • BUSINESS - Business customer
    • CONSUMER - Consumer customer
    • GOVERNMENT - Government customer

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of BUSINESS CONSUMER GOVERNMENT

  • logoUrl string

    URL to the customer's logo

  • domain string

    Domain of the customer's website

  • externalSource object

    The external system where this product was synced from

    • name string

      The name of the external source

      • CHARGEBEE - Data synced from Chargebee
      • HUBSPOT - Data synced from HubSpot
      • SALESFORCE - Data synced from Salesforce
      • STRIPE - Data synced from Stripe

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of CHARGEBEE HUBSPOT SALESFORCE STRIPE

    • externalId string

      The ID of the object in the external source system

  • createdAt string · date-time

    Timestamp when the customer was created

  • updatedAt string · date-time

    Timestamp when the customer was last updated

  • customProperties array of object

    List of custom properties associated with the customer

    • groupId string · uuid

      ID of the custom property group

    • groupInternalName string

      Internal name of the custom property group

    • values array of object

      List of values. Note that this will be a single value unless the group input type supports multiple values

      • id string · uuid

        Unique identifier for the object

      • groupId string · uuid

        ID of the custom property group

      • groupInternalName string

        Internal name of the custom property group

      • companyId string · uuid

        ID of the company

      • internalName string

        Internal name of the custom property value

      • label string

        Label of the custom property value

      • context string

        Context/description of the custom property value

      • createdAt string · date-time

        Timestamp when the custom property value was created

      • updatedAt string · date-time

        Timestamp when the custom property value was last updated

  • recipientEmails array of string

    Billing email recipients ("Send to") used when sending invoices to this customer

  • ccEmails array of string

    Billing email CC recipients used when sending invoices to this customer