Skip to main content

Create Recurring Billing Config​

Create a recycling plan configuration

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
    config object required
    interval_count number required

    The number of intervals between recurring billings. For example, billing_interval=monthly and interval_count=3 , then system bills every 3 months. 

    If billing_interval=monthly and interval_count=1 , then system bills every 1 month.

    If billing_interval=yearly and interval_count=1 , then system bills every 1 year.

    billing_interval string required

    The frequency at which a recurring invoice is billed to the customer. Single option choice: [daily], [weekly], [monthly], [yearly] [daily] - The invoice will be billed on daily basis [weekly] - The invoice will be billed on weekly basis [monthly] - The invoice will be billed on monthly basis [yearly] - The invoice will be billed on annually basis

    billing_type string required

    Possible values: [automated, customized]

    This is to determine if the system will apply automated billing date/time based on the current date/time of when the user subscribes to the recurring plan. Single option choice: [automated], [customized] [automated]: the system will select the current calendar date/time to be the start date of the recurring billing cycle. [customized]: if user chooses this option, depending on which data is set in  billing_interval , they will need to configure  billing_month ;  billing_day_of_month  . This option is only applicable for when billing_interval = monthly/yearly .

    billing_month number

    The data is as below:

    • 1 = January
    • 2 = February
    • 3 = March
    • 4 = April
    • 5 = May
    • 6 = June
    • 7 = July
    • 8 = August
    • 9 = September
    • 10 = October
    • 11 = November
    • 12 = December
    billing_day_of_month number

    The data is as below:

    • 1 = 1st of that month
    • 2 = 2nd of that month
    • 3 = 3rd of that month
    • 4 = 4th of that month
    • 5 = 5th of that month
    • 6 = 6th of that month
    • 7 = 7th of that month
    • 8 = 8th of that month
    • 9 = 9th of that month
    • 10 = 10th of that month
    • 11 = 11th of that month
    • 12 = 12th of that month
    • 13 = 13th of that month
    • 14 = 14th of that month
    • 15 = 15th of that month
    • 16 = 16th of that month
    • 17 = 17th of that month
    • 18 = 18th of that month
    • 19 = 19th of that month
    • 20 = 20th of that month
    • 21 = 21st of that month
    • 22 = 22nd of that month
    • 23 = 23rd of that month
    • 24 = 24th of that month
    • 25 = 25th of that month
    • 26 = 26th of that month
    • 27 = 27th of that month
    • 28 = 28th of that month
    • 29 = 29th of that month
    • 30 = 30th of that month
    • 31 = 31st of that month (if there is no 31st in a month, then automatically default to 30th/29th/28th respecitvely)
    billing_proration_enabled boolean required

    This data field is let the system knows if needs to calculate prorated amount, if the customer is entering a recurring cycle that is not a full cycle period. For example, user starts the subscription on 1st April 2024, but the billing cycle is billing_interval= monthly and interval_count = 1 , and also  billing_day_of_month= 31 . If  billing_proration_enabled= False, then the system will calculate the payment to be paid from 31st March 2024 - 30th April 2024 (since there is no 31st April). The billing amount will be full amount expected to be paid in that cycle. The system will issue a billing invoice for customer to pay for recurring period of 1st April 2024 - 30th April 2024. The invoice’s billing start date will be 1st April 2024 00:00:00, and this should consider as one count for recurring_cycles.billing_count

    description string
Responses
Response Headers
    Schema
      code integer required
      message string required
      data object required
      config object required
      id string required
      interval_count integer
      billing_interval string required
      billing_type string required
      billing_month integer
      billing_day_of_month integer
      billing_proration_enabled boolean
      description string
      created_at string required
      updated_at string required
      deleted_at string nullable
    Loading...