InvoiceResponse.md

InvoiceResponse

Invoice

Properties

Name	Type	Required	Description
id_	str	❌
attempt_count	float	❌
attempted	float	❌	Number of automatic attempts that Rapyd made to retry paying this invoice if it failed.
automatic_attempt_count	float	❌	Number of automatic attempts that Rapyd made to retry paying this invoice if it failed.
billing	str	❌	Determines the method of collection, pay_automatically or send_invoice. Default is pay_automatically
billing_reason	BillingReason	❌	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: <BR> 1. Create Coupon, which returns a coupon ID. <BR>2. Add the coupon ID to the coupon field of the customer with Create Customer or Update Customer.
currency	str	❌	In transactions without FX, defines the currency of the transaction. Three-letter ISO 4217 code.<BR> In FX transactions:<BR> _ When fixed_side is buy, it is the currency received in the Rapyd wallet.<BR> _ When fixed_side is sell, it is the currency charged to the buyer.
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.
discount_amount	float	❌	The amount of the discount that was applied to this 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.
lines	List[InvoiceItemResponse]	❌
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	Payment	❌	Collects money from a payment method and deposits it into one or more Rapyd Wallets
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	Payout	❌
payout_fields	dict	❌	Reserved
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.
next_payment_attempt	float	❌	The time when the next payment attempt will be made, in Unix time.
number	str	❌
status	InvoiceResponseStatus	❌	An invoice moves through a series of statuses. See status table below.
subtotal	float	❌	Total of all line items before discount and before tax. Decimal. Response only.
total	float	❌	Total after discount and tax. Decimal.
type_	InvoiceResponseType	❌

BillingReason

The reason for billing

Properties

Name	Type	Required	Description
SUBSCRIPTIONCYCLE	str	✅	"subscription_cycle"
SUBSCRIPTIONCREATE	str	✅	"subscription_create"
MANUAL	str	✅	"manual"
UPCOMING	str	✅	"upcoming"

InvoiceResponseStatus

An invoice moves through a series of statuses. See status table below.

Properties

Name	Type	Required	Description
DRAFT	str	✅	"draft"
DELETED	str	✅	"deleted"
OPEN	str	✅	"open"
PAID	str	✅	"paid"
VOID	str	✅	"void"
UNCOLLECTIBLE	str	✅	"uncollectible"

InvoiceResponseType

Properties

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