List credit grants
POST {{baseUrl}}/credits/listGrants?limit=<integer>&next_page=<string>
List credit grants. This list does not included voided grants.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | string | Max number of results that should be returned | |
next_page | string | Cursor that indicates where the next page of results should start. |
Request Body
{"credit_type_ids"=>["<uuid>", "<uuid>"], "customer_ids"=>["<uuid>", "<uuid>"], "credit_grant_ids"=>["<uuid>", "<uuid>"], "not_expiring_before"=>"<dateTime>", "effective_before"=>"<dateTime>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":[{"id":"\u003cuuid\u003e","name":"\u003cstring\u003e","customer_id":"\u003cuuid\u003e","effective_at":"\u003cdateTime\u003e","expires_at":"\u003cdateTime\u003e","priority":"\u003cnumber\u003e","grant_amount":{"amount":"\u003cnumber\u003e","credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"}},"paid_amount":{"amount":"\u003cnumber\u003e","credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"}},"balance":{"excluding_pending":"\u003cnumber\u003e","including_pending":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e"},"deductions":[{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"},{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"}],"pending_deductions":[{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"},{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"}],"custom_fields":{"minim0":"\u003cstring\u003e","sed_30":"\u003cstring\u003e"},"invoice_id":"\u003cuuid\u003e","uniqueness_key":"\u003cstring\u003e","reason":"\u003cstring\u003e","credit_grant_type":"\u003cstring\u003e","products":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]},{"id":"\u003cuuid\u003e","name":"\u003cstring\u003e","customer_id":"\u003cuuid\u003e","effective_at":"\u003cdateTime\u003e","expires_at":"\u003cdateTime\u003e","priority":"\u003cnumber\u003e","grant_amount":{"amount":"\u003cnumber\u003e","credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"}},"paid_amount":{"amount":"\u003cnumber\u003e","credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"}},"balance":{"excluding_pending":"\u003cnumber\u003e","including_pending":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e"},"deductions":[{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"},{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"}],"pending_deductions":[{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"},{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"}],"custom_fields":{"dolor_0":"\u003cstring\u003e","aliquipf2":"\u003cstring\u003e"},"invoice_id":"\u003cuuid\u003e","uniqueness_key":"\u003cstring\u003e","reason":"\u003cstring\u003e","credit_grant_type":"\u003cstring\u003e","products":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}]}],"next_page":"\u003cstring\u003e"}