Skip to main content
GET
cURL
Retrieve a recurring series by the required recurring_id query parameter. The response includes its configuration, payment instrument, payer, pending future transactions, and completed transactions.

Authorizations

x-api-key
string
header
required

Path Parameters

terminal_friendly_id
string
required

The unique identifier of the terminal.

Required string length: 6
Pattern: ^[\dA-Za-z]{6}$

Query Parameters

recurring_id
string
required

The recurring series identifier.

Required string length: 8
Pattern: ^[\dA-Za-z]{8}$

Response

Default Response

recurring_id
string
required

The recurring series identifier.

Required string length: 8
Pattern: ^[\dA-Za-z]{8}$
order_id
string
required

The order linked to this recurring series.

Required string length: 8
Pattern: ^[\dA-Za-z]{8}$
status
enum<string>
required
Available options:
active,
paused,
cancelled,
completed
recurring
object
required
payment_instrument
object
required
payer
object
required
future_transactions
object[]
required
completed_transactions
object[]
required