GET /comments

Retrieve the list of comments sorted by the recent ones on the top.

If you want to retrieve the list of comments for an entity, for example, subscription you can filter them by passing the entity type and unique identifier for that entity, for example, subscription ID.

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
`limit`	Integer	No	The number of resources to be returned. Default value: 10
`entity_id`	String	No	Unique identifier of the entity.
`created_at`	Object	No	optional, timestamp(UTC) in seconds filter The time at which this comment was created. Supported operators : after, before, on, between Example → created_at[on] = "1456332678"
`entity_type`	String	No	Type of the entity this comment generated for. item - Entity that represents item order - Entity that represents an order item_price - Entity that represents item price customer - Entity that represents a customer variant - Entity that represents product variants invoice - Invoice description product - Entity that represents product business_entity - Entity that represents item of type business entity plan - Entity that represents a subscription plan coupon - Entity that represents a discount coupon subscription - Entity that represents a subscription of a customer item_family - Entity that represents item family transaction - Entity that represents a transaction. addon - Entity that represents an addon credit_note - Credit note description quote - Entity that represents a quote Possible values: `"price_variant"` `"quote"` `"business_entity"` `"sales_order"` `"order"` `"transaction"` `"subscription"` `"recorded_purchase"` `"customer"` `"omnichannel_subscription"` `"addon"` `"omnichannel_subscription_item_scheduled_change"` `"item"` `"item_family"` `"item_price"` `"plan"` `"omnichannel_transaction"` `"coupon"` `"omnichannel_subscription_item"` `"invoice"` `"credit_note"`
`sort_by`	Object	No	optional, string filter Sorts based on the specified attribute. Supported attributes : created_at Supported sort-orders : asc, desc Example → sort_by[asc] = "created_at" This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.
`offset`	String	No	Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set `offset` to the value of `next_offset` obtained in the previous iteration of the API call.

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.