InvoiceResponse

Invoice

Properties

Name	Type	Required	Description
id_	str	❌
attempt_count	float	❌
billing	str	❌	Determines the method of collection, pay_automatically or send_invoice. Default is pay_automatically
billing_reason	str	❌	The reason for billing
created_at	float	❌	The time the invoice was created, in Unix time. Response only.
discount	Discount	❌	Describes the fields relating to discounts in REST messages and webhooks for customer profiles and subscriptions Contains information about the coupon that applies to the customer. Read-only field. Adding a discount is a 2-step process - 1. Create Coupon, which returns a coupon ID. 2. Add the coupon ID to the coupon field of the customer with Create Customer or Update Customer.
currency	str	❌
customer	str	❌	ID of the customer. String starting with cus_.
days_until_due	float	❌	The number of days until the due date.
description	str	❌	Description of the invoice.
due_date	str	❌	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.
metadata	dict	❌	A JSON object defined by the client.
payment_fields	dict	❌	Object containing additional payment_options fields.
payment_method	str	❌	Payment method for the invoice.
statement_descriptor	str	❌	Description of the invoice for the customer's credit card statement. Limited to 22 characters.
subscription	str	❌	ID of the subscription that is the basis for this invoice.
tax_percent	float	❌	The tax rate, defined as a percentage.
payment	Payment	❌	Collects money from a payment method and deposits it into one or more Rapyd Wallets
payout	str	❌
period_end	float	❌	Last date in the period covered by the invoice, in Unix time. Response only.
period_start	float	❌	First date in the period covered by the invoice, in Unix time. Response only.
lines	List[InvoiceItem]	❌
subtotal	float	❌	Total of all line items before discount and before tax. Decimal. Response only.
tax	float	❌	The amount of tax charged. Decimal
number	str	❌
total	float	❌	Total after discount and tax. Decimal.
status	str	❌	An invoice moves through a series of statuses. See status table below.
payout_fields	dict	❌	Reserved
type_	InvoiceResponseType	❌

InvoiceResponseType

Properties

Name	Type	Required	Description
PAYMENT	str	✅	"payment"
PAYOUT	str	✅	"payout"

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →