Skip to content
Documentation
Contact
← Back to documentation
Technical Reference

Billplz

Create and manage bills and collections with Billplz API

CategoryOther
Authenticationcustom
Version0.0.9
Published scopes0 published scopes
Last updatedSeptember 28, 2026

Overview

Billplz

This CDK catalogue package is pinned to @activepieces/piece-billplz@0.0.9 and declares 2 declared actions and 1 declared trigger. Its definition is derived from the exact reviewed Activepieces source.

Provider runtime verification is recorded separately when an approved test connection is exercised; this catalogue entry does not claim that verification.

Technical guide

Technical reference

  • Package: @activepieces/piece-billplz@0.0.9
  • Exact artifact digest: sha256:f014f2266a9c11fca70c90f54a8681ed7a0dc0edae21b7f2bbbcf90d6993a668
  • Source: the exact reviewed Activepieces source
  • Authentication, action and trigger schemas are taken from the exact pinned package.

Capability summary

Authenticationcustom
Supported objects3
Supported actions2
Triggers1

Authentication

Authentication method: custom

Authentication profiles

connection · custom
  • API Secret Key Required · protected credential

Supported objects

ObjectReadWriteNotes
Create Bill Yes No
Get Bill Yes No
Get Collections Yes No Trigger contract validated offline; live event delivery is tracked separately.

Supported actions

Create Bill · Read

Create a new bill within a collection

create_bill · Risk: low · Retry: safe

Inputs

  • collection_id · string · Required, Select the collection to create the bill in
  • email · string · Optional, Recipient email address (required if mobile not provided)
  • mobile · string · Optional, Recipient mobile number with country code (required if email not provided)
  • name · string · Required, Name of the bill recipient
  • amount · number · Required, Amount in Malaysian Ringgit (e.g., 2.00 for RM 2.00)
  • description · string · Required, Bill description that will be displayed on the bill
  • callback_url · string · Required, Webhook URL to receive payment completion notifications
  • due_at · string · Optional, Due date in YYYY-MM-DD format (optional, defaults to today)
  • redirect_url · string · Optional, URL to redirect customer after payment completion
  • deliver · boolean · Optional, Automatically send email and SMS notification to recipient
  • reference_1_label · string · Optional, Label for first reference field
  • reference_1 · string · Optional, Value for first reference field
  • reference_2_label · string · Optional, Label for second reference field
  • reference_2 · string · Optional, Value for second reference field
Get Bill · Read

Retrieve information about a specific bill

get_bill · Risk: low · Retry: safe

Inputs

  • bill_id · string · Required, The ID of the bill to retrieve

Triggers

Get Collections · Poll

Triggers when there are new collections

Setup

Setup

Create a tenant connection only in the consuming Studio instance when this connector is made available there. Credentials remain in that tenant's Vault-backed connection and are not stored in CDK package metadata.

Limitations

The package has passed deterministic offline package-load and contract validation. No provider credentials, provider API call or live webhook delivery is represented by this release state.

github.com