Get Credits History

Use this method to get the credit history of the user who is logged in via the Unified Login.

URL / Endpoint

GET /v1/CreditHistory/GetCreditsHistory

Request

Property	Type	Description
`PageSize`	integer	Sets the number of transactions on each page of the result set. Accepts values from `1` to `100`. Default is `50`.
`PageNumber`	integer	Returns a specific page in the result set. Accepts values from `1` onwards. When left empty it starts at the last page.
`OrderBy`	string	Sets the order in which the data will be returned. Default is transactiondate-asc. Order options are `transactiondate-asc` and `transactiondate-desc`.

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP GET method by passing parameters over the query string of the URI.

Headers

The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.

Authentication

An Authorization header is required with every request and must contain the access_token of the user. More information can be found in the Access tokens page.

Scopes

This endpoint requires the following scope:

Scope
`account_credits_history`

Samples

GET method

https://api-sandbox.adultwork.com/v1/credithistory/GetCreditsHistory

Authorization: bearer {your-access-token}

Response

Property	Type	Description
`PageCount`	integer	Represents the total number of pages in the result set.
`PageNumber`	integer	Represents the current page number.
`PageSize`	integer	Represents how many transactions are listed on each page.
`CreditHistory`	Array of aws:CreditHistory	The member's credit history.

Response Sample

The following example shows the result.

JSON
XML

{
  "PageNumber": 1,
  "PageCount": 1,
  "PageSize": 50,
  "CreditHistoryTotal": 2,
  "CreditHistory": [
  {
    "TransactionId": 22904,
    "TransactionDate": "2015-12-12T00:00:00",
    "TransactionType": "D",
    "Description": "24 Hours subscription to kinkydirtybitch's Private Gallery, Expires 12/13/2015",
    "Credits": -2,
    "Balance": 299
  },
  {
    "TransactionId": 22905,
    "TransactionDate": "2016-01-12T00:00:00",
    "TransactionType": "D",
    "Description": "24 Hours subscription to kinkydirtybitch's Private Gallery, Expires 01/13/2016",
    "Credits": -2,
    "Balance": 287
  }
 ]
}

<GetCreditHistoryOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Credits">
    <credithistory>
        <balance>299.0000</balance>
        <credits>-2.0000</credits>
        <description>24 Hours subscription to kinkydirtybitch's Private Gallery, Expires 12/13/2015</description>
        <transactiondate>2015-12-12T00:00:00</transactiondate>
        <transactionid>22904</transactionid>
        <transactiontype>D</transactiontype>
    </credithistory>
    <credithistory>
        <balance>287.0000</balance>
        <credits>-2.0000</credits>
        <description>24 Hours subscription to kinkydirtybitch's Private Gallery, Expires 01/13/2016</description>
        <transactiondate>2016-01-12T00:00:00</transactiondate>
        <transactionid>22905</transactionid>
        <transactiontype>D</transactiontype>
    </credithistory>
<CreditHistoryTotal>2</CreditHistoryTotal>
    <PageCount>1</PageCount>
    <PageNumber>1</PageNumber>
    <PageSize>50</PageSize>
</GetCreditHistoryOutput>