Skip to main content
GET
Retrieve Payment Contract

Scheduled Payments Guide

Complete guide with examples, contract lifecycle and timezone handling

Path Parameters

id
string<uuid>
required

Contract ID

Response

OK

Full output model for payment contract details

tokenId
string | null

Reference to tokenized payment method

chargeRequestData
object

Charge request data for scheduled payments (excludes PAN/CVV which come from token)

merchantTimezone
string | null

Merchant timezone (IANA format, e.g., "America/New_York")

cardholderTimezone
string | null

Cardholder timezone (IANA format, e.g., "America/New_York")

metadata
string | null

Optional custom metadata (JSON)

template
object

Brief template info for contract output

id
string<uuid>

Unique identifier

templateId
string<uuid>

Reference to template this contract is based on

templateName
string | null

Template name

name
string | null

User-friendly contract name

startDate
string<date-time>

When payments should begin

endDate
string<date-time> | null

Optional end date

maxOccurrences
integer<int32> | null

Optional maximum number of payments

currentOccurrences
integer<int32>

Number of successful payments executed

nextPaymentDate
string<date-time> | null

Next scheduled payment date

status
enum<string>

Status of a payment contract

Available options:
Active,
Paused,
Cancelled,
Completed
createdAt
string<date-time>

Creation timestamp

updatedAt
string<date-time>

Last update timestamp

lastExecutedAt
string<date-time> | null

Timestamp of last successful payment execution