Open API v2 will be deprecated on April 3, 2023. Please begin transitioning to Open API v3 as soon as possible. As of September 29, 2022 all new apps will only be permitted to use Open API v3.
- ApiMethod
- BillCharge
- BillingOverview
- BillPayment
- Cart
- CartListing
- Country
- Coupon
- DataType
- FavoriteListing
- FavoriteUser
- Feedback
- FeedbackInfo
- ForumPost
- Guest
- GuestCart
- ImageType
- Ledger
- LedgerEntry
- Listing
- ListingFile
- ListingImage
- ListingInventory
- ListingOffering
- ListingProduct
- ListingTranslation
- ListingVariationImage
- Money
- ParamList
- Payment
- PaymentAccountLedgerEntry
- PaymentAdjustment
- PaymentAdjustmentItem
- PaymentTemplate
BillPayment
Overview
Represents a user's Billing Payment.
Fields
Field | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
bill_payment_id |
private |
|
int |
The numeric ID for this bill payment record. |
creation_tsz |
private |
|
float |
Creation time, in epoch seconds. |
type |
private |
|
string |
The name of the type of payment. |
type_id |
private |
|
int |
The Listing or Transaction ID (or LedgerEntry ID in the case of a ledger payment) to which the payment applies. |
user_id |
private |
|
int |
The user's numeric ID. |
amount |
private |
|
float |
The amount paid. |
currency_code |
private |
|
string |
The currency of the payment. |
creation_month |
private |
|
int |
Month that the payment was made. |
creation_year |
private |
|
int |
Year that the payment was made. |
Associations
This resource has no associations.
Methods
findAllUserPayments
Method Name | findAllUserPayments |
||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Retrieves a set of BillPayment objects associated to a User. | ||||||||||||||||||||||||||||||||
HTTP Method | GET |
||||||||||||||||||||||||||||||||
URI | /users/:user_id/payments |
||||||||||||||||||||||||||||||||
Parameters |
|
||||||||||||||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||||||||||||||
Permission Scope |
|