Billing

The Billing endpoint allows you to have your add-on billed by Kounta by Lightspeed. That is, a subscription to your add-on can be managed via the API, and the associated fees would be charged to the merchant as part of their regular billing cycle with Kounta by Lightspeed.

You are able to create, update, and remove subscriptions to your add-on, as well as receive webhooks for billing related events such as payment attempts.

Get add-on subscription info

GET /v1/companies/5678/sites/123/billing Get add-on subscription info for a given site
  • plan relates to the plan they currently have with Kounta by Lightspeed POS, and can be one of Lite, Paid, or Cancelled.

Get add-on subscription payments info

GET /v1/companies/5678/sites/123/billing/payments Get add-on subscription payments info for a given site
  • plan relates to the plan they currently have with Kounta by Lightspeed POS, and can be one of Lite, Paid, or Cancelled.

Create an add-on subscription

POST /v1/companies/5678/sites/123/billing Create an add-on subscription for a given site
  • All subscriptions are considered as recurring.
  • The first charge may be pro-rata so that future charges can align with monthly billing rate.
  • Plan IDs and pricing would need to be agreed and pre-configured by Kounta by Lightspeed. Please email developers@kounta.com to discuss this.
  • The actual payment will happen async and a webhook will be sent about success/failure.

Update an add-on subscription

PUT /v1/companies/5678/sites/123/billing Update an add-on subscription for a given site
  • Handles plan upgrade/downgrade if you had multiple tiers, but not cancellation.

Cancel an add-on subscription

DELETE /v1/companies/5678/sites/123/billing Cancel an add-on subscription for a given site

List of Webhooks

Here is a list of the supported webhook topics.

Note: Created, Updated, and Cancelled webhooks contain the full payload the same as the GET /billing call above, whereas the Payment webhook contains the full payload of the GET /billing/payments call above.

billing/created

Triggered when a new add-on subscription is created.

billing/updated

Triggered when an add-on plan change occurs.

billing/cancelled

Triggered when an add-on plan cancellation occurs.

billing/payment

Triggered when a payment attempt is made on an add-on subscription.