Billing

Endpoint

Tenant subscription, usage, invoices, and payment method management

Get current subscription and plan

GET

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

/api/billing/plan

Retrieve the current subscription with plan details for the tenant.

Get current subscription and plan › Responses

Current plan with subscription details

Current subscription with embedded plan details

id

string · uuid · required

org_id

string · uuid · required

plan_id

string · uuid · required

status

string · enum · required

Enum values:

trial

active

past_due

cancelled

suspended

billing_period

string · enum · required

Enum values:

monthly

annual

cancel_at_period_end

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

plan_name

string · required

limits

object · required

features

object · required

trial_ends_at

string · date-time

current_period_start

string · date-time

current_period_end

string · date-time

payment_gateway

string

gateway_customer_id

string

gateway_subscription_id

string

GET/api/billing/plan

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

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "org_id": "00000000-0000-0000-0000-000000000000",
  "plan_id": "00000000-0000-0000-0000-000000000000",
  "status": "trial",
  "billing_period": "monthly",
  "trial_ends_at": "2024-08-25T15:00:00Z",
  "current_period_start": "2024-08-25T15:00:00Z",
  "current_period_end": "2024-08-25T15:00:00Z",
  "payment_gateway": "payment_gateway",
  "gateway_customer_id": "gateway_customer_id",
  "gateway_subscription_id": "gateway_subscription_id",
  "cancel_at_period_end": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "plan_name": "plan_name",
  "limits": {},
  "features": {}
}

json

application/json

List available billing plans

GET

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

/api/billing/plans

List all active billing plans available for subscription.

List available billing plans › Responses

200

Array of active 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

POST

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

/api/billing/subscribe

Create a new subscription with a 14-day trial. If plan_id is omitted, the cheapest active plan is used. Rejects if already subscribed.

plan_id

string · uuid

Plan to subscribe to (optional, defaults to cheapest)

Created subscription

id

string · uuid · required

org_id

string · uuid · required

plan_id

string · uuid · required

status

string · enum · required

Enum values:

trial

active

past_due

cancelled

suspended

billing_period

string · enum · required

Enum values:

monthly

annual

cancel_at_period_end

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

trial_ends_at

string · date-time

current_period_start

string · date-time

current_period_end

string · date-time

payment_gateway

string

gateway_customer_id

string

gateway_subscription_id

string

POST/api/billing/subscribe

curl --request POST \
  --url https://api-chat.bara.my.id/api/billing/subscribe \
  --header 'Content-Type: application/json' \
  --data '
{
  "plan_id": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "plan_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "org_id": "00000000-0000-0000-0000-000000000000",
  "plan_id": "00000000-0000-0000-0000-000000000000",
  "status": "trial",
  "billing_period": "monthly",
  "trial_ends_at": "2024-08-25T15:00:00Z",
  "current_period_start": "2024-08-25T15:00:00Z",
  "current_period_end": "2024-08-25T15:00:00Z",
  "payment_gateway": "payment_gateway",
  "gateway_customer_id": "gateway_customer_id",
  "gateway_subscription_id": "gateway_subscription_id",
  "cancel_at_period_end": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Upgrade or downgrade subscription plan

POST

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

/api/billing/upgrade

Changes the subscription plan with mid-cycle proration. Creates a prorated invoice for the net price difference with 11% PPN tax for IDR.

Upgrade or downgrade subscription plan › Request Body

plan_id

string · uuid · required

period

string · enum

Optional billing period override. If omitted, keeps the current billing period.

Enum values:

monthly

annual

Upgrade or downgrade subscription plan › Responses

Upgraded subscription with optional prorated invoice

object

POST/api/billing/upgrade

curl --request POST \
  --url https://api-chat.bara.my.id/api/billing/upgrade \
  --header 'Content-Type: application/json' \
  --data '
{
  "plan_id": "00000000-0000-0000-0000-000000000000",
  "period": "monthly"
}
'

shell

Example Request Body

{
  "plan_id": "00000000-0000-0000-0000-000000000000",
  "period": "monthly"
}

json

Example Responses

{
  "subscription": {
    "id": "00000000-0000-0000-0000-000000000000",
    "org_id": "00000000-0000-0000-0000-000000000000",
    "plan_id": "00000000-0000-0000-0000-000000000000",
    "status": "trial",
    "billing_period": "monthly",
    "trial_ends_at": "2024-08-25T15:00:00Z",
    "current_period_start": "2024-08-25T15:00:00Z",
    "current_period_end": "2024-08-25T15:00:00Z",
    "payment_gateway": "payment_gateway",
    "gateway_customer_id": "gateway_customer_id",
    "gateway_subscription_id": "gateway_subscription_id",
    "cancel_at_period_end": true,
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  },
  "prorated_invoice": {
    "id": "00000000-0000-0000-0000-000000000000",
    "org_id": "00000000-0000-0000-0000-000000000000",
    "subscription_id": "00000000-0000-0000-0000-000000000000",
    "invoice_number": "INV-202605-0001",
    "currency": "currency",
    "subtotal": 0,
    "tax": 0,
    "total": 0,
    "status": "open",
    "line_items": [
      {
        "description": "description",
        "quantity": 0,
        "unit_price": 0,
        "amount": 0
      }
    ],
    "pdf_url": "pdf_url",
    "gateway_invoice_id": "gateway_invoice_id",
    "payment_url": "payment_url",
    "retry_count": 0,
    "last_retry_at": "2024-08-25T15:00:00Z",
    "paid_at": "2024-08-25T15:00:00Z",
    "due_date": "2024-08-25",
    "created_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Cancel subscription

POST

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

/api/billing/cancel

Mark subscription for cancellation at end of current billing period.

Cancel subscription › Responses

Updated subscription with cancel_at_period_end=true

id

string · uuid · required

org_id

string · uuid · required

plan_id

string · uuid · required

status

string · enum · required

Enum values:

trial

active

past_due

cancelled

suspended

billing_period

string · enum · required

Enum values:

monthly

annual

cancel_at_period_end

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

trial_ends_at

string · date-time

current_period_start

string · date-time

current_period_end

string · date-time

payment_gateway

string

gateway_customer_id

string

gateway_subscription_id

string

POST/api/billing/cancel

curl --request POST \
  --url https://api-chat.bara.my.id/api/billing/cancel

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "org_id": "00000000-0000-0000-0000-000000000000",
  "plan_id": "00000000-0000-0000-0000-000000000000",
  "status": "trial",
  "billing_period": "monthly",
  "trial_ends_at": "2024-08-25T15:00:00Z",
  "current_period_start": "2024-08-25T15:00:00Z",
  "current_period_end": "2024-08-25T15:00:00Z",
  "payment_gateway": "payment_gateway",
  "gateway_customer_id": "gateway_customer_id",
  "gateway_subscription_id": "gateway_subscription_id",
  "cancel_at_period_end": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get current month's usage

GET

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

/api/billing/usage

Retrieve usage metrics and plan limits for the current billing period.

Get current month's usage › Responses

Usage metrics with plan limits

org_id

string · uuid · required

agent_count

integer · required

contact_count

integer · required

messages_this_month

integer · int64 · required

active_integrations

integer · required

usage_month

string · date · required

limits

object · required

Plan limits for comparison

List invoices

GET

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

/api/billing/invoices

List invoices › Responses

200

Array of invoices

object[]

id

string · uuid · required

org_id

string · uuid · required

invoice_number

string · required

currency

string · required

subtotal

integer · int64 · required

tax

integer · int64 · required

total

integer · int64 · required

status

string · enum · required

Enum values:

open

paid

past_due

void

refunded

partially_refunded

object[] · required

retry_count

integer · required

created_at

string · date-time · required

subscription_id

string · uuid

pdf_url

string

gateway_invoice_id

string

payment_url

string

last_retry_at

string · date-time

paid_at

string · date-time

due_date

string · date

GET/api/billing/invoices

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

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "org_id": "00000000-0000-0000-0000-000000000000",
    "subscription_id": "00000000-0000-0000-0000-000000000000",
    "invoice_number": "INV-202605-0001",
    "currency": "currency",
    "subtotal": 0,
    "tax": 0,
    "total": 0,
    "status": "open",
    "line_items": [
      {
        "description": "description",
        "quantity": 0,
        "unit_price": 0,
        "amount": 0
      }
    ],
    "pdf_url": "pdf_url",
    "gateway_invoice_id": "gateway_invoice_id",
    "payment_url": "payment_url",
    "retry_count": 0,
    "last_retry_at": "2024-08-25T15:00:00Z",
    "paid_at": "2024-08-25T15:00:00Z",
    "due_date": "2024-08-25",
    "created_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Download invoice PDF

GET

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

/api/billing/invoices/{id}/pdf

Redirects to the PDF URL. Generates PDF on-the-fly if not cached.

Download invoice PDF › path Parameters

id

string · uuid · required

Download invoice PDF › Responses

Redirect to PDF URL

No data returned

List payment methods

GET

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

/api/billing/payment-methods

List payment methods › Responses

200

Array of payment methods

object[]

id

string · uuid · required

org_id

string · uuid · required

gateway

string · required

gateway_payment_method_id

string · required

type

string · required

Payment method type (e.g. credit_card, e_wallet, virtual_account, bank_transfer)

label

string · required

is_default

boolean · required

created_at

string · date-time · required

Add a payment method

POST

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

/api/billing/payment-methods

If is_default is true, existing methods are unset as default first.

Add a payment method › Request Body

gateway

string · required

gateway_payment_method_id

string · required

type

string · required

Payment method type (e.g. credit_card, e_wallet, virtual_account)

label

string · required

is_default

boolean

Add a payment method › Responses

200

Created payment method

id

string · uuid · required

org_id

string · uuid · required

gateway

string · required

gateway_payment_method_id

string · required

type

string · required

Payment method type (e.g. credit_card, e_wallet, virtual_account, bank_transfer)

label

string · required

is_default

boolean · required

created_at

string · date-time · required

POST/api/billing/payment-methods

curl --request POST \
  --url https://api-chat.bara.my.id/api/billing/payment-methods \
  --header 'Content-Type: application/json' \
  --data '
{
  "gateway": "gateway",
  "gateway_payment_method_id": "gateway_payment_method_id",
  "type": "type",
  "label": "label",
  "is_default": true
}
'

shell

Example Request Body

{
  "gateway": "gateway",
  "gateway_payment_method_id": "gateway_payment_method_id",
  "type": "type",
  "label": "label",
  "is_default": true
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "org_id": "00000000-0000-0000-0000-000000000000",
  "gateway": "xendit",
  "gateway_payment_method_id": "gateway_payment_method_id",
  "type": "type",
  "label": "BCA VA ****1234",
  "is_default": true,
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete a payment method

DELETE

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

/api/billing/payment-methods/{id}

Delete a payment method › path Parameters

id

string · uuid · required

Delete a payment method › Responses

Deletion confirmation

deleted

boolean

Validate a coupon code

POST

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

/api/billing/validate-coupon

Validate a coupon code › Request Body

code

string · required

plan_id

string · uuid

Validate a coupon code › Responses

200

Coupon validation result

valid

boolean

object

reason

string

POST/api/billing/validate-coupon

curl --request POST \
  --url https://api-chat.bara.my.id/api/billing/validate-coupon \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "code",
  "plan_id": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "code": "code",
  "plan_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "valid": true,
  "coupon": {
    "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"
  },
  "reason": "reason"
}

json

application/json

List available add-ons

GET

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

/api/billing/addons

List available add-ons › Responses

200

Array of available 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

List attached add-ons

GET

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

/api/billing/my-addons

Returns add-ons currently attached to the tenant's subscription.

List attached add-ons › Responses

200

Array of attached add-ons with details

object[]

id

string · uuid · required

addon_id

string · uuid · required

name

string · required

slug

string · required

price_monthly

integer · int64 · required

quantity

integer · required

created_at

string · date-time · required

Attach an add-on to subscription

POST

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

/api/billing/addons/attach

Attach an add-on to subscription › Request Body

addon_id

string · uuid · required

quantity

integer

Default: 1

Attach an add-on to subscription › Responses

200

Attached subscription add-on

id

string · uuid · required

subscription_id

string · uuid · required

addon_id

string · uuid · required

quantity

integer · required

created_at

string · date-time · required

Detach an add-on from subscription

DELETE

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

/api/billing/addons/detach/{addon_id}

Detach an add-on from subscription › path Parameters

addon_id

string · uuid · required

Detach an add-on from subscription › Responses

Detached confirmation

No data returned

Billing Admin

Billing

Get current subscription and plan

Get current subscription and plan › Responses

List available billing plans

List available billing plans › Responses

Subscribe to a plan

Subscribe to a plan › Request Body

Subscribe to a plan › Responses

Upgrade or downgrade subscription plan

Upgrade or downgrade subscription plan › Request Body

Upgrade or downgrade subscription plan › Responses

Cancel subscription

Cancel subscription › Responses

Get current month's usage

Get current month's usage › Responses

List invoices

List invoices › Responses

Download invoice PDF

Download invoice PDF › path Parameters

Download invoice PDF › Responses

List payment methods

List payment methods › Responses

Add a payment method

Add a payment method › Request Body

Add a payment method › Responses

Delete a payment method

Delete a payment method › path Parameters

Delete a payment method › Responses

Validate a coupon code

Validate a coupon code › Request Body

Validate a coupon code › Responses

List available add-ons

List available add-ons › Responses

List attached add-ons

List attached add-ons › Responses

Attach an add-on to subscription

Attach an add-on to subscription › Request Body

Attach an add-on to subscription › Responses

Detach an add-on from subscription

Detach an add-on from subscription › path Parameters

Detach an add-on from subscription › Responses