Retrieve Invoice Lines from Invoice

Retrieve invoice lines from an invoice.

Invoice lines are subscription items or invoice items.

Parameters

Request Path Parameters

- invoice
- ID of the invoice. String starting with invoice_.

Request Header Parameters

Response Parameters

- attempt_count
- Total number of attempts made to pay this invoice.
- attempted
- Indicates whether an attempt has been made to pay the invoice automatically.
- automatic_attempt_count
- Number of automatic attempts that Rapyd made to retry paying this invoice if it failed.
- billing
- Determines the method of billing at the end of the billing cycle. Set to pay_automatically - Rapyd generates a payment object, then attempts to pay it using the designated payment method.
- billing_reason
- The reason for billing. One of the following:
  - subscription_cycle - A new cycle for the subscription.
  - subscription_create - A new subscription has been created.
  - manual - Customer was billed manually.
  - upcoming - Customer has an upcoming billing invoice.
- created_at
- The time the invoice was created, in Unix time.
- currency
- Three-letter ISO 4217 currency code for the currency used in all fields that refer to a monetary amount.
- customer
- ID of the customer that pays this invoice. String starting with cus_.
- days_until_due
- Number of days the customer has for paying this invoice. Integer.
- description
- Description of the invoice.
- discount
- Describes the discount that applies to this invoice. The source of the discount is one of the following:
  - If the invoice is generated manually, the discount is taken from the Customer object.
  - If the invoice is generated automatically from a subscription, the discount is taken from the Subscription object if it is defined there. Otherwise, it is taken from the Customer object.
- discount_amount
- The amount of the discount that was applied to this invoice.
- due_date
- The date payment is due on this invoice. This value is calculated from the date the invoice is created, plus the number of days specified in the days_until_due field. Relevant when billing is send_invoice. Format is in Unix time.
- id
- ID of the invoice. String starting with invoice_.
- lines
- The individual line items that make up the invoice. These items are added with Create Invoice or Update Invoice. For details o the fields in the 'invoice_item' object, see Create Invoice Item.
- metadata
- A JSON object defined by the client. See Metadata.
- next_payment_attempt
- The time when the next payment attempt will be made, in Unix time.
- number
- Invoice number, starting with the invoice_prefix specified in the Customer object.
- payment
- The 'payment' object that was generated for this invoice. For details of the fields in the 'payment' object, see Create Payment.
- payment_fields
- Additional payment_options.
- payment_method
- ID of the payment method for paying the invoice.
- payout
- Reserved.
- payout_fields
- Reserved.
- period_end
- Last date in the period covered by the invoice, in Unix time.
- period_start
- First date in the period covered by the invoice, in Unix time.
- statement_descriptor
- Description of the invoice for the customer's credit card statement. Limited to 22 characters.
- status
- An invoice moves through a series of statuses.
  - draft - Starting status for all invoices. The invoice can still be edited or deleted. The subscription's 'simultaneous_invoice' field determines when the status automatically moves to open. At any time, payment of the invoice via the 'Pay Invoice' method can move the invoice to another status.
  - deleted - An invoice can be deleted only when its status is draft. This action is usually done after an invoice is created due to an error.
  - open - The invoice has been finalized, and the system is now waiting for the payment to be completed by the customer. The invoice can no longer be edited.
  - paid - The paid status is used for invoices that are paid. Invoices are automatically marked as paid when payments are processed by Rapyd.
  - void - Voiding is similar to deleting an invoice, but keeps a record of when it was created, finalized, and voided. Invoices with a void status cannot be paid.
  - uncollectible - This invoice cannot be paid by the customer.
- subscription
- ID of the subscription that generates charges to this customer. String starting with sub_.
- subtotal
- Total of all line items before discount and before tax. Decimal.
- tax
- The amount of tax charged. Decimal. This is calculated asT = R x (S - D), where:
  - T is the tax.
  - R is the tax rate in tax_percent.
  - S is the subtotal.
  - D is the discount.
- tax_percent
- The percentage tax rate that is applied to the subtotal of the invoice, after subtracting all discounts. Decimal, up to four decimal places. Range: 0-100
- total
- Total after discount and tax. Decimal.
- type
- The type of the subscription: payment

Code Samples

.NET

using System;

namespace RapydApiRequestSample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                string invoice = "invoice_6bfb9a7b969e6ceb7675659db01cb7f0";

                string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/invoices/{invoice}/lines");

                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Error completing request: " + e.Message);
            }
        }
    }
}

JavaScript

const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;

async function main() {
  try {
    const result = await makeRequest(
      'GET',
      '/v1/invoices/invoice_6bfb9a7b969e6ceb7675659db01cb7f0/lines'
    );

    console.log(result);
  } catch (error) {
    console.error('Error completing request', error);
  }
}

PHP

<?php
$path .= "/<path-to-your-utility-file>/utilities.php";
include($path);

try {
    $object = make_request('get', "/v1/invoices/invoice_6bfb9a7b969e6ceb7675659db01cb7f0/lines");
    var_dump($object);
} catch(Exception $e) {
    echo "Error => $e";
}
?>

Python

from pprint import pprint

from utilities import make_request

result = make_request(method='get', path='/v1/invoices/invoice_6bfb9a7b969e6ceb7675659db01cb7f0/lines')
pprint(result)

/v1/invoices/:invoice/lines

Retrieve Invoice Lines from Invoice

curl -X get
https://sandboxapi.rapyd.net/v1/invoices/invoice_6bfb9a7b969e6ceb7675659db01cb7f0/lines
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'

    {
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "869d6b11-67f7-44fc-abc3-5e6fbea3ab79"
    },
    "data": [
        {
            "id": "il_b0051532fd10d381dcd6fbf8ddcb4016",
            "amount": 0,
            "currency": "USD",
            "description": "NAME1559645618",
            "discountable": true,
            "invoice_item": "",
						"metadata": {
							"merchant_defined": true
						},
            "period": {
                "start": 1559742818,
                "end": 1562334818
            },
            "proration": false,
            "quantity": 5,
            "plan": {
                "id": "plan_de8738ce3432b230d8b9f921f3203d4d",
                "aggregate_usage": "sum",
                "amount": 0,
                "billing_scheme": "per_unit",
                "created_at": 1559742810,
                "currency": "USD",
                "interval": "month",
                "interval_count": 1,
                "metadata": {},
                "nickname": "",
                "tiers": [],
                "tiers_mode": "",
                "transform_usage": {
                    "divide_by": 0,
                    "round": ""
                },
                "trial_period_days": 0,
                "usage_type": "licensed"
            },
            "subscription": "sub_a2976850ce6601ce0cbe1ef412b374ba",
            "subscription_item": "subi_ddc7bca515c3925faac075ffa8e1f02e",
            "type": "subscription"
        }
    ]
}

In this section:

Documentation

Retrieve Invoice Lines from Invoice

Parameters

Request Path Parameters

Request Header Parameters

Response Parameters

Code Samples

Search results