# The Link object

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes |  |
| `status` | string | yes | One of: `draft`, `open`, `paid`, `expired`. |
| `active` | boolean | yes |  |
| `type` | string | yes | One of: `payment`, `approval`, `basic-subscription`, `advanced-subscription`, `order`, `mandate`, `debit`. |
| `description` | string | yes |  |
| `currency` | string | yes | One of: `AED`, `AUD`, `BGN`, `BRL`, `CAD`, `CHF`, `CZK`, `DKK`, `EUR`, `GBP`, `HKD`, `HUF`, `ILS`, `ISK`, `JPY`, `MXN`, `MYR`, `NOK`, `NZD`, `PHP`, `PLN`, `RON`, `SEK`, `SGD`, `THB`, `TWD`, `USD`, `ZAR`. |
| `amount` | string | no |  |
| `first_amount` | string | no |  |
| `interval` | string | no | One of: `week`, `month`, `quarter`, `year`. |
| `times` | integer | no |  |
| `trial_interval` | string | no |  |
| `reminder_at` | string | no |  |
| `redirect_url_paid` | string | no |  |
| `redirect_url_failed` | string | no |  |
| `expires_at` | string | no |  |
| `created_at` | string | yes |  |
| `url` | string | yes |  |
| `customer` | Customer object | no |  |
| `customer.id` | string | yes |  |
| `customer.number` | string | no |  |
| `customer.first_name` | string | yes |  |
| `customer.last_name` | string | yes |  |
| `customer.email` | string | yes |  |
| `customer.phone` | string | no |  |
| `customer.organization_name` | string | no |  |
| `customer.address` | string | no |  |
| `customer.postal_code` | string | no |  |
| `customer.city` | string | no |  |
| `customer.country` | string | no |  |
| `customer.vat_number` | string | no |  |
| `customer.locale` | string | no | One of: `nl`, `en`, `fr`, `de`, `es`. |
| `customer.mollie_customer_id` | string | no |  |
| `customer.created_at` | string | yes |  |
| `subscription` | Subscription object | no |  |
| `subscription.id` | string | yes |  |
| `subscription.name` | string | yes |  |
| `subscription.status` | string | yes | One of: `draft`, `active`, `paused`, `cancelled`, `completed`. |
| `subscription.start_date` | string | yes |  |
| `subscription.mollie_mandate_id` | string | no |  |
| `subscription.mollie_profile_id` | string | no |  |
| `subscription.next_payment_at` | string | no |  |
| `subscription.next_amount` | string | no |  |
| `subscription.last_payment_created_at` | string | no |  |
| `subscription.resume_at` | string | no |  |
| `subscription.cancel_at` | string | no |  |
| `subscription.customer_portal` | string | no | Can the customer pause and cancel this subscription in the customer portal: inherit follows the customer portal settings, allow and deny overrule them One of: `inherit`, `allow`, `deny`. |
| `subscription.created_at` | string | yes |  |
| `subscription.rules` | array of SubscriptionRules | no |  |
| `subscription.rules[].id` | string | yes |  |
| `subscription.rules[].amount` | string | yes |  |
| `subscription.rules[].currency` | string | yes | One of: `AED`, `AUD`, `BGN`, `BRL`, `CAD`, `CHF`, `CZK`, `DKK`, `EUR`, `GBP`, `HKD`, `HUF`, `ILS`, `ISK`, `JPY`, `MXN`, `MYR`, `NOK`, `NZD`, `PHP`, `PLN`, `RON`, `SEK`, `SGD`, `THB`, `TWD`, `USD`, `ZAR`. |
| `subscription.rules[].interval` | string | yes | One of: `day`, `week`, `month`, `year`. |
| `subscription.rules[].interval_amount` | integer | yes |  |
| `subscription.rules[].day` | integer | yes |  |
| `subscription.rules[].times` | integer | no |  |
| `subscription.rules[].times_done` | integer | yes |  |
| `subscription.customer` | object | no |  |

```json
{
    "id": "lnk_abc123",
    "status": "open",
    "active": true,
    "type": "payment",
    "description": "Monthly subscription - Pro plan",
    "currency": "EUR",
    "amount": "29.95",
    "first_amount": "14.95",
    "interval": "month",
    "times": 12,
    "trial_interval": "14 days",
    "reminder_at": "2025-02-01 09:00:00",
    "redirect_url_paid": "https://example.com/thank-you",
    "redirect_url_failed": "https://example.com/failed",
    "expires_at": "2025-06-01",
    "created_at": "2025-01-15 10:30:00",
    "url": "https://rcur.nl/pay/lnk_abc123",
    "customer": {
        "id": "abc123def456",
        "number": "CUST-001",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john@example.com",
        "phone": "+31612345678",
        "organization_name": "Acme B.V.",
        "address": "Keizersgracht 1",
        "postal_code": "1015AA",
        "city": "Amsterdam",
        "country": "NL",
        "vat_number": "NL123456789B01",
        "locale": "nl",
        "mollie_customer_id": "cst_abc123",
        "created_at": "2025-01-15 10:30:00"
    },
    "subscription": {
        "id": "sub_abc123",
        "name": "Monthly Premium",
        "status": "active",
        "start_date": "2025-01-01",
        "mollie_mandate_id": "mdt_abc123",
        "mollie_profile_id": "pfl_abc123",
        "next_payment_at": "2025-02-01",
        "next_amount": "29.99",
        "last_payment_created_at": "2025-01-01 10:00:00",
        "resume_at": "2025-03-01",
        "cancel_at": "2025-12-31",
        "customer_portal": "inherit",
        "created_at": "2025-01-01 10:00:00",
        "rules": [
            {
                "id": "rule_abc123",
                "amount": "29.99",
                "currency": "EUR",
                "interval": "month",
                "interval_amount": 1,
                "day": 1,
                "times": 12,
                "times_done": 3
            }
        ],
        "customer": {}
    }
}
```