Skip to main content
GET
List payment methods

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Response

Success

schema_version
string

Version of this payload's shape.

account_id
integer

The account.

payment_methods
object[]

Cards on file, as the payment provider describes them — brand, last four, expiry.

default_payment_method_id
string | null

Which one is charged by default.

auto_top_up_ready
boolean

Whether there is a usable card for automatic top-ups. This is the field to check before offering the setting.

freshness
object

Where this answer came from and how current it is. Billing reads several systems, so every response says which one it used — treat state other than fresh as a reason to be careful with the numbers rather than a failure.