---
title: "Get recurring payment details"
method: POST
path: "/recurring/details"
tags: ["Recurring Service"]
---

# Get recurring payment details

`POST /recurring/details`

Retrieves the configuration and status of a recurring payment for the provided recurring ID.

## Request body

- RecurringDetailsRequest
  - `subscriptionId` string, required — Unique subscription identifier associated with the recurring payment.
  - `recurringId` string, required — Unique identifier of the recurring payment.

## Response `200`

Recurring payment details retrieved successfully

- RecurringDetailsResponse
  - `subscriptionId` string — Unique subscription identifier associated with the recurring payment.
  - `recurringId` string — Unique identifier of the recurring payment.
  - `paymentType` 'creditcard' | 'echeck' — Type of payment method.
  - `storedPaymentMethodId` string — Identifier of the stored payment method used for the recurring payment.
  - `item` Item — Item charged on the recurring schedule.
    - `itemKey` string — The item's key
    - `amount` number — The amount to pay for the item
    - `instanceId` string — SKU
    - `attributes` ItemAttribute[] — Additional attributes
      - `receiptDisplay` boolean — Determines whether or not the attribute is displayed on the receipt
      - `attribute` string — Attribute name
      - `value` string — Attribute value
  - `recurringFrequency` 'daily' | 'weekly' | 'monthly' | 'bi_weekly' | 'bi_monthly' | 'annually' — Recurring payment frequency.
  - `recurringStartDate` string, date — Start date of the recurring schedule.
  - `recurringEndDate` string, date — End date of the recurring schedule.
  - `httpStatusCode` integer — HTTP status code.
  - `message` string — Response message.
  - `responseTimestamp` string, date-time — Date and time when the response was generated.

## Other responses

- `400` — Invalid request data
- `401` — Unauthorized. The access token is missing, invalid, or expired.
- `404` — Recurring payment not found
- `500` — Internal server error

---

[API](https://skmtc.dev/civikestpayment/apis/pays-service-api-specifications.md) · [All operations](https://skmtc.dev/civikestpayment/apis/pays-service-api-specifications/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/civikestpayment/pays-service-api-specifications/revisions/e94a116dff94/schema)