List invoices for your org
Query string parameters
?limit=
uint32//&page_token=
string//
Response
- 200 OK
- //
next_page:
string,//:
[[ ... ]//- //
amount_due:
numberUSD Price,//amount_paid:
numberUSD Price,//amount_refunded:
numberUSD Price,//amount_remaining:
numberUSD Price,//attempt_count:
numberuint64,//attempted:
boolean,//billing_reason:
string,//collection_method:
string,//created_at:
stringISO-8601,//currency:
string,//customer_email:
stringEmail Address,//customer_id:
string,//default_payment_method:
string,//description:
string,//id:
string,//number:
string,//paid:
boolean,//pdf:
stringURL,//receipt_number:
string,//statement_descriptor:
string,//subscription_id:
string,//subtotal:
numberUSD Price,//tax:
numberUSD Price,//total:
numberUSD Price,//url:
stringURL,//:
[[ ... ],//- //
{
:
{{ ... }//amount_off:
numberUSD Price,//id:
string,//name:
string,//percent_off:
numberdouble,//:
{{ ... }//[key]:
string
}
}
}
]
:
[[ ... ],//- //
amount:
numberUSD Price,//currency:
string,//description:
string,//id:
string,//invoice_item:
string,//:
{{ ... }//[key]:
string
}
}
]
:
{{ ... },//[key]:
string
}
refund_status:
,"partially_refunded"+1▾- //Some, but not all, captured funds tied to the invoice were refunded.
"partially_refunded" - //All captured funds tied to the invoice were refunded.
"refunded"
//status:
"draft"+5▾- //Draft.
"draft" - //Open.
"open" - //Paid.
"paid" - //Uncollectible.
"uncollectible" - //Void.
"void" - //Unknown.
"unknown"
//
}
]
}
Examples
get
/org/payment/invoices200 OK
Response