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
BillingOverview
Overview
A user's account balance on Etsy.
Fields
Field | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
is_overdue |
private |
|
boolean |
True if the user has an overdue balance. |
currency_code |
private |
|
string |
The currency unit in which the user is billed. |
overdue_balance |
private |
|
float |
The total overdue balance owed by the user. |
balance_due |
private |
|
float |
The total amount currently due for payment (including any overdue balance.) |
total_balance |
private |
|
float |
The total amount owed by the user (including fees that are not yet due for payment.) |
date_due |
private |
|
epoch |
The date by which the user's balance due must be paid. |
date_overdue |
private |
|
epoch |
The date on which the user's balance became overdue.
Deprecated: do not use - always returns 0 |
Associations
This resource has no associations.
Methods
getUserBillingOverview
Method Name | getUserBillingOverview |
||||||||
---|---|---|---|---|---|---|---|---|---|
Synopsis | Retrieves the user's current balance. | ||||||||
HTTP Method | GET |
||||||||
URI | /users/:user_id/billing/overview |
||||||||
Parameters |
|
||||||||
Requires OAuth | Y |
||||||||
Permission Scope |
|