@bebapps/rapyd-sdk
Version:
An un-official [Rapyd](https://rapyd.net) SDK for Node.js.
51 lines (50 loc) • 1.36 kB
text/typescript
export interface CreateInvoiceRequest {
/**
* Determines the method of collection: **pay_automatically** or **send_invoice**. Default is **pay_automatically**.
*/
billing?: string;
/**
* Three-letter ISO 4217 code for the currency used for this invoice. Uppercase.
*/
currency?: string;
/**
* ID of the customer. String starting with **cus_**.
*/
customer: `cus_${string}`;
/**
* The number of days until the due date.
*/
days_until_due?: number;
/**
* Description of the invoice.
*/
description?: string;
/**
* 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. Format is in [*Unix time*](ref:glossary).
*/
due_date?: number;
/**
* A JSON object defined by the client.
*/
metadata?: object;
/**
* Payment fields of `payment` object.
*/
payment_fields?: object;
/**
* Payment method for the invoice.
*/
payment_method?: string;
/**
* Description of the invoice for the customer's credit card statement. Limited to 22 characters.
*/
statement_descriptor?: string;
/**
* ID of the subscription that is the basis for this invoice.
*/
subscription?: string;
/**
* The tax rate, defined as a percentage.
*/
tax_percent?: number;
};