Payments: Retrieve All

This documentation entry provides a comprehensive guide to using the "Retrieve All" payments endpoint, including all relevant details about the request, response, and data structures.

Endpoint

GET /api/payments/

Retrieve a list of all payment transactions associated with your account.

Request

HTTP Request

GET https://uptimekeep.com/api/payments/

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.

Query Parameters

Parameter	Type	Description	Default Value
page	Integer	(Optional) The page number to retrieve.	1
results_per_page	Integer	(Optional) Number of results per page. Allowed values: 10, 25, 50, 100, 250, 500, 1000.	25

Example of a request:

curl --request GET \
--url 'https://uptimekeep.com/api/payments/' \
--header 'Authorization: Bearer {api_key}'

Response

A successful response returns a JSON object with the list of payment transactions and associated metadata.

Response Example

{
    "data": [
        {
            "id": 1,
            "plan_id": 1,
            "processor": "stripe",
            "type": "one_time",
            "frequency": "monthly",
            "email": "[email protected]",
            "name": null,
            "total_amount": "4.99",
            "currency": "USD",
            "status": true,
            "date": "2021-03-25 15:08:58"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://uptimekeep.com/api/payments?&page=1",
        "last": "https://uptimekeep.com/api/payments?&page=1",
        "next": null,
        "prev": null,
        "self": "https://uptimekeep.com/api/payments?&page=1"
    }
}

Fields

Data Object

Field	Type	Description
id	Integer	Unique identifier for the payment transaction.
plan_id	Integer	ID of the associated plan.
processor	String	Payment processor used for the transaction (e.g., "stripe").
type	String	Type of payment (e.g., "one_time").
frequency	String	Payment frequency (e.g., "monthly").
email	String	Email address associated with the payment.
name	String	Name associated with the payment, if available.
total_amount	String	Total amount of the transaction.
currency	String	Currency used in the transaction.
status	Boolean	Status of the payment (true for successful, false for failed).
date	String	Date and time of the transaction (in YYYY-MM-DD HH:MM:SS format).

Meta Object

Field	Type	Description
page	Integer	Current page number of the results.
results_per_page	Integer	Number of results per page.
total	Integer	Total number of payment transactions.
total_pages	Integer	Total number of pages available based on the current query.

Links Object

Field	Type	Description
first	String	URL of the first page of results.
last	String	URL of the last page of results.
next	String	URL of the next page of results (if applicable).
prev	String	URL of the previous page of results (if applicable).
self	String	URL of the current page of results.

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code.