# Retrieves a subscription payment history

<span class="api-endpoint">GET {{<a href="#urlbases">baseURL</a>}}/sub-api/v1/subscriptions/{{subscriptionId}}/payments</span>
This endpoint retrieves a history of payments for a specified subscription.

Endpoint: GET /sub-api/v1/subscriptions/{subscriptionId}/payments
Version: V1
Security: Bearer

## Path parameters:

  - `subscriptionId` (string, required)
    <br>Specifies the subscription identifier.

## Query parameters:

  - `page` (integer)
    Specifies the page number of the returned search results.

A page is considered each set of the `pageSize` value.

The maximum page value is the `pageSize` divided by the `total` count rounded up.
The count is zero-based.
For example, if `pageSize` is 50 and the `total` is 130, there are three pages.
The maximum `page` value is 2.

Values above the maximum page value will complete successfully but not return any items.

Example: 0

  - `pageSize` (integer)
    Specifies the number of items for each page of the returned search results.

A page is considered each set of the `pageSize` value.

The maximum page value is the `pageSize` divided by the `total` count rounded up.
The count is zero-based.
For example, if `pageSize` is 50 and the `total` is 130, there are three pages.
The maximum `page` value is 2.

Example: 50

  - `hideCompletedAndPlanned` (boolean)
    Specifies leaving out completed and planned payments from the history list.

The retrieved payment history list could excluded previously completed and planned payments.

If `true`, leaves out completed and planned payments.<br>
If `false`, includes completed and planned payments.
This includes in-progress, failed, pending, or actionable payments.

Example: true

## Response 200 fields (application/json):

  - `id` (string)
    Indicates the subscription identifier.

Example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58

  - `initialExecutionDateTime` (string)
    Indicates the date-time (in an ISO 8601 date-time UTC format) of the subscription's initial execution.

Examples: 2026-02-19T20:24:52.934Z
    Example: 2026-02-19T20:24:52.934Z

  - `statusId` (integer)
    Indicates the subscription status identifier.
Possible values:
| Value | Meaning |
|  --- | --- |
| 1 | Active |
| 2 | Completed |
| 3 | Suspended |
| 4 | Delinquent |
| 5 | Terminated |
| 6 | Deleted |

Example: 2
    Example: 2

  - `status` (string)
    Indicates the subscription status.
Possible values:
| Value | Meaning |
|  --- | --- |
| Active | 1 |
| Completed | 2 |
| Suspended | 3 |
| Delinquent | 4 |
| Terminated | 5 |
| Deleted | 6 |

Example: Completed
    Example: Completed

  - `amount` (number)
    Indicates the payment amount.

Example: 129.99
    Example: 129.99

  - `paymentOrder` (integer)
    Indicates a payment attempt identifier.

Example: 748411
    Example: 748411

  - `attempts` (array)
    Indicates the history of attempting to complete this order.

  - `attempts.id` (string)
    Indicates the subscription identifier.

Example: 35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14
    Example: 35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14

  - `attempts.executionDateTime` (string)
    Indicates the date-time (in an ISO 8601 date-time UTC format) of the subscription's execution.

Examples: 2026-02-19T20:24:52.934Z
    Example: 2026-02-19T20:24:52.934Z

  - `attempts.statusId` (integer)
    Indicates the subscription status identifier.
Possible values:
| Value | Meaning |
|  --- | --- |
| 1 | Active |
| 2 | Completed |
| 3 | Suspended |
| 4 | Delinquent |
| 5 | Terminated |
| 6 | Deleted |

Example: 2
    Example: 2

  - `attempts.status` (string)
    Indicates the subscription status.
Possible values:
| Value | Meaning |
|  --- | --- |
| Active | 1 |
| Completed | 2 |
| Suspended | 3 |
| Delinquent | 4 |
| Terminated | 5 |
| Deleted | 6 |

Example: Completed
    Example: Completed

  - `attempts.transactionStatusId` (integer)

  - `attempts.transactionStatus` (string)

  - `attempts.transactionId` (string)

## Response 400 fields (application/json):

  - `details` (string)
    Indicates details about the error.

Example: Validation failed: -- Email: 'Email' is not a valid email address. Severity: Error
    Example: Validation failed: -- Email: 'Email' is not a valid email address. Severity: Error

  - `statusCode` (integer)
    Specifies the HTTP response status code.
This is the HTTP status code returned by the attempted delivery.
The following is a list of HTTP response status codes that include but are not limited to:
| HTTP Status | Meaning |
|  --- | --- |
| 200 | Delivery succeeded |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Endpoint not found |
| 429 | Rate limited |

Example: 401
    Example: 401

  - `source` (string)
    Indicates the source of the error.
Example: <Service>
    Example: <Service>

  - `exceptionType` (string)
    Indicates the error's exception type.

Example: FluentValidation.ValidationException
    Example: FluentValidation.ValidationException

  - `correlationId` (string)
    Indicates the correlation identifier.

Example: aa6cfcd0-0295-4a4c-b074-8c901f114fef
    Example: aa6cfcd0-0295-4a4c-b074-8c901f114fef

  - `entityId` (string)
    Indicates the entity identifier.
Example:
null

  - `errorCode` (string)
    Indicates the error code.
Example:
null

## Response 404 fields (application/json):

  - `details` (string)

  - `statusCode` (integer)
    Specifies the HTTP response status code.
This is the HTTP status code returned by the attempted delivery.
The following is a list of HTTP response status codes that include but are not limited to:
| HTTP Status | Meaning |
|  --- | --- |
| 200 | Delivery succeeded |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Endpoint not found |
| 429 | Rate limited |

Example: 401
    Example: 401

  - `source` (string)

  - `exceptionType` (string)

  - `correlationId` (string)

  - `entityId` (string)

  - `errorCode` (string)

## Response 500 fields (application/json):

  - `details` (string)

  - `statusCode` (integer)
    Specifies the HTTP response status code.
This is the HTTP status code returned by the attempted delivery.
The following is a list of HTTP response status codes that include but are not limited to:
| HTTP Status | Meaning |
|  --- | --- |
| 200 | Delivery succeeded |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Endpoint not found |
| 429 | Rate limited |

Example: 401
    Example: 401

  - `source` (string)

  - `exceptionType` (string)

  - `correlationId` (string)

  - `entityId` (string)

  - `errorCode` (string)