Skip to main content
GET
Available in🇮🇳 India🇸🇬 Singapore🇺🇸 United States
Use this endpoint to retrieve all invoices of a Subscription. The count in the response indicates the number of invoices generated for a Subscription.

​
Query Parameters

​
string
required
The unique identifier linked to the Subscription. For example, sub_00000000000001.

​
Response Parameters

​
integer
The number of invoices generated for the Subscription.
​
array
List of invoices generated for the Subscription.
​
string
The unique identifier of the invoice issued for the Subscription.
​
string
The entity being created. Here, it is invoice.
​
string
Here, it is null.
​
string
The invoice number. Here, it is null.
​
string
The unique identifier of the customer linked to the Subscription.
​
object
Details of the customer.
​
string
The unique identifier of the customer linked to the Subscription.
​
string
The customer’s name. Know more Customers API.
​
string
The customer’s email address.
​
string
The customer’s contact number.
​
string
The customer’s billing address.
​
string
The customer’s shipping address.
​
string
The customer’s name.
​
string
The customer’s email address.
​
string
The customer’s contact number.
​
string
The unique identifier of the order associated with the invoice.
​
string
The unique identifier of the Subscription. For example, sub_00000000000001.
​
array
Details of the line item that is billed in the invoice. Number of arrays = number of line items billed in the invoice. For example, if the Subscription starts immediately and has an upfront fee attached to it, the number of line items = 2. One for the Subscription charge and one for the upfront fee.
​
string
The unique identifier linked to the item billed in the invoice. For example, li_00000000000001.
​
string
Here, it is null.
​
string
The item’s name. For example, Monthly Plan.
​
string
A brief description of the item. Here, it is null.
​
integer
The item’s price, in currency subunits. For example, 99900.
​
string
The currency for the amount charged for the item.
​
string
The type of charge. Possible values:
  • plan
  • addon
​
integer
The number of units of the item billed in the invoice. For example, 1.
​
string
Unique identifier of the payment made by the customer using this invoice. For example, pay_00000000000001.
​
string
The status of the invoice. Possible values:
  • draft
  • issued
  • partially_paid
  • paid
  • expired
  • cancelled
  • deleted
​
integer
The Unix timestamp, indicates at which the invoice will expire. For example, 1593411509
​
integer
The Unix timestamp, indicates at which the invoice was issued to the customer. For example, 1593411209
​
integer
The Unix timestamp, indicates at which the payment was made. For example, 1593411325
​
integer
The Unix timestamp, indicates at which the invoice was canceled by you. For example, 1593411209
​
integer
The Unix timestamp, indicates at which the invoice has expired. For example, 1593411209
​
string
Indicates whether the SMS notification for the invoice was sent to the customer. Possible values:
  • pending
  • sent
​
string
Indicates whether the email notification for the invoice was sent to the customer. Possible values:
  • pending
  • sent
​
integer
The Unix timestamp, that indicates the date of the invoice.
​
string
Any terms to be included in the invoice. Here, it is null.
​
boolean
Indicates whether the customer can make a partial payment on the invoice.
  • true: Customer can make partial payments.
  • false: Customer cannot make partial payments.
​
integer
Amount to be paid using the invoice. This should be in the smallest unit of the currency. For example, 29995.
​
integer
Amount paid by the customer using the invoice. For example, 29995.
​
integer
The remaining amount to be paid by the customer for the issued invoice.
​
string
The currency associated with the item.
​
string
A brief description of the invoice. Here, it is null.
​
object
Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.
​
string
Any comments to be added in the invoice. Here, it is null.
​
string
The short URL that is generated. This is the link that can be shared with customers to accept payments. Once canceled, no payments can be accepted using the link. For example, https://rzp.io/i/gb5827Hh.
​
boolean
Used when the link description is lengthy and you want to make the text collapsible. The text can be expanded by the customer using the Show More link.
  • true (default): Link description appears collapsed, with a Show More link.
  • false: Link description appears expanded.
​
string
Here, it is invoice.
​
integer
The Unix timestamp, that indicates when this invoice entity was created. For example, 1593411943.

​
Errors

Code: 4xxThis error occurs due to a mismatch between the API credentials passed in the API call and those generated on the Dashboard.Solution: Ensure that the API keys are active and correctly entered, with no whitespaces before or after the keys.
Code: 400The subscription_id query parameter is malformed (shorter than the expected sub_<14 alphanumeric chars> format).Solution: Pass subscription_id as a well-formed subscription id (sub_<14 alphanumeric chars>).