Subscriptions: Charges List

See the charge object for details on the charge model

Request

GET https://api../stores/{storeId}/subscription/{subscriptionId}/charges

Parameters:

Parameters
last_fournumber
Filter by the last four digits of the credit card used. If specified, you must also include the name, exp_month, and exp_year parameters
namestring
Filter by the card holder’s name. If specified, you must also include the last_four, exp_month, and exp_year parameters
exp_monthnumber
Filter by the expiration month of the card used. If specified, you must also include the last_four, name, and exp_year parameters
exp_yearnumber
Filter by the expiration year of the credit card used. If specified, you must also include the last_four, name, and exp_month parameters
card_numbernumber
Filter for charges that used a specific credit card number.
fromstring (ISO-8601)
Filter for charges created after this date.
tostring (ISO-8601)
Filter for charges created before this date.
emailstring
Filter for charges that were made by customer that provided this email address
phonestring
Filter for charges using a phone number
amount_fromnumber
Filter for charges with a are great than this amount.
amount_tonumber
Filter for charges that are less
currencystring (ISO-4217)
Filter for charges that were requested or charged in this currency.
modestring
Filter by processing mode. live or test.
metadatastring
Filter by metadata contents.
transaction_token_idstring (UUID)
Filter for charges by the transaction token id.

Headers:

Authorization: Bearer {secret}.{jwt}

Body:

curl --request GET \
--url https://api../stores/23f45c5e-18ef-11e7-96ee-d756c0178178/subscriptions/25d0fb2c-18ef-11e7-9dd3-db8fb7b820e7/charges \
--header 'Authorization: Bearer {secret}.{jwt}'

Response

Code: 200

Headers:

Content-Type: application/json

Body:

{
  "items": [
    {
      "id": "26f9059e-18ef-11e7-a74f-173cf0f9475a",
      "store_id": "23f45c5e-18ef-11e7-96ee-d756c0178178",
      "transaction_token_id": "259e9240-18ef-11e7-94da-97e85c2e269c",
      "requested_amount": 483200,
      "requested_currency": "EUR",
      "requested_amount_formatted": 4832,
      "charged_amount": 483200,
      "charged_currency": "EUR",
      "charged_amount_formatted": 4832,
      "status": "successful",
      "error": null,
      "metadata": {},
      "mode": "test",
      "created_on": 1491280108819
    },
    {
      "id": "270858e6-18ef-11e7-adfa-6ff75ea1c202",
      "store_id": "23f45c5e-18ef-11e7-96ee-d756c0178178",
      "transaction_token_id": "259f4a8c-18ef-11e7-b8fe-17e053dc5c54",
      "requested_amount": 2491,
      "requested_currency": "JPY",
      "requested_amount_formatted": 2491,
      "charged_amount": 2491,
      "charged_currency": "JPY",
      "charged_amount_formatted": 2491,
      "status": "successful",
      "error": null,
      "metadata": {},
      "mode": "test",
      "created_on": 1491280108919
    }
  ],
  "has_more": false
}