{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-catalog/all.yaml","sidebar":"sidebar-sidebar.yaml__catalog_all"},"props":{"definitionId":"catalog/all.yaml","dynamicMarkdocComponents":[],"baseSlug":"/catalog/all","seo":{"title":"Custom fields","description":"Use custom fields to extend a resource scheme to include custom data that is not provided as a common field.\nDepending on the resource on which the custom field is added, it may be available in the Rebilly UI.\n\nExample: A custom field called `preferredCommunicationChannel` is added to the customer resource.\nIt has two allowed values, which are 'email' and 'phone'.\n\n```js\n{\n  \"customFields\": {\n      \"preferredCommunicationChannel\": \"email\"\n  }\n}\n```\n\nFor detailed information on Rebilly resources, see [Resources](https://www.rebilly.com/docs/dev-docs/concepts/#resources).","siteUrl":"https://www.rebilly.com","image":"/assets/rebillysocial.94fb32fc280c9e84b963c440ec462771d25f4e6fdaaa6c59de41e8135113b46b.db81178d.png","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"custom-fields","disableAutoScroll":true,"metadata":{"redocly_category":"API Reference","subType":"openapi-operation"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"rebilly-website.redocly.app","port":4000,"ipAddress":"216.73.216.152"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main","PUBLIC_STOREFRONT_API_URL":"https://api.rebilly.com/storefront","PUBLIC_REBILLY_API_KEY":"pk_live_Up3I_L3193Y9kFgjbUG90ZfkXpa1zPuFkeO-WeF","PUBLIC_LIVE_API_URL":"https://api.rebilly.com","PUBLIC_SANDBOX_API_URL":"https://api-sandbox.rebilly.com","PUBLIC_SANDBOX_KEY":"sk_sandbox_I140JyDyeAenz4eN0DrDTuDhnyA0Z5Nh_IpbcEw","PUBLIC_REBILLY_ORG_ID":"rebilly"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/catalog/all/custom-fields","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}