Skip to main content

Update Recurring Plan​

Update the basic information of Recurring Plan

Path Parameters
    id string required
Header Parameters
    Nonce string required

    random 16 bytes alphanumerics

    Credential string required

    Please follow the OpenAPI authentication section

    Example: d900da8b-6e16-4a85-8a66-05d29ac53f24/20240501120123/Wonder-RSA-SHA256
    Signature string required

    Please follow the OpenAPI authentication section

    Example: lM42cgyuLS98Dieydc8K2OD3KwYkOXibpV9pFvr/R0i/830M/FPKUKbav2UBBN3M3EdPk/PpvKQlvBNT+NbEg20CKuiDTZWDc3r7KiA1pdZsui/57XCVhC2s01W8jEM+G5lS362+p8+E0K6UKQDrJMyVpbDT31XSkSJIxae+uDi2nJr4DnIkemeU2LlNDRPPGe9NeX7z3B3N3LwIiQgKMyauPqAjro0UrZykQM9pv4UySRSU2cT8EcjQmyKxbzyuR2A47PyeodJvotlIthdfCHIxG52D06tpRJlRVbUdvxSg14bFiPbr3FwCvruZlbR15gOanJCqE4wp4fC8qEXXsg==
    Content-type string required
    Example: application/json
    x-request-id string
    Example: d900da8b-6e16-4a85-8a66-05d29ac53f24
Request Body
    plan object
    name string
    default_collection_method string
    payment_retry_count integer
    payment_retry_day_period integer
    callback_url string
Responses
Response Headers
    Schema
      code integer required
      message string required
      data object required
      plan object required
      id string required
      name string
      reference_number string
      default_payment_token string
      default_collection_method string
      payment_retry_count number
      payment_retry_day_period number
      grace_period number
      credit number
      description string
      created_at string required
      updated_at string required
      deleted_at string nullable
      recurring_cycles object[] required
    • Array [
      • id string
      state string required
      recurring_plan_id string required
      billing_count integer
      billing_count_created integer required
      recurring_billing_config object required
      id string required
      billing_interval string required
      billing_type string
      billing_month integer
      billing_day_of_month integer
      billing_proration_enabled boolean required
      description string
      created_at string
      updated_at string
      deleted_at string nullable
      recurring_items object[] required
    • Array [
      • id string required
      label string
      price number required
      quantity integer required
      currency string required
      reference_id string
      description string
      created_at string required
      updated_at string
      deleted_at string nullable
    • ]
      • billing_amount number required
      discount_amount number
      discount_type string
      previous_cycle string nullable
      next_cycle string nullable
      estimated_start_date string
      start_date string nullable
      estimated_end_date string
      end_date string nullable
      next_execute_time string nullable
      description string
      created_at string required
      updated_at string required
      deleted_at string nullable
    • ]
      • customer object
      name string
      email string
      phone string
      reference_number string required
      default_payment_method string
      uuid string required
      current_order object
      amount number
      paid_total number
      currency string
      order_number string
      reference_number string
      state string
      correspondence_state string
      auth_code string
      default_payment_token string
      default_collection_method string
      current_payment_link string
    Loading...