# Response Recurring

## Structure

`ResponseRecurring`

## Fields

| Name | Type | Tags | Description | Getter | Setter |
|  --- | --- | --- | --- | --- | --- |
| `type` | [`?string(Type59Enum)`](../../doc/models/type-59-enum.md) | Optional | Resource Type<br>**Default**: `Type59Enum::RECURRING` | getType(): ?string | setType(?string type): void |
| `data` | [`?Data16`](../../doc/models/data-16.md) | Optional | - | getData(): ?Data16 | setData(?Data16 data): void |

## Example (as JSON)

```json
{
  "type": "Recurring",
  "data": {
    "account_vault_id": "account_vault_id6",
    "token_id": "token_id4",
    "contact_id": "contact_id4",
    "account_vault_api_id": "account_vault_api_id4",
    "token_api_id": "token_api_id6",
    "_joi": {
      "conditions": {
        "method": "xor",
        "values": "account_vault_api_id"
      }
    },
    "active": false,
    "description": "description0",
    "end_date": "end_date0",
    "installment_total_count": 32,
    "interval": 190,
    "interval_type": "m",
    "location_id": "location_id4",
    "notification_days": 94,
    "payment_method": "cc",
    "product_transaction_id": "product_transaction_id4",
    "recurring_id": "recurring_id4",
    "recurring_api_id": "recurring_api_id2",
    "start_date": "start_date4",
    "status": "ended",
    "transaction_amount": 88,
    "terms_agree": false,
    "terms_agree_ip": "terms_agree_ip6",
    "recurring_c1": "recurring_c18",
    "recurring_c2": "recurring_c20",
    "recurring_c3": "recurring_c32",
    "send_to_proc_as_recur": false,
    "tags": [
      {
        "location_id": "location_id4",
        "title": "title6",
        "id": "id0",
        "created_ts": 2,
        "modified_ts": 78
      },
      {
        "location_id": "location_id4",
        "title": "title6",
        "id": "id0",
        "created_ts": 2,
        "modified_ts": 78
      },
      {
        "location_id": "location_id4",
        "title": "title6",
        "id": "id0",
        "created_ts": 2,
        "modified_ts": 78
      }
    ],
    "secondary_amount": 4,
    "currency": "currency0",
    "id": "id0",
    "next_run_date": "next_run_date8",
    "created_ts": 114,
    "modified_ts": 190,
    "recurring_type_id": "o",
    "installment_amount_total": 84,
    "created_user_id": "created_user_id2",
    "log_emails": [
      {
        "subject": "subject2",
        "body": "body4",
        "source_address": "source_address8",
        "return_path": "return_path6",
        "provider_id": "provider_id0",
        "domain_id": "domain_id0",
        "reason_sent": "reason_sent0",
        "reason_model": "User",
        "reason_model_id": "reason_model_id0",
        "reply_to": "reply_to0",
        "id": "id8",
        "created_ts": 244
      }
    ],
    "contact": {
      "location_id": "location_id6",
      "account_number": "account_number2",
      "contact_api_id": "contact_api_id2",
      "first_name": "first_name2",
      "last_name": "last_name0",
      "cell_phone": "cell_phone8",
      "balance": 117.46,
      "address": {
        "city": "city6",
        "state": "state2",
        "postal_code": "postal_code8",
        "country": "US",
        "street": "street6"
      },
      "company_name": "company_name8",
      "header_message": "header_message8",
      "date_of_birth": "date_of_birth4",
      "email_trx_receipt": false,
      "home_phone": "home_phone2",
      "office_phone": "office_phone6",
      "office_phone_ext": "office_phone_ext8",
      "header_message_type": 190,
      "update_if_exists": 1,
      "contact_c1": "contact_c14",
      "contact_c2": "contact_c26",
      "contact_c3": "contact_c36",
      "parent_id": "parent_id8",
      "email": "email4",
      "id": "id2",
      "created_ts": 250,
      "modified_ts": 70,
      "active": false,
      "created_user_id": "created_user_id4"
    },
    "account_vault": {
      "account_holder_name": "account_holder_name0",
      "account_vault_api_id": "account_vault_api_id4",
      "token_api_id": "token_api_id4",
      "accountvault_c1": "accountvault_c14",
      "accountvault_c2": "accountvault_c22",
      "accountvault_c3": "accountvault_c34",
      "token_c1": "token_c18",
      "token_c2": "token_c28",
      "token_c3": "token_c30",
      "ach_sec_code": "POP",
      "billing_address": {
        "postal_code": "postal_code0",
        "street": "street8",
        "city": "city2",
        "state": "state6",
        "phone": "phone2",
        "country": "country2"
      },
      "contact_id": "contact_id4",
      "customer_id": "customer_id8",
      "identity_verification": {
        "dl_state": "dl_state8",
        "dl_number": "dl_number4",
        "ssn4": "ssn42",
        "dob_year": "dob_year2"
      },
      "location_id": "location_id4",
      "previous_account_vault_api_id": "previous_account_vault_api_id2",
      "previous_token_api_id": "previous_token_api_id2",
      "previous_account_vault_id": "previous_account_vault_id8",
      "previous_token_id": "previous_token_id4",
      "previous_transaction_id": "previous_transaction_id4",
      "account_number": "String1",
      "terms_agree": false,
      "terms_agree_ip": "terms_agree_ip6",
      "title": "title6",
      "_joi": {
        "conditions": {
          "method": "oxor",
          "values": "token_api_id"
        }
      },
      "id": "id0",
      "account_type": "account_type4",
      "active": false,
      "cau_summary_status_id": 2,
      "created_ts": 122,
      "e_serial_number": "e_serial_number6",
      "e_track_data": "e_track_data8",
      "e_format": "e_format6",
      "e_keyed_data": "e_keyed_data4",
      "expiring_in_months": 238,
      "exp_date": "exp_date8",
      "first_six": "first_six4",
      "has_recurring": false,
      "last_four": "last_four4",
      "modified_ts": 46,
      "payment_method": "cc",
      "ticket": "ticket6",
      "track_data": "track_data8",
      "created_user_id": "created_user_id2",
      "cau_last_updated_ts": 40,
      "card_bin": "card_bin6",
      "routing_number": "routing_number4"
    },
    "created_user": {
      "account_number": "account_number6",
      "branding_domain_url": "branding_domain_url4",
      "cell_phone": "cell_phone2",
      "company_name": "company_name2",
      "contact_id": "contact_id8",
      "date_of_birth": "date_of_birth8",
      "domain_id": "domain_id8",
      "email": "email0",
      "email_trx_receipt": false,
      "home_phone": "home_phone6",
      "first_name": "first_name6",
      "last_name": "last_name4",
      "locale": "locale4",
      "office_phone": "office_phone0",
      "office_ext_phone": "office_ext_phone0",
      "primary_location_id": "primary_location_id6",
      "requires_new_password": "requires_new_password8",
      "terms_condition_code": "terms_condition_code2",
      "tz": "tz8",
      "ui_prefs": {
        "entry_page": "entry_page8",
        "page_size": 74,
        "report_export_type": "xls",
        "process_method": "virtual_terminal",
        "default_terminal": "default_terminal0"
      },
      "username": "username6",
      "user_api_key": "user_api_key2",
      "user_hash_key": "user_hash_key0",
      "user_type_code": 300,
      "password": "password0",
      "zip": "zip0",
      "location_id": "location_id0",
      "contact_api_id": "contact_api_id8",
      "primary_location_api_id": "primary_location_api_id8",
      "status_code": 2,
      "api_only": false,
      "is_invitation": false,
      "address": {
        "city": "city6",
        "state": "state2",
        "postal_code": "postal_code8",
        "country": "US",
        "street": "street6"
      },
      "id": "id6",
      "status": false,
      "login_attempts": 52,
      "last_login_ts": 162,
      "created_ts": 232,
      "modified_ts": 52,
      "created_user_id": "created_user_id8",
      "terms_accepted_ts": 56,
      "terms_agree_ip": "terms_agree_ip2",
      "current_date_time": "current_date_time6",
      "current_login_ip": "current_login_ip4",
      "current_login": 72,
      "sftp_access": false,
      "log_api_response_body_ts": 10
    },
    "signature": {
      "signature": "signature6",
      "resource": "Recurring",
      "resource_id": "resource_id4",
      "id": "id8",
      "created_ts": 80,
      "modified_ts": 4
    },
    "payment_schedule": [
      "payment_schedule8"
    ],
    "location": {
      "id": "id4",
      "created_ts": 254,
      "modified_ts": 178,
      "account_number": "account_number6",
      "address": {
        "city": "city6",
        "state": "state2",
        "postal_code": "postal_code8",
        "country": "US",
        "street": "street6",
        "street2": "street22"
      },
      "branding_domain_id": "branding_domain_id8",
      "contact_email_trx_receipt_default": false,
      "default_ach": "default_ach8",
      "default_cc": "default_cc6",
      "email_reply_to": "email_reply_to6",
      "fax": "fax0",
      "location_api_id": "location_api_id4",
      "location_api_key": "location_api_key2",
      "location_c1": "location_c10",
      "location_c2": "location_c20",
      "location_c3": "location_c32",
      "name": "name4",
      "office_phone": "office_phone2",
      "office_ext_phone": "office_ext_phone8",
      "tz": "tz4",
      "parent_id": "parent_id0",
      "show_contact_notes": false,
      "show_contact_files": false,
      "created_user_id": "created_user_id4",
      "location_type": "hierarchy",
      "ticket_hash_key": "ticket_hash_key6"
    },
    "product_transaction": {
      "processor_version": "processor_version4",
      "industry_type": "lodging",
      "title": "title2",
      "payment_method": "ach",
      "processor": "fortisach",
      "mcc": "mcc6",
      "tax_surcharge_config": 2,
      "terminal_id": "terminal_id2",
      "partner": "Frontier",
      "product_ach_pv_store_id": "product_ach_pv_store_id0",
      "invoice_adjustment_title": "invoice_adjustment_title8",
      "location_id": "location_id0",
      "location_api_id": "location_api_id6",
      "billing_location_api_id": "billing_location_api_id8",
      "portfolio_id": "portfolio_id6",
      "portfolioValidationRule": "portfolioValidationRule0",
      "sub_processor": "sub_processor0",
      "surcharge": {
        "key1": "val1",
        "key2": "val2"
      },
      "processor_data": {
        "key1": "val1",
        "key2": "val2"
      },
      "vt_clerk_number": false,
      "vt_billing_phone": false,
      "vt_enable_tip": false,
      "ach_allow_debit": false,
      "ach_allow_credit": false,
      "ach_allow_refund": false,
      "vt_cvv": false,
      "vt_street": false,
      "vt_zip": false,
      "vt_order_num": false,
      "vt_enable": false,
      "receipt_show_contact_name": false,
      "display_avs": false,
      "card_type_visa": false,
      "card_type_mc": false,
      "card_type_disc": false,
      "card_type_amex": false,
      "card_type_diners": false,
      "card_type_jcb": false,
      "invoice_location": false,
      "allow_partial_authorization": false,
      "allow_recurring_partial_authorization": false,
      "auto_decline_cvv": false,
      "auto_decline_street": false,
      "auto_decline_zip": false,
      "split_payments_allow": false,
      "vt_show_custom_fields": false,
      "receipt_show_custom_fields": false,
      "vt_override_sales_tax_allowed": false,
      "vt_enable_sales_tax": false,
      "vt_require_zip": false,
      "vt_require_street": false,
      "auto_decline_cavv": false,
      "merchant_id": "merchant_id6",
      "receipt_header": "receipt_header8",
      "receipt_footer": "receipt_footer0",
      "receipt_add_account_above_signature": "receipt_add_account_above_signature8",
      "receipt_add_recurring_above_signature": "receipt_add_recurring_above_signature8",
      "receipt_vt_above_signature": "receipt_vt_above_signature6",
      "default_transaction_type": "debit",
      "username": "username4",
      "password": "password0",
      "current_batch": 13.8,
      "dup_check_per_batch": "dup_check_per_batch2",
      "agent_code": "agent_code4",
      "paylink_allow": false,
      "quick_invoice_allow": false,
      "level3_allow": false,
      "payfac_enable": false,
      "sales_office_id": "sales_office_id0",
      "hosted_payment_page_max_allowed": 223.28,
      "hosted_payment_page_allow": false,
      "surcharge_id": "surcharge_id8",
      "level3_default": {
        "key1": "val1",
        "key2": "val2"
      },
      "cau_subscribe_type_id": 1,
      "cau_account_number": "cau_account_number6",
      "location_billing_account_id": "location_billing_account_id4",
      "product_billing_group_id": "product_billing_group_id6",
      "account_number": "account_number4",
      "run_avs_on_accountvault_create": false,
      "accountvault_expire_notification_email_enable": false,
      "debit_allow_void": false,
      "quick_invoice_text_to_pay": false,
      "authentication_code": "authentication_code8",
      "sms_enable": false,
      "vt_show_currency": false,
      "receipt_show_currency": false,
      "allow_blind_refund": false,
      "vt_show_company_name": false,
      "receipt_show_company_name": false,
      "bank_funded_only": false,
      "require_cvv_on_keyed_cnp": false,
      "require_cvv_on_tokenized_cnp": false,
      "show_secondary_amount": false,
      "allow_secondary_amount": false,
      "show_google_pay": false,
      "show_apple_pay": false,
      "id": "id6",
      "receipt_logo": "receipt_logo8",
      "active": false,
      "tz": "tz2",
      "currency_code": 89.52,
      "current_stan": 34.58,
      "created_ts": 84,
      "modified_ts": 8,
      "created_user_id": "created_user_id8",
      "modified_user_id": "modified_user_id2",
      "product_transaction_api_id": "product_transaction_api_id4",
      "transaction_amount_notification_threshold": 194,
      "is_secondary_amount_allowed": false,
      "batch_risk_config": {
        "key1": "val1",
        "key2": "val2"
      },
      "fortis_id": "fortis_id0",
      "product_billing_group_code": "product_billing_group_code6",
      "cau_subscribe_type_code": 2,
      "merchant_code": "merchant_code8"
    },
    "next_run_date_min": "next_run_date_min8",
    "next_run_date_max": "next_run_date_max2",
    "all_tags": [
      {
        "location_id": "location_id8",
        "title": "title0",
        "id": "id4",
        "created_ts": 12,
        "modified_ts": 192
      }
    ],
    "changelogs": [
      {
        "id": "id0",
        "created_ts": 104,
        "action": "action2",
        "model": "model8",
        "model_id": "model_id0",
        "user_id": "user_id8",
        "changelog_details": [
          {
            "id": "id4",
            "changelog_id": "changelog_id6",
            "field": "field8",
            "old_value": "old_value8"
          }
        ],
        "user": {
          "id": "id0",
          "username": "username0",
          "first_name": "first_name0",
          "last_name": "last_name8"
        }
      },
      {
        "id": "id0",
        "created_ts": 104,
        "action": "action2",
        "model": "model8",
        "model_id": "model_id0",
        "user_id": "user_id8",
        "changelog_details": [
          {
            "id": "id4",
            "changelog_id": "changelog_id6",
            "field": "field8",
            "old_value": "old_value8"
          }
        ],
        "user": {
          "id": "id0",
          "username": "username0",
          "first_name": "first_name0",
          "last_name": "last_name8"
        }
      }
    ],
    "forecast": {
      "id": "id8",
      "recurring_id": "recurring_id8",
      "recurring_type": 72.94,
      "amount": 72.1,
      "month": "month8",
      "created_ts": 80,
      "modified_ts": 4
    },
    "recurring_splits": [
      {
        "contact_id": "contact_id8",
        "amount": "amount8",
        "id": "id6",
        "created_ts": 86,
        "created_user_id": "created_user_id8"
      },
      {
        "contact_id": "contact_id8",
        "amount": "amount8",
        "id": "id6",
        "created_ts": 86,
        "created_user_id": "created_user_id8"
      },
      {
        "contact_id": "contact_id8",
        "amount": "amount8",
        "id": "id6",
        "created_ts": 86,
        "created_user_id": "created_user_id8"
      }
    ]
  }
}
```