---
title: "Get Recurring Sale Details"
method: POST
path: "/API/PaymentPageRequest.svc/RecurringSaleDetails"
---

# Get Recurring Sale Details

`POST /API/PaymentPageRequest.svc/RecurringSaleDetails`

## Request body

- object
  - `RecurringSaleId` string, uuid — Recurring Sale Identifier. **Format:** `UUID` **Default:** No

## Response `200`

Recurring Sale Details Succesful Response

- object
  - `Address` string — Customer Address.
  - `Amount` number, double — Recurring Sale Total Amount.
  - `AuthNum` string — Original Transaction Approval Number.
  - `AutoCharge` boolean — Recurring Auto Charge Settings.
  - `CardDueDate` string — Credit Card Due date (MMYY).
  - `CardNum` string — Credit Card Number.
  - `CardProducer` integer — Credit Card Producer.
  - `ChargeCount` integer — The Recurring Total Number of Succesful Charges.
  - `ChargeDate` string — Last Charge Date
  - `City` string — Customer City.
  - `Comments` string — Customer Comments.
  - `Country` string — Customer Country.
  - `CreationDate` string — Recurring Creation Date.
  - `Currency` integer — Recurring Sale Currency.
  - `CustomerFirstName` string — Customer First Name.
  - `CustomerId` integer — Customer Identifier in Rivhit
  - `CustomerLastName` string — Customer Last Name.
  - `Discount` number, double — Recurring Sale Discount Amount.
  - `EmailAddress` string — Customer Email.
  - `EndDate` string — Recurring Sale End Date.
  - `ExemptVat` boolean — The Payment Document VAT Settings.
  - `FaxNumber` string — Customer Fax Number.
  - `GroupId` string, uuid — Recurring Sale GroupId (Payment Page Identifier).
  - `IdNumber` integer — Customer Id Number.
  - `IpnUrl` string — IPN (Instant Payment Notification) URL.
  - `IsActive` boolean — Recurring Sale Activation Status.
  - `Items` object[]
    - `CatalogNumber` string — Item Catatlog Number.
    - `Description` string — Item Description.
    - `Id` integer — Item Unique Identifier.
    - `Quantity` number, double — Item Quantity.
    - `UnitPrice` number, double — Item Price.
  - `Order` string — Recurring Order Number.
  - `POB` integer — Customer Post Office Box.
  - `PhoneNumber` string — Customer Phone Number.
  - `PhoneNumber2` string — Customer Second Phone Number.
  - `PriceIncludeVat` boolean — Recurring Items Sent With or Without VAT.
  - `ProRata` boolean — Create Recurring Sale with Pro Rata First Charge.
  - `RecurringConcatMonth` integer — Month Number Concatenate to Item Description Settings.
  - `RecurringCycle` integer — Recurring Sale Cycle (Every Day/Week/Month).
  - `RecurringDay` integer — Recurring Charge Day (1-28).
  - `RecurringOffset` integer — Recurring Backword/Forward Total Charge Count.
  - `RecurringSaleCount` integer — Recurring Sale Charge Count Settings (0 = Non Stop).
  - `RecurringStep` integer — Recurring Payment Time Phrase (Every X day/week/month).
  - `Reference` integer — Recurring Reference Number.
  - `StartDate` string — Recurring Start Date.
  - `State` string — Customer State.
  - `Token` string, uuid — Recurring Credit Card Token.
  - `VatNumber` integer — Customer VAT Number.
  - `Zipcode` string — Customer Zip Code.

## Other responses

- `400` — Request Error
- `500` — Internal Server Error

---

[API](https://skmtc.net/rivhit/apis/get-payment-url-22-12.md) · [All operations](https://skmtc.net/rivhit/apis/get-payment-url-22-12/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rivhit/get-payment-url-22-12/versions/ed5261a52458/schema)