Skip to main content
DELETE
Archive a custom property definition

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

custom property definition ID

Response

Archived

archived
boolean
required
config
object
required

Type-specific configuration. Only the fields relevant to property_type are interpreted.

display_order
integer<int32>
required
entity_type
enum<string>
required
Available options:
CUSTOMER,
SUBSCRIPTION,
INVOICE,
CREDIT_NOTE
id
string<MeteroidId>
required
Example:

"cpd_7n42DGM5Tflk9n8mt7Fhc7"

key
string
required
name
string
required
property_type
enum<string>
required
Available options:
TEXT,
NUMBER,
BOOLEAN,
DATE,
DATETIME,
SINGLE_SELECT,
MULTI_SELECT,
JSON,
URL,
EMAIL
required
boolean
required
default_value
any
description
string | null