---
title: "Get recurring items"
method: POST
path: "/recurring/subscription"
tags: ["Recurring Service"]
---

# Get recurring items

`POST /recurring/subscription`

Retrieves all the recurring payment items associated with a subscriptionId.

## Request body

- RecurringSubscriptionRequest
  - `subscriptionId` string, required — Unique subscription identifier associated with the recurring payment.
  - `status` 'active' | 'cancel' | 'all' — Optional recurring payment status. Default is active

## Response `200`

Retrived the recurring payment details successfully

- RecurringSubscriptionResponse
  - `subscriptionId` string — Unique subscription identifier associated with the recurring payment.
  - `httpStatusCode` integer — HTTP status code.
  - `message` string — Response message.
  - `responseTimestamp` string, date-time — Date and time when the response was generated.
  - `recurringItems` RecurringSubscriptionDetails[] — All recurring payment details associated with subscriptionId.
    - `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.
    - `recurringStatus` string — Recurring payment Status
    - `cancelReason` string — Cancel Reason
    - `cancelReasonText` string — Cancel Reason Text
    - `cancelledDate` string, date — Cancelled Date
    - `item` PaymentItem
      - `itemKey` string
      - `description` string
      - `amount` number
      - `instanceId` string
      - `attributes` ItemAttribute[]
        - `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.
    - `nextPaymentDate` string, date — Next recurring payment date.
    - `createDate` string, date — Date that the recurring payment was created.

## Other responses

- `400` — Invalid request data
- `404` — SubscriptionId 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)