CHIP API

CHIP Collect

CHIP Send

Dashboard

Support

Blog

List all billing templates

BillingTemplate generates Purchase objects, either to issue one-time invoices or in a subscription.

It does so by copying over its' `PurchaseDetails`, one of its `BillingTemplateClient`-s and generating other fields from BillingTemplate's fields as necessary into a new `Purchase` object.

If `is_subscription` is `true`, it is considered to be a subscription's BillingTemplate. You will need to specify `subscription_*` fields like `subscription_period` when creating it and add BillingTemplateClient objects to its billing cycle (`POST /billing_templates/{id}/add_subscriber/`). After that the clients will receive recurring invoices (that will be paid for automatically if client saves their card) according to the BillingTemplate settings you have specified.

If `is_subscription` is `false`, this BillingTemplate is used to send one-time invoices. After creating it and specifying `invoice_*` fields, use `POST /billing_templates/{id}/send_invoice/` request to send the actual invoices. BillingTemplateClients for non-subscription BillingTemplates are not saved.

ID of the brand to create this BillingTemplate for. You can copy it down in the API section, see the "specify the ID of the Brand" link in answer to "How to setup payments on website or in mobile app?".

If the used payment method supports recurring payment functionality, forces the customer's payment credentials to be saved for possible later recurring payments, without giving the customer a choice in the matter.

Sets `due` on the Purchase objects generated. Required if `is_subscription == false`, read-only otherwise.

Sets `issued` on the Purchase objects generated. Generated from current day in `purchase.timezone` if not provided. Read-only if `is_subscription == true`.

Sets `send_receipt` on the Purchase objects generated. `true` by default (unlike in Purchases API, where by default receipts are not sent). Read-only if `is_subscription == true`.

Sets `skip_capture` on the Purchase objects generated. `false` by default. Read-only if `is_subscription == true`.

Defines whether this BillingTemplate issues invoices in a recurring manner - it's a subscription - or it sends invoices only once. You can't change this parameter when you edit the BillingTemplate. If this field is `true`, you will need to specify `subscription_*` fields and `invoice_*` fields are read-only, and vice-versa.

Indicates this is a test object, created using test API keys or using Billing section of UI while in test mode.

Whether this subscription is paused. Has the same effect as setting `"status": "subscription_paused"` for every BillingTemplateClient launched for this subscription, see the description of `status` on BillingTemplateClient for more details.

Ignored (read-only) if `is_subscription == false`.

If this is `true`, clients are charged at the end of billing periods, and vice-versa. E.g. if you add a subscriber client to a BillingTemplate, with this value being set to `false`, he will receive first invoice today, otherwise - after a single billing period (defined by `subscription_period`/`subscription_period_units`) passes.

Required when creating a BillingTemplate with `is_subscription == true`/editing a BillingTemplate with `is_subscription == true` as long as there aren't any launched subscribers; read-only otherwise, whether it's BillingTemplate's editing when there already are clients activated or if `is_subscription == false`.

Used to generate `due` on the Purchase objects generated. Used together with `subscription_due_period_units`: to set the final `Purchase.due` to a week after it's generated/invoice is sent, use `"...period": 1` and `"...period_units" == "weeks". Required if `is_subscription == true`, read-only otherwise.

If this is `true`, there were launched clients (`POST /billing_templates/{id}/add_subscriber/` - or subscribers that were added via the gateway system UI) for this subscription.

While this is `false` (it will be as long as you're only just created the template and haven't launched any subscribers), you can edit all of `subscription_*` fields.

If this is `true`, you're only allowed to edit `subscription_due_period`, `subscription_due_period_units` and `subscription_active`.

Is always `false` if `is_subscription == false`.

Defines how often are the subscription Purchases generated. Used together with `subscription_period_units`: to issue Purchases once a month, use `"...period": 1` and `"...period_units" == "months"`.

Variable number of days in a month is respected; e.g. if subscription has a period of 1 month, a client had its billing cycle activated on January 30 and there are 28 days in February that year - billing scheduled for February will happen on 28th.

Both fields are required when creating a BillingTemplate with `is_subscription == true`/editing a BillingTemplate with `is_subscription == true` as long as there aren't any launched subscribers; they are read-only otherwise, whether it's BillingTemplate's editing when there already are clients activated or if `is_subscription == false`.

How many trial periods to give the client prior to starting his billing cycle. If billing period is 1 month and you set this value to 2, subscription will automatically adjust to giving your client 2 months without payments and then charging him for the 3rd month (when exactly depends on `subscription_charge_period_end`: 3 months after the subscriber was launched for `false`, 4 for `true`). `"subscription_trial_periods": 0` disables this feature.

Required when creating a BillingTemplate with `is_subscription == true`/editing a BillingTemplate with `is_subscription == true` as long as there aren't any launched subscribers; read-only otherwise, whether it's BillingTemplate's editing when there already are clients activated or if `is_subscription == false`.

ID of user who has created this object in the Billing UI, if applicable.

Currency code in the ISO 4217 standard (e.g. 'EUR').

Amount of money as the smallest indivisible units of the currency. Examples: 1 cent for EUR and 1 Yen for JPY.

Total discount per this product in invoice

You can use this field or `total_override` with a value of 0 to activate preauthorization scenario. See the description of the `Purchase.skip_capture` field.

Percent of tax added to the price of this product

Core information about the Purchase, including the products, total, currency and invoice fields. If you're using invoicing via `/billing/` or `/billing_templates/`, this object will be copied 1:1 from BillingTemplate you specify to the resulting Purchases (also to subscription Purchases).

Will be added/substracted to the invoice total, if present.

Whether to permit payments when Purchase's `due` has passed. By default those are permitted (and status will be set to `overdue` once `due` moment is passed). If this is set to `true`, it won't be possible to pay for an overdue invoice, and when `due` is passed the Purchase's status will be set to `expired`.

An optional message to display to your customer in invoice email, e.g. "Your invoice for June".

Language code in the ISO 639-1 format (e.g. 'en')

Line items of the invoice. In case of a transaction with no invoice sent, specify a single Product forming the cost of transaction.

ClientDetails fields to request from the client before the payment. If a value is passed for a field in ClientDetails, it will be automatically removed from this list.

If specified and not null, will override the grand subtotal. This field is visual-only, setting it won't impact `total`.

Timezone to localize invoice-specific timestamps in, e.g. to display a concrete date for a `due` timestamp on the invoice.

Calculated from `products`. You don't need to specify it.

If specified and not null, will override the total discount. This field is visual-only, setting it won't impact `total`.

If specified and not null, will override the total (unlike the rest of `total_*_override` fields).

You can use this field or `products[].total` with a value of 0 to activate preauthorization scenario. See the description of the `Purchase.skip_capture` field.

If specified and not null, will override the total tax. This field is visual-only, setting it won't impact `total`.

bearerAuth

Welcome to the CHIP Collect documentation

CHIP Collect API

Online purchases

Billing

Callbacks

Authentication

Create a purchase

Retrieve a purchase

Cancel a pending purchase

Release funds on hold

Capture a previously authorized payment

Charge a purchase using a saved token

Delete a recurring token associated with a purchase

Refund a paid purchase

Mark a purchase as paid

Resend an invoice

List of payment methods

Create a billing template

Retrieve a billing template

Update a billing template

Delete a billing template

Send an invoice, generating a purchase from billing template data.

Send invoice

Add a billing template client and activate recurring billing (is_subscription: true).

Add subscriber

Retrieve a billing template client by client's ID.


Retrieve a client

Partially update a billing template client by client's ID.


Update a client

List all billing template clients for this billing template.


List all clients

Create a client

Partially update a client

Delete a client

List recurring tokens

Retrieve a recurring token

Delete a recurring token

Create a webhook

Retrieve a webhook

Update a webhook

Delete a webhook

List all webhooks

Returns public key for authenticating company callback payloads

Retrieve a public key

Returns the company balance according to the provided query string filters. Multiple values can be provided for all filters except `from` and `to`, including all results matching any of these values.

Get company balance

Fetches the company turnover according to the provided query string filters. Must provide exactly one `currency` filter. Multiple values can be provided for all filters except `currency`, `from` and `to`, including all results matching any of these values.

Get company turnover

Schedule a statement

Retrieve a statement

Cancel a statement

List all statements

Introduction

List all accounts

Use this API to increase your CHIP Send Budget Allocation by converting an upcoming settlement amount. Upon initiation, all approvers will receive an email prompting them to approve the budget allocation.

*Note: All CHIP Send Budget Allocation requests must be approved by 12 PM MYT the following day. Any requests still pending at 12 PM MYT on the next day will be marked as expired.*


Increase Budget Allocation

Retrieve the details of a previously created send limit / budget allocation.

Retrieve send limit

List all send limits

Resends approval requests. Use this to resend pending approval emails to approvers.


Resend approval request

Add a bank account using the values provided in the parameters. Store the ID returned in the response, as it will be required for subsequent processes.


Add a bank account

Retrieve details of a recipient bank account that was previously created.


Retrieve a bank account

Deletes a bank account record, preventing future payments using the 'Create Send Instruction'.


Delete a bank account

Returns list of recipient bank accounts.


List all bank accounts

Resends webhook event of a bank account record.


Resend bank account webhook event

Create a send instruction using the values provided in the parameters. Calling this endpoint will reduce your available account balance and credit the amount to the receiver's bank account.


Create a send instruction

Retrieve details of a send instruction that was previously created.


Retrieve a send instruction

Deletes send instruction that have been previously created.

*Note: Only unprocessed instructions can be deleted; any other attempts will fail.*


Delete a send instruction

Returns a list of previously created send instructions.

*Note: This request is cached and will only refresh every hour.*


List all send instructions

Resends webhook event of a send instruction record.


Resend send instruction webhook event

Create a group using the values provided in the parameters.


Create a group

Retrieve details of a group that was previously created.


Retrieve a group

Update the specified group using the values provided in the parameters.


Update a group

Delete a group

Returns a list of previously created group records.

*Please note that this request is cached and will only refresh every hour.*


List all groups

Create a webhook using the values provided in the parameters.


Retrieve details of a webhook that was previously created.


Update the specified webhook using the values provided in the parameters.


Returns a list of previously created webhooks.

*Please note that this request is cached and will refresh every hour.*


Overview

API Reference

List all billing templates

Authorizations

Response