GET /promotional_credits

This endpoint lists the promotional credits set for a customer

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
`id`	Object	No	optional, string filter Unique reference ID provided for promotional credits. Supported operators : is, is_not, starts_with Example → id[is] = "1bkfc8dw2o"
`customer_id`	Object	No	optional, string filter Identifier of the customer. Supported operators : is, is_not, starts_with Example → customer_id[is] = "4gkYnd21ouvW"
`limit`	Integer	No	The number of resources to be returned. Default value: 10
`type`	Object	No	optional, enumerated string filter Type of promotional credits. Possible values are : increment, decrement. Supported operators : is, is_not, in, not_in Example → type[is] = "increment"
`created_at`	Object	No	optional, timestamp(UTC) in seconds filter Timestamp indicating when this promotional credit resource is created. Supported operators : after, before, on, between Example → created_at[on] = "1435054328"
`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.