GET /custom_field_configs/retrieve
Retrieves the configuration for the custom field that matches the specified entity type and API name.
Servers
- {protocol}://{site}.{environment}:{port}/api/v2
- {protocol}://{site}-test.{environment}:{port}/api/v2
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
chargebee-request-origin-device |
String | No |
The device from which the customer has made the request |
chargebee-business-entity-id |
String | No |
If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation. |
chargebee-request-origin-user |
String | No |
The email address of your customer/user. Use this when the email address has only ASCII characters. |
chargebee-request-origin-ip |
String | No |
The IP address of the customer where the request originated |
chargebee-request-origin-user-encoded |
String | No |
The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
api_name |
String | Yes |
Custom field identifier. |
entity_type |
String | Yes |
Allowed entity types for custom fields. * customer - Entity that represents a customer. * invoice - Entity that represents an invoice. * addon_item - Entity that represents item of type addon. * plan - Entity that represents a subscription plan. * subscription - Entity that represents a subscription of a customer. * coupon - Entity that represents a discount coupon. * charge_price - Entity that represents charge price. * item_family - Entity that represents item family. * addon - Entity that represents an addon. * addon_price - Entity that represents addon price. * credit_note - Entity that represents a credit note. * charge_item - Entity that represents item of type charge. * plan_item - Entity that represents item of type plan. * quote - Entity that represents a quote. * plan_price - Entity that represents plan price. Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.