Struct Invoice 

pub struct Invoice {

    pub id: String,
    pub subscription_id: String,
    pub customer: String,
    pub plan_id: String,
    pub number: i64,
    pub amount: Money,
    pub credits: i64,
    pub period_start: u64,
    pub period_end: u64,
    pub status: InvoiceStatus,
    pub charge_id: Option<String>,
    pub channel: Channel,
    pub instructions: Instructions,
    pub due_at: u64,
    pub paid_at: Option<u64>,
    pub created_at: u64,
}

Fields

id: String

Also the charge’s reference at the gateway and the ledger reference of the credits it buys — one id through all three, so a webhook and a top-up are matched to the invoice with no lookup table.

subscription_id: String

customer: String

plan_id: String

number: i64

1 for the first invoice, then counting. Unique per subscription, which is what stops two schedulers raising the same renewal.

amount: Money

credits: i64

Credited when paid.

period_start: u64

The period this invoice buys. For the first invoice both are zero until it is paid, because access starts at payment, not at signup.

period_end: u64

status: InvoiceStatus

charge_id: Option<String>

The gateway’s charge id. None while the charge has not been created yet — the gateway was down when the invoice was raised — or after the gateway expired it; the next tick creates a fresh one either way.

channel: Channel

instructions: Instructions

How to pay: the VA number, the QR, the URL. Empty until there is a charge.

due_at: u64

Unix seconds. After this the subscription is in grace.

paid_at: Option<u64>

created_at: u64

Implementations

impl Invoice

pub fn is_payable(&self) -> bool

pub fn to_json(&self) -> Json

Trait Implementations

impl Clone for Invoice

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Invoice

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Invoice

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Invoice