Init Subscription

POST

{{bill24_domain}}/direct_debit/subscription/init

Bill24 Implement

NOTE

When customer need to subscribe biller need to call to this endpoint for init subscription and get back subscription no for use with sdk or URL for open web subscription page.

Request

Header Params

Content-Type

string

required

Example:

application/json

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer {token}

Body Params application/json

subscription_ref

string

required

A unique reference ID for the subscription.

redirect_url

object

required

web_url

string

required

URL for redirecting users on web-based platforms.

deeplink_url

string

required

URL for deep linking in mobile apps.

consumers

array [object {4}]

required

consumer_code

string

optional

A unique identifier for the consumer.

consumer_name

string

optional

The name of the consumer.

consumer_name_latin

string

optional

Consumer’s name in English.

additional_information

string

optional

Extra details about the consumer.

Example

{
  "subscription_ref": "DD000027",
  "redirect_url": {
    "web_url": "http://{merchant-domain}:3000",
    "deeplink_url": ""
  },
  "consumers": [
    {
      "consumer_code": "C0000001",
      "consumer_name": "នីម",
      "consumer_name_latin": "Nim",
      "additional_information": ""
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://merchantapi-demo.bill24.io/notification/v1/notificationmessage/send{{bill24_domain}}/direct_debit/subscription/init' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "subscription_ref": "DD000027",
    "redirect_url": {
        "web_url": "http://{merchant-domain}:3000",
        "deeplink_url": ""
    },
    "consumers": [
        {
            "consumer_code": "C0000001",
            "consumer_name": "នីម",
            "consumer_name_latin": "Nim",
            "additional_information": ""
        }
    ]
}'

Responses

🟢200Success

application/json

Body

code

string

required

Status Code.

message

string

required

describes the response status.

message_kh

string

required

The Khmer-language version of the response message.

data

object

required

subscription_no

string

required

A unique subscription number assigned.

subscription_link

string

required

A URL that allows users to view or manage their subscription.

Example

{
  "code": "000",
  "message": "success !",
  "message_kh": "ជោគជ័យ! ",
  "data": {
    "subscription_no": "12353454",
    "subscription_link": "https://staging.bill24.io:22034/checkoutv2/141C9AC362C7"
  }
}

Modified at 2025-03-06 07:16:45

Authorization

Inquiry Consumer validate