Skip to main content

AccountsResponse

Response schema for a list of accounts

data object[]required

List of accounts

  • Array [
  • created_atstring<date-time>required

    Time at which the object was created.

    idstringrequired

    Unique identifier for the object.

    Possible values: Value must match regular expression ^acct_\w{12}$

    namestringrequired

    The account's name.

    objectstringrequired

    String representing the object's type.

    Possible values: [account]

    updated_atstring<date-time>required

    Time at which the object was last updated.

  • ]
  • meta objectrequired

    Metadata for paginated responses

    current_pageintegerrequired

    Current page number

    page_sizeintegerrequired

    Number of records per page

    total_countintegerrequired

    Total number of records

    total_pagesintegerrequired

    Total number of pages

    AccountsResponse
    {
    "data": [
    {
    "created_at": "2017-09-12T12:34:55Z",
    "id": "acct_d025a96ac0c6",
    "name": "Tender Medical",
    "object": "account",
    "updated_at": "2017-09-13T10:11:12Z"
    }
    ],
    "meta": {
    "current_page": 1,
    "page_size": 10,
    "total_count": 50,
    "total_pages": 5
    }
    }