Recurring Plan Presenter

idstringrequired

namestring

reference_numberstring

default_payment_tokenstring

default_collection_methodstring

payment_retry_countnumber

payment_retry_day_periodnumber

grace_periodnumbernullable

creditnumber

redirect_urlstring

notestring

timeout object

timerintegerrequired

urlstring

descriptionstringnullable

created_atstringrequired

updated_atstringrequired

deleted_atstringnullable

recurring_cycles object[]required

Array [

idstring

statestringrequired

recurring_plan_idstringrequired

billing_countinteger

billing_count_createdintegerrequired

recurring_billing_config objectrequired

idstringrequired

billing_intervalstringrequired

billing_typestring

billing_monthinteger

billing_day_of_monthinteger

billing_proration_enabledbooleanrequired

descriptionstring

created_atstring

updated_atstring

deleted_atstringnullable

recurring_items object[]required

Array [

idstringrequired

labelstring

pricenumberrequired

quantityintegerrequired

currencystringrequired

reference_idstring

descriptionstring

created_atstringrequired

updated_atstring

deleted_atstringnullable

]

billing_amountnumber

discount_amountnumber

discount_typestring

previous_cyclestringnullable

next_cyclestringnullable

estimated_start_datestring

start_datestringnullable

estimated_end_datestringnullable

end_datestringnullable

next_execute_timestringnullable

descriptionstringnullable

created_atstringrequired

updated_atstringrequired

deleted_at stringnullable

]

customer object

namestring

emailstring

phonestring

reference_numberstringrequired

default_payment_methodstring

uuidstringrequired

Recurring Plan Presenter

{
  "id": "string",
  "name": "string",
  "reference_number": "string",
  "default_payment_token": "string",
  "default_collection_method": "string",
  "payment_retry_count": 0,
  "payment_retry_day_period": 0,
  "grace_period": 0,
  "credit": 0,
  "redirect_url": "string",
  "note": "string",
  "timeout": {
    "timer": 0,
    "url": "string"
  },
  "description": "string",
  "created_at": "string",
  "updated_at": "string",
  "deleted_at": "string",
  "recurring_cycles": [
    {
      "id": "string",
      "state": "string",
      "recurring_plan_id": "string",
      "billing_count": 0,
      "billing_count_created": 0,
      "recurring_billing_config": {
        "id": "string",
        "billing_interval": "string",
        "billing_type": "string",
        "billing_month": 0,
        "billing_day_of_month": 0,
        "billing_proration_enabled": true,
        "description": "string",
        "created_at": "string",
        "updated_at": "string",
        "deleted_at": "string"
      },
      "recurring_items": [
        {
          "id": "string",
          "label": "string",
          "price": 0,
          "quantity": 0,
          "currency": "string",
          "reference_id": "string",
          "description": "string",
          "created_at": "string",
          "updated_at": "string",
          "deleted_at": "string"
        }
      ],
      "billing_amount": 0,
      "discount_amount": 0,
      "discount_type": "string",
      "previous_cycle": "string",
      "next_cycle": "string",
      "estimated_start_date": "string",
      "start_date": "string",
      "estimated_end_date": "string",
      "end_date": "string",
      "next_execute_time": "string",
      "description": "string",
      "created_at": "string",
      "updated_at": "string",
      "deleted_at ": "string"
    }
  ],
  "customer": {
    "name": "string",
    "email": "string",
    "phone": "string",
    "reference_number": "string",
    "default_payment_method": "string",
    "uuid": "string"
  }
}