Custom Checkout Fields
List Custom Fields
List custom fields.
Scopes: custom_fields:read
custom_fields:write
GET
Authorizations
You can generate an Organization Access Token from your organization's settings.
Query Parameters
Filter by organization ID.
Example:
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Filter by custom field name or slug.
Filter by custom field type.
Available options:
text
, number
, date
, checkbox
, select
Page number, defaults to 1.
Required range:
x > 0
Size of a page, defaults to 10. Maximum is 100.
Required range:
x > 0
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign -
before the criteria name to sort by descending order.
Available options:
created_at
, -created_at
, slug
, -slug
, name
, -name
, type
, -type
Was this page helpful?