Retrieve Upcoming Invoice

Retrieve a preview of the basic data of the upcoming invoice for a customer, with individual invoice lines.

To get the invoice lines of the invoice, use Retrieve Invoice Lines from Invoice.

The response generated cannot be used to generate a payment authorization.

Parameters

Request Query Parameters

- customer
- ID of the customer whose invoice you want to retrieve.
- currency
- Three-letter ISO 4217 code for the currency. Required when the invoice is not linked to a specific subscription.

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 customer = "cus_478a0ffb8ad771c1bf9736e4b9e2b5f1";
                string currency = "USD";

                string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/invoices/upcoming?customer={customer}&currency={currency}");

                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/upcoming?customer=cus_478a0ffb8ad771c1bf9736e4b9e2b5f1&currency=USD'
    );

    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/cus_478a0ffb8ad771c1bf9736e4b9e2b5f1/upcoming?currency=USD");
    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/upcoming?customer=cus_478a0ffb8ad771c1bf9736e4b9e2b5f1&currency=USD')
pprint(result)

/v1/invoices/upcoming

Retrieve Upcoming Invoice for Customer

curl -X get
https://sandboxapi.rapyd.net/v1/invoices/upcoming?customer=cus_4ed89a9c556fb200997e974f75895dc9&currency=USD
-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": "1963a94b-5d94-49c7-950f-9610fe258fdc"
    },
    "data": {
        "id": "invoice_fd4545925e5a91119bb2aa935d0ff607",
        "attempt_count": 0,
        "billing": "pay_automatically",
        "billing_reason": "upcoming",
        "created_at": 1702208338,
        "currency": "USD",
        "customer": "cus_4ed89a9c556fb200997e974f75895dc9",
        "description": "",
        "discount": null,
        "due_date": 1704800338,
        "days_until_due": 30,
        "metadata": null,
        "number": 0,
        "payment_method": null,
        "payment": null,
        "payout": null,
        "payment_fields": null,
        "period_end": 0,
        "period_start": 0,
        "lines": [],
        "statement_descriptor": "",
        "subscription": null,
        "discount_amount": 0,
        "subtotal": 0,
        "tax": 0,
        "tax_percent": 0,
        "total": 0,
        "status": "draft",
        "payout_fields": null,
        "type": "payment",
        "next_payment_attempt": 1702211938,
        "automatic_attempt_count": null
    }
}

In this section:

Documentation