Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Subscriptions

List Subscription Balance Entries

Retrieve a list of Subscription Balance Entry resources to view a timeline of all changes to a Subscription balance by a user. Currently, only credits can modify a Subscription balance.

For details on how to query endpoints using the available parameters, see Query Parameters.

get/subscriptions/{subscription_id}/subscription_balance_entries

Query parameters

after_cursorstring

Return every resource created after the cursor value.

amountinteger
Example:100

Filter by an amount equal to the given value.

amount.gtinteger
Example:100

Filter by an amount greater than.

amount.gteinteger
Example:100

Filter by an amount greater than or equal.

amount.ltinteger
Example:100

Filter by an amount less than.

amount.lteinteger
Example:100

Filter by an amount less than or equal.

before_cursorstring

Return every resource created before the cursor value.

created_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where created_at is after the given date.

created_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where created_at is before the given date.

limitinteger
Example:10

The numbers of items to return.

sortstring

Specify the key to be used for sorting the collection. Acceptable values are:

  • updated_at
  • created_at
tags.keystring
Example:card_type

Filter by the tag's key. For more information, see Tags.

tags.valuestring
Example:business_card

Filter by the tag's value. For more information, see Tags.

updated_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where updated_at is after the given date.

updated_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where updated_at is before the given date.

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

List of Subscription Balance Entry resources

Example response

{
  "_embedded": {
    "subscription_balance_entries": [
      {
        "amount": 5000
      }
    ]
  }
}