Skip to main content

Get Recurring Plan​

Get a recurring plan execution plan for the store

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
Responses
Response Headers
    Schema
      code integer required
      message string required
      data object required
      plan object required
      id string required
      name string
      reference_number string
      customer_uuid string required
      p_business_id string required
      default_payment_token string
      default_collection_method string
      description string
      created_at string required
      updated_at string required
      deleted_at string
      recurring_cycles object[] required
    • Array [
      • id string
      name string required
      state string required
      p_business_id string required
      recurring_plan_id string required
      interval_counts integer
      recurring_billing_config object required
      id string required
      p_business_id string required
      billing_interval_counts integer required
      billing_interval string required
      billing_config_settings string required
      billing_month integer required
      billing_day_of_month integer required
      billing_proration_enabled boolean required
      description string required
      created_at string required
      updated_at string required
      deleted_at null required
      recurring_items object[] required
    • Array [
      • id string required
      label string
      p_business_id string required
      price number required
      quantity integer required
      currency string required
      reference_id string
      description string
      created_at string required
      updated_at string required
      deleted_at string
    • ]
      • billing_amount number required
      discount_amount number
      discount_type string
      default_payment_token string
      default_collection_method string
      payment_retry_day_period integer required
      payment_retry_count integer required
      grace_period integer
      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 required
      updated_at string required
      deleted_at string
    • ]
      • customer object required
      name string
      email string
      phone string
      reference_number string required
      default_payment_method string
      uuid string required
    Loading...