Pick the List Payment Reference Numbers action (under Chargebee API).
Fill in the fields below, then reference the result from later steps as {{listPaymentReferenceNumbers.response.data}}.
Request
Query parameters
limitinteger (int32)
The number of resources to be returned.
Default 10
offsetstring
<p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>
to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code>
obtained in the previous iteration of the API call.</p>
idobject
optional, string filter
An unique identifier for the invoice serves that links the invoice to the corresponding payment reference number (PRN).
**Note** :
To retrieve the PRN, the API requires either the invoice ID or the payment reference number to be provided by the user. If both values are missing, an error will be returned by the API.
**Supported operators :**
is, is_not, starts_with, in, not_in
**Example →**
*id\[is\] = "old_inv_001"*
instring
isstring
payment_reference_numberobject
Parameters for payment_reference_number
numberobject2 fields
This parameter is used to identify the PRN in the system and retrieve its corresponding payment information. \*\*Note\*\*: To retrieve the PRN, the API requires either the invoice ID or the payment reference number to be provided by the user. If both values are missing, an error will be returned by the API.
Headers
chargebee-request-origin-devicestring
The device from which the customer has made the request
chargebee-request-origin-userstring (email)
The email address of your customer/user. Use this when the email address has only ASCII characters.
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.
chargebee-request-origin-ipstring
The IP address of the customer where the request originated
chargebee-business-entity-idstring
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.
Response
Returns 200 with an object. Read it in later steps with {{listPaymentReferenceNumbers.response.data.<field>}}.
listarray<object>
payment_reference_numberobjectrequired4 fields
Using this resource you can create reference numbers for Payment Instructions at the invoice level, allowing for multiple payment information and payment reference numbers to be associated with a single invoice. However, only one PRN is generated for each payment method.
next_offsetstring
<p class="mb-2">This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>.</p>
json
{"list":null,"next_offset":null}
Need more? See the Chargebee guide for connection setup and behaviour shared by every action.
