Get a Recurrent Payment

Get a Recurrent Payment by ID

GET /v1/recurrent_payments/<recurrent_payment_id>

Headers

Name	Value
x-api-key	<your api key>
x-api-secret	<your api secret>

Response

200

{
    "id": "gRV8xTZHPv9lNxSLPw",
    "type": "SUBSCRIPTION",
    "amount": 16.9,
    "currency": "USD",
    "gross_amount": 14,
    "gross_total_amount": null,
    "interval_count": 12,
    "interval_type": "MONTH",
    "signup_fee_amount": 5,
    "trial_interval_count": 15,
    "trial_interval_type": "DAY"
    "initial_date": "2025-03-12T01:40:52Z",
    "created_at": "2025-03-12T01:25:52Z",
    "updated_at": "2025-04-16T01:28:11Z",
    "status": "ACTIVE",
    "title": "Test subscription",
    "user_id": "014",
    "origin": "PAYMENT_LINK",
    "external_id": "1234",
    "payer": {
        "email": "[e-mail]",
        "first_name": "Joan",
        "last_name": "Kohler",
        "phone_number": "[phone]"
    }
}

400 | 404 | 500

{
    "messages": [
        "error message"
    ],
    "code": "error code"
}