You are viewing the documentation for the older version of our API (V1). Click here for information on upgrading to the latest version (V2).

Comments

Comments are additional information that you can add to your resources. Comments can be added to provide context for any operation that was performed.

When you make an API call on any resource eg., Subscriptions -> Change term end, you can add more context to that operation by calling the comments API as a follow up call.

Besides the user generated comments, Chargebee also generates "System" comments when a change for a resource happens at the backend. These comments are all read-only.

Sample comment [ JSON ]

{ "added_by": "full_access_key_v1", "created_at": 1548178762, "entity_id": "__test__5SK0bLNFRFuCJKINu", "entity_type": "subscription", "id": "cmt___test__5SK0bLNFRFuCJMIO1", "notes": "This is a test comment", "object": "comment", "type": "user" }

API Index URL GET

https://{site}.chargebee.com/api/v1/comments

Comment attributes

id
Unique identifier for the comment.
string, max chars=40
entity_type
Type of the entity this comment generated for.
enumerated string
Possible values are
customerEntity that represents a customer.subscriptionEntity that represents a subscription of a customer.invoiceEntity that represents an invoice.quoteEntity that represents a quote.
credit_noteEntity that represents a credit note.transactionEntity that represents a transaction.planEntity that represents a subscription plan.addonEntity that represents an addon.couponEntity that represents a discount coupon.
Show all values[+]
added_by
The user who created the comment. If created via API, this contains the name given for the API key used.
optional, string, max chars=100
notes
Actual notes for the comment.
string, max chars=1000
created_at
The time at which this comment was created.
timestamp(UTC) in seconds
type
Type of comment this is.
enumerated string, default=user
Possible values are
userComment generated by user either via API or Admin console.systemComment generated by Chargebee when any backend changes happen for an entity.
entity_id
Unique identifier of the entity.
string, max chars=100

Create a comment

Create a new comment for an entity. The newly added comment will be shown in the web interface as well.
Sample Request 
curl  https://{site}.chargebee.com/api/v1/comments \
     -u {site_api_key}:\
     -d entity_id="__test__5SK0bLNFRFuCJKINu" \
     -d entity_type="subscription" \
     -d notes="This is a test comment"
copy
curl  https://{site}.chargebee.com/api/v1/comments \
     -u {site_api_key}:\
     -d entity_id="__test__5SK0bLNFRFuCJKINu" \
     -d entity_type="subscription" \
     -d notes="This is a test comment"

Sample Response [ JSON ]

Show more...
{"comment": { "added_by": "full_access_key_v1", "created_at": 1548178762, "entity_id": "__test__5SK0bLNFRFuCJKINu", "entity_type": "subscription", "id": "cmt___test__5SK0bLNFRFuCJMIO1", "notes": "This is a test comment", "object": "comment", "type": "user" }}

URL Format POST

https://{site}.chargebee.com/api/v1/comments

Input Parameters

entity_type
Type of the entity to create the comment for.
required, enumerated string
Possible values are
customerEntity that represents a customer.subscriptionEntity that represents a subscription of a customer.invoiceEntity that represents an invoice.quoteEntity that represents a quote.
credit_noteEntity that represents a credit note.transactionEntity that represents a transaction.planEntity that represents a subscription plan.addonEntity that represents an addon.couponEntity that represents a discount coupon.
Show all values[+]
entity_id
Unique identifier of the entity.
required, string, max chars=100
notes
Actual notes for the comment.
required, string, max chars=1000
added_by
The user who created the comment. If created via API, this contains the name given for the API key used.
optional, string, max chars=100

Returns

comment
Resource object representing comment.
always returned

Retrieve a comment

Retrieve a comment for an entity identified by comment id.
Sample Request 
curl  https://{site}.chargebee.com/api/v1/comments/cmt___test__5SK0bLNFRFuCJTAON \
     -u {site_api_key}:
copy
curl  https://{site}.chargebee.com/api/v1/comments/cmt___test__5SK0bLNFRFuCJTAON \
     -u {site_api_key}:

Sample Response [ JSON ]

Show more...
{"comment": { "added_by": "full_access_key_v1", "created_at": 1548178762, "entity_id": "__test__5SK0bLNFRFuCJS1OH", "entity_type": "subscription", "id": "cmt___test__5SK0bLNFRFuCJTAON", "notes": "This is a no cost plan", "object": "comment", "type": "user" }}

URL Format GET

https://{site}.chargebee.com/api/v1/comments/{comment_id}

Returns

comment
Resource object representing comment.
always returned

List 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 eg., subscription you can filter them by passing the entity type and unique identifier for that entity eg., subscription id.

Sample Request 
curl  https://{site}.chargebee.com/api/v1/comments \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=2
copy
curl  https://{site}.chargebee.com/api/v1/comments \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=2

Sample Response [ JSON ]

Show more...
{ "list": [ {"comment": { "added_by": "full_access_key_v1", "created_at": 1548178762, "entity_id": "__test__5SK0bLNFRFuCJPSO9", "entity_type": "customer", "id": "cmt___test__5SK0bLNFRFuCJR6OG", "notes": "This is a test comment", "object": "comment", "type": "user" }}, {..} ], "next_offset": "[\"1548178762000\",\"101000000046\"]" }

URL Format GET

https://{site}.chargebee.com/api/v1/comments

Input Parameters

limit
The number of resources to be returned.
optional, integer, default=10, min=1, max=100
offset
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.
optional, string, max chars=1000
entity_type
Type of the entity this comment generated for.
optional, enumerated string
Possible values are
customerEntity that represents a customer.subscriptionEntity that represents a subscription of a customer.invoiceEntity that represents an invoice.quoteEntity that represents a quote.
credit_noteEntity that represents a credit note.transactionEntity that represents a transaction.planEntity that represents a subscription plan.addonEntity that represents an addon.couponEntity that represents a discount coupon.
Show all values[+]
entity_id
Unique identifier of the entity.
optional, string, max chars=100

Returns

comment
Resource object representing comment.
always returned
next_offset
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter “offset”.
optional, string, max chars=1000

Delete a comment

Delete a comment for an entity identified by comment id.

Only the comments that are added via Admin console and API can be deleted. Chargebee generated "System" comments cannot be deleted.

Sample Request 
curl  https://{site}.chargebee.com/api/v1/comments/cmt___test__5SK0bLNFRFuCJOdO8/delete \
     -X POST  \
     -u {site_api_key}:
copy
curl  https://{site}.chargebee.com/api/v1/comments/cmt___test__5SK0bLNFRFuCJOdO8/delete \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

Show more...
{"comment": { "added_by": "full_access_key_v1", "created_at": 1548178762, "entity_id": "__test__5SK0bLNFRFuCJNPO2", "entity_type": "subscription", "id": "cmt___test__5SK0bLNFRFuCJOdO8", "notes": "This is a no cost plan", "object": "comment", "type": "user" }}

URL Format POST

https://{site}.chargebee.com/api/v1/comments/{comment_id}/delete

Returns

comment
Resource object representing comment.
always returned