LIlight
v1 - Products

Update product

Updates an existing product

patch/v1/products/{productId}

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

productIdstring uuid required

Headers

X-Idempotency-Keystring

Request body

namestring nullable
pricingType'FIXED' | 'PACKAGE' nullable
  • FIXED - The product has a single price per unit
  • PACKAGE - The product is sold in packages with a fixed quantity

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

billingRecurrence'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY' nullable
  • ONE_TIME - The product is billed once
  • MONTHLY - The product is billed every month
  • QUARTERLY - The product is billed every three months
  • HALF_YEARLY - The product is billed every six months
  • YEARLY - The product is billed every year

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

defaultAvataxCodestring nullable
defaultTaxIdstring uuid nullable
defaultLedgerAccountIdstring uuid nullable

Example request

{
  "pricings": [
    {
      "currency": "USD"
    }
  ]
}

Response

default response

idstring uuid

Unique identifier for the object

companyIdstring uuid

ID of the company

namestring

Name of the product

pricingType'FIXED' | 'PACKAGE'

Pricing type of the product

  • FIXED - The product has a single price per unit
  • PACKAGE - The product is sold in packages with a fixed quantity

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

billingRecurrence'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY'

Billing frequency for the product. Used in contracts

  • ONE_TIME - The product is billed once
  • MONTHLY - The product is billed every month
  • QUARTERLY - The product is billed every three months
  • HALF_YEARLY - The product is billed every six months
  • YEARLY - The product is billed every year

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

state'ACTIVE' | 'ARCHIVED'

Product state

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

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

defaultTaxIdstring uuid nullable

ID of the default tax code for this product. Will be assigned to invoice lines when creating a line with this product

defaultAvataxCodestring nullable

Default Avalara tax code. Used when the invoice tax engine is AVATAX. Will be assigned to invoice lines when creating a line with this product

defaultLedgerAccountIdstring uuid nullable

ID of the default ledger account for this product. Will be assigned to invoice lines when creating a line with this product

createdAtstring date-time

Timestamp when the product was created

updatedAtstring date-time

Timestamp when the product was last updated

Example response

{
  "pricings": [
    {
      "currency": "USD"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.