Billing Admin

Endpoint

Billing plan, coupon, add-on, and analytics management (super-admin only)

List all billing plans

GET

https://api-chat.bara.my.id

/api/billing/admin/plans

Returns all plans (active and inactive). Requires super-admin auth.

List all billing plans › Responses

200

Array of billing plans

object[]

id

string · uuid · required

name

string · required

slug

string · required

currency

string · required

base_price_monthly

integer · int64 · required

base_price_annual

integer · int64 · required

per_agent_price

integer · int64 · required

overage_message_price

integer · int64 · required

limits

object · required

Plan resource limits (max_agents, max_contacts, max_messages_month, max_channels, max_ai_agents)

features

object · required

Feature flags (ai_agent, api_access, dedicated_support)

is_active

boolean · required

sort_order

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

Create a billing plan

POST

https://api-chat.bara.my.id

/api/billing/admin/plans

Defaults: currency=IDR, annual_price=monthly*10, sort_order=0.

Create a billing plan › Request Body

name

string · required

slug

string · required

base_price_monthly

integer · int64 · required

per_agent_price

integer · int64 · required

overage_message_price

integer · int64 · required

limits

object · required

features

object · required

currency

string

Default: IDR

base_price_annual

integer · int64

sort_order

integer

Create a billing plan › Responses

200

Created billing plan

id

string · uuid · required

name

string · required

slug

string · required

currency

string · required

base_price_monthly

integer · int64 · required

base_price_annual

integer · int64 · required

per_agent_price

integer · int64 · required

overage_message_price

integer · int64 · required

limits

object · required

Plan resource limits (max_agents, max_contacts, max_messages_month, max_channels, max_ai_agents)

features

object · required

Feature flags (ai_agent, api_access, dedicated_support)

is_active

boolean · required

sort_order

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

POST/api/billing/admin/plans

curl --request POST \
  --url https://api-chat.bara.my.id/api/billing/admin/plans \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "slug": "slug",
  "currency": "IDR",
  "base_price_monthly": 0,
  "base_price_annual": 0,
  "per_agent_price": 0,
  "overage_message_price": 0,
  "limits": {},
  "features": {},
  "sort_order": 0
}
'

shell

Example Request Body

{
  "name": "name",
  "slug": "slug",
  "currency": "IDR",
  "base_price_monthly": 0,
  "base_price_annual": 0,
  "per_agent_price": 0,
  "overage_message_price": 0,
  "limits": {},
  "features": {},
  "sort_order": 0
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "slug": "slug",
  "currency": "IDR",
  "base_price_monthly": 0,
  "base_price_annual": 0,
  "per_agent_price": 0,
  "overage_message_price": 0,
  "limits": {},
  "features": {},
  "is_active": true,
  "sort_order": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get a billing plan by ID

GET

https://api-chat.bara.my.id

/api/billing/admin/plans/{id}

Get a billing plan by ID › path Parameters

id

string · uuid · required

Get a billing plan by ID › Responses

Billing plan details

id

string · uuid · required

name

string · required

slug

string · required

currency

string · required

base_price_monthly

integer · int64 · required

base_price_annual

integer · int64 · required

per_agent_price

integer · int64 · required

overage_message_price

integer · int64 · required

limits

object · required

Plan resource limits (max_agents, max_contacts, max_messages_month, max_channels, max_ai_agents)

features

object · required

Feature flags (ai_agent, api_access, dedicated_support)

is_active

boolean · required

sort_order

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

Delete a billing plan

DELETE

https://api-chat.bara.my.id

/api/billing/admin/plans/{id}

Delete a billing plan › path Parameters

id

string · uuid · required

Delete a billing plan › Responses

Deletion confirmation

deleted

boolean

Update a billing plan

PATCH

https://api-chat.bara.my.id

/api/billing/admin/plans/{id}

Update a billing plan › path Parameters

id

string · uuid · required

Update a billing plan › Request Body

name

string

slug

string

currency

string

base_price_monthly

integer · int64

base_price_annual

integer · int64

per_agent_price

integer · int64

overage_message_price

integer · int64

limits

object

features

object

is_active

boolean

sort_order

integer

Update a billing plan › Responses

Updated billing plan

id

string · uuid · required

name

string · required

slug

string · required

currency

string · required

base_price_monthly

integer · int64 · required

base_price_annual

integer · int64 · required

per_agent_price

integer · int64 · required

overage_message_price

integer · int64 · required

limits

object · required

Plan resource limits (max_agents, max_contacts, max_messages_month, max_channels, max_ai_agents)

features

object · required

Feature flags (ai_agent, api_access, dedicated_support)

is_active

boolean · required

sort_order

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

PATCH/api/billing/admin/plans/{id}

curl --request PATCH \
  --url https://api-chat.bara.my.id/api/billing/admin/plans/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "slug": "slug",
  "currency": "currency",
  "base_price_monthly": 0,
  "base_price_annual": 0,
  "per_agent_price": 0,
  "overage_message_price": 0,
  "limits": {},
  "features": {},
  "is_active": true,
  "sort_order": 0
}
'

shell

Example Request Body

{
  "name": "name",
  "slug": "slug",
  "currency": "currency",
  "base_price_monthly": 0,
  "base_price_annual": 0,
  "per_agent_price": 0,
  "overage_message_price": 0,
  "limits": {},
  "features": {},
  "is_active": true,
  "sort_order": 0
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "slug": "slug",
  "currency": "IDR",
  "base_price_monthly": 0,
  "base_price_annual": 0,
  "per_agent_price": 0,
  "overage_message_price": 0,
  "limits": {},
  "features": {},
  "is_active": true,
  "sort_order": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

List all coupons

GET

https://api-chat.bara.my.id

/api/billing/admin/coupons

List all coupons › Responses

200

Array of coupons

object[]

id

string · uuid · required

code

string · required

discount_type

string · enum · required

Enum values:

percentage

fixed

discount_value

integer · int64 · required

currency

string · required

current_uses

integer · required

valid_from

string · date-time · required

is_active

boolean · required

created_at

string · date-time · required

max_uses

integer

valid_until

string · date-time

applicable_plans

string[]

Create a coupon

POST

https://api-chat.bara.my.id

/api/billing/admin/coupons

discount_type must be 'percentage' (1-100) or 'fixed'.

Create a coupon › Request Body

code

string · required

discount_type

string · enum · required

Enum values:

percentage

fixed

discount_value

integer · int64 · required

currency

string

Default: IDR

max_uses

integer

valid_from

string · date-time

valid_until

string · date-time

applicable_plans

string[]

Create a coupon › Responses

Created coupon

id

string · uuid · required

code

string · required

discount_type

string · enum · required

Enum values:

percentage

fixed

discount_value

integer · int64 · required

currency

string · required

current_uses

integer · required

valid_from

string · date-time · required

is_active

boolean · required

created_at

string · date-time · required

max_uses

integer

valid_until

string · date-time

applicable_plans

string[]

POST/api/billing/admin/coupons

curl --request POST \
  --url https://api-chat.bara.my.id/api/billing/admin/coupons \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "code",
  "discount_type": "percentage",
  "discount_value": 0,
  "currency": "IDR",
  "max_uses": 0,
  "valid_from": "2024-08-25T15:00:00Z",
  "valid_until": "2024-08-25T15:00:00Z",
  "applicable_plans": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
'

shell

Example Request Body

{
  "code": "code",
  "discount_type": "percentage",
  "discount_value": 0,
  "currency": "IDR",
  "max_uses": 0,
  "valid_from": "2024-08-25T15:00:00Z",
  "valid_until": "2024-08-25T15:00:00Z",
  "applicable_plans": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "code": "code",
  "discount_type": "percentage",
  "discount_value": 0,
  "currency": "currency",
  "max_uses": 0,
  "current_uses": 0,
  "valid_from": "2024-08-25T15:00:00Z",
  "valid_until": "2024-08-25T15:00:00Z",
  "applicable_plans": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "is_active": true,
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete a coupon

DELETE

https://api-chat.bara.my.id

/api/billing/admin/coupons/{id}

Delete a coupon › path Parameters

id

string · uuid · required

Delete a coupon › Responses

Deletion confirmation

No data returned

Update a coupon

PATCH

https://api-chat.bara.my.id

/api/billing/admin/coupons/{id}

Update a coupon › path Parameters

id

string · uuid · required

Update a coupon › Request Body

is_active

boolean

max_uses

integer

valid_until

string · date-time

Update a coupon › Responses

Updated coupon

id

string · uuid · required

code

string · required

discount_type

string · enum · required

Enum values:

percentage

fixed

discount_value

integer · int64 · required

currency

string · required

current_uses

integer · required

valid_from

string · date-time · required

is_active

boolean · required

created_at

string · date-time · required

max_uses

integer

valid_until

string · date-time

applicable_plans

string[]

PATCH/api/billing/admin/coupons/{id}

curl --request PATCH \
  --url https://api-chat.bara.my.id/api/billing/admin/coupons/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_active": true,
  "max_uses": 0,
  "valid_until": "2024-08-25T15:00:00Z"
}
'

shell

Example Request Body

{
  "is_active": true,
  "max_uses": 0,
  "valid_until": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "code": "code",
  "discount_type": "percentage",
  "discount_value": 0,
  "currency": "currency",
  "max_uses": 0,
  "current_uses": 0,
  "valid_from": "2024-08-25T15:00:00Z",
  "valid_until": "2024-08-25T15:00:00Z",
  "applicable_plans": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "is_active": true,
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

List all add-ons

GET

https://api-chat.bara.my.id

/api/billing/admin/addons

List all add-ons › Responses

200

Array of add-ons

object[]

id

string · uuid · required

name

string · required

slug

string · required

price_monthly

integer · int64 · required

price_annual

integer · int64 · required

unit

string · required

Pricing unit (e.g. flat, per agent)

is_active

boolean · required

sort_order

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

description

string

Create an add-on

POST

https://api-chat.bara.my.id

/api/billing/admin/addons

Create an add-on › Request Body

name

string · required

slug

string · required

price_monthly

integer · int64 · required

description

string

price_annual

integer · int64

unit

string

Default: flat

sort_order

integer

Create an add-on › Responses

Created add-on

id

string · uuid · required

name

string · required

slug

string · required

price_monthly

integer · int64 · required

price_annual

integer · int64 · required

unit

string · required

Pricing unit (e.g. flat, per agent)

is_active

boolean · required

sort_order

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

description

string

POST/api/billing/admin/addons

curl --request POST \
  --url https://api-chat.bara.my.id/api/billing/admin/addons \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "slug": "slug",
  "description": "description",
  "price_monthly": 0,
  "price_annual": 0,
  "unit": "flat",
  "sort_order": 0
}
'

shell

Example Request Body

{
  "name": "name",
  "slug": "slug",
  "description": "description",
  "price_monthly": 0,
  "price_annual": 0,
  "unit": "flat",
  "sort_order": 0
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "slug": "slug",
  "description": "description",
  "price_monthly": 0,
  "price_annual": 0,
  "unit": "unit",
  "is_active": true,
  "sort_order": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete an add-on

DELETE

https://api-chat.bara.my.id

/api/billing/admin/addons/{id}

Delete an add-on › path Parameters

id

string · uuid · required

Delete an add-on › Responses

Deletion confirmation

No data returned

Update an add-on

PATCH

https://api-chat.bara.my.id

/api/billing/admin/addons/{id}

Update an add-on › path Parameters

id

string · uuid · required

Update an add-on › Request Body

name

string

description

string

price_monthly

integer · int64

price_annual

integer · int64

is_active

boolean

sort_order

integer

Update an add-on › Responses

Updated add-on

id

string · uuid · required

name

string · required

slug

string · required

price_monthly

integer · int64 · required

price_annual

integer · int64 · required

unit

string · required

Pricing unit (e.g. flat, per agent)

is_active

boolean · required

sort_order

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

description

string

PATCH/api/billing/admin/addons/{id}

curl --request PATCH \
  --url https://api-chat.bara.my.id/api/billing/admin/addons/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "description",
  "price_monthly": 0,
  "price_annual": 0,
  "is_active": true,
  "sort_order": 0
}
'

shell

Example Request Body

{
  "name": "name",
  "description": "description",
  "price_monthly": 0,
  "price_annual": 0,
  "is_active": true,
  "sort_order": 0
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "slug": "slug",
  "description": "description",
  "price_monthly": 0,
  "price_annual": 0,
  "unit": "unit",
  "is_active": true,
  "sort_order": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Combined analytics dashboard

GET

https://api-chat.bara.my.id

/api/billing/admin/analytics/dashboard

Returns MRR, revenue by plan, monthly revenue, and churn metrics in one call.

Combined analytics dashboard › Responses

200

Analytics dashboard

object · required

object[] · required

object · required

GET/api/billing/admin/analytics/dashboard

curl --request GET \
  --url https://api-chat.bara.my.id/api/billing/admin/analytics/dashboard

shell

Example Responses

{
  "mrr": {
    "total_mrr": 0,
    "active_subscriptions": 0,
    "trial_subscriptions": 0,
    "past_due_subscriptions": 0,
    "currency": "currency"
  },
  "revenue_by_plan": [
    {
      "plan_id": "00000000-0000-0000-0000-000000000000",
      "plan_name": "plan_name",
      "subscriber_count": 0,
      "monthly_revenue": 0,
      "currency": "currency"
    }
  ],
  "monthly_revenue": [
    {
      "month": "2024-08-25",
      "total_revenue": 0,
      "invoice_count": 0,
      "paid_count": 0
    }
  ],
  "churn": {
    "cancelled_this_month": 0,
    "suspended_this_month": 0,
    "new_subscriptions_this_month": 0,
    "active_at_start_of_month": 0
  }
}

json

application/json

Monthly recurring revenue summary

GET

https://api-chat.bara.my.id

/api/billing/admin/analytics/mrr

Monthly recurring revenue summary › Responses

200

MRR summary

total_mrr

integer · int64 · required

Total monthly recurring revenue

active_subscriptions

integer · int64 · required

trial_subscriptions

integer · int64 · required

past_due_subscriptions

integer · int64 · required

currency

string · required

Revenue breakdown by plan

GET

https://api-chat.bara.my.id

/api/billing/admin/analytics/revenue-by-plan

Revenue breakdown by plan › Responses

200

Revenue per plan

object[]

plan_id

string · uuid · required

plan_name

string · required

subscriber_count

integer · int64 · required

monthly_revenue

integer · int64 · required

currency

string · required

Monthly revenue over time (last 12 months)

GET

https://api-chat.bara.my.id

/api/billing/admin/analytics/monthly-revenue

Monthly revenue over time (last 12 months) › Responses

200

Monthly revenue array

object[]

month

string · date · required

total_revenue

integer · int64 · required

invoice_count

integer · int64 · required

paid_count

integer · int64 · required

Churn metrics for current month

GET

https://api-chat.bara.my.id

/api/billing/admin/analytics/churn

Churn metrics for current month › Responses

200

Churn metrics

cancelled_this_month

integer · int64 · required

suspended_this_month

integer · int64 · required

new_subscriptions_this_month

integer · int64 · required

active_at_start_of_month

integer · int64 · required

Refund an invoice

POST

https://api-chat.bara.my.id

/api/billing/admin/invoices/{id}/refund

Issue a full or partial refund. Defaults to full refund if amount is omitted.

Refund an invoice › path Parameters

id

string · uuid · required

Refund an invoice › Request Body

reason

string

amount

integer · int64

Partial refund amount. Omit for full refund.

Refund an invoice › Responses

Refund issued

status

string

refund_amount

integer · int64

invoice_status

string

Super Admin Billing