Sha256: e41e6b1d6371f18ba0e5c8ad24d77d61ca19051e122286774e2ef8bb43c4dab3
Contents?: true
Size: 1.83 KB
Versions: 191
Compression:
Stored size: 1.83 KB
Contents
# Payment
## Example Payment Object
```
{
"id": 1,
"amount": 1.0,
"balance": 1.0,
"created_at": "2000-01-01T01:00:00Z",
"currency": "USD",
"download_uri": "https://url...",
"invoice_line_items": [
null
],
"method": "paypal",
"payment_line_items": [
null
],
"payment_reversed_at": "2000-01-01T01:00:00Z",
"payment_type": "example",
"site_name": "My Site",
"type": "invoice",
"updated_at": "2000-01-01T01:00:00Z"
}
```
* `id` (int64): Line item Id
* `amount` (double): Line item amount
* `balance` (double): Line item balance
* `created_at` (date-time): Line item created at
* `currency` (string): Line item currency
* `download_uri` (string): Line item download uri
* `invoice_line_items` (array): Associated invoice line items
* `method` (string): Line item payment method
* `payment_line_items` (array): Associated payment line items
* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
* `payment_type` (string): Type of payment if applicable
* `site_name` (string): Site name this line item is for
* `type` (string): Type of line item, either payment or invoice
* `updated_at` (date-time): Line item updated at
---
## List Payments
```
Files::Payment.list(
per_page: 1
)
```
### Parameters
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
---
## Show Payment
```
Files::Payment.find(id)
```
### Parameters
* `id` (int64): Required - Payment ID.
Version data entries
191 entries across 191 versions & 1 rubygems