List all clients

GET

billing_templates

{id}

clients

curl --request GET \
  --url https://gate.chip-in.asia/api/v1/billing_templates/{id}/clients/ \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "type": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_on": 1619740800,
      "updated_on": 1619740800,
      "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "inactive",
      "subscription_billing_scheduled_on": "2020-04-30",
      "payment_method_whitelist": [
        "<string>"
      ],
      "send_invoice_on_charge_failure": true,
      "send_invoice_on_add_subscriber": false,
      "send_receipt": true
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Object ID (UUID)

Response

200 - application/json

results

object[]

Connects a Client object to a BillingTemplate having is_subscription = true to store information about a single subscriber.

You will be able to pause an individual subscription client's cycle by PATCH-ing its' status field to the value of subscription_paused.

results.client_id

string

required

ID of the Client object to add to the BillingTemplate. Read-only after the BillingTemplateClient has been created. Note that the same Client can be added to a BillingTemplate several times.

results.type

string

Object type identifier

results.id

string

results.created_on

integer

Object creation time

Example:

1619740800

results.updated_on

integer

Object last modification time

Example:

1619740800

results.status

enum<string>

default:inactive

For subscriptions, you can edit (PATCH /billing_templates/{id}/clients/{id}/) this status between active and subscription_paused values to pause the client's subscription. Paused subscriptions run as normal, except for purchases not being created and invoices sent for them. It means that if you pause a BillingTemplateClient's monthly subscription cycle a day before the billing date, the next day the invoice will not be issued; but, if you unpause the client a day after the planned billing would have taken place, the planned billing in a month (minus one day) will happen as usual.

Read-only if the BillingTemplateClient is in inactive (internal status not managed through public API) or pending (see documentation for POST /billing_templates/{id}/add_subscriber/) statuses.

Available options:

pending,

inactive,

active,

subscription_paused

results.subscription_billing_scheduled_on

string

If not null, reports the date when the next billing is scheduled for this client.

Example:

"2020-04-30"

results.payment_method_whitelist

string[]

An optional whitelist of payment methods availble for purchases generated for this BillingTemplateClient. Copied 1:1 to Purchase.payment_method_whitelist field on created Purchases (see its description).

Payment method name as returned by GET /payment_methods/.

results.send_invoice_on_charge_failure

boolean

default:true

Sends invoice when subscription charge fails if this is true

results.send_invoice_on_add_subscriber

boolean

default:false

Sends invoice when POST /billing_templates/{id}/add_subscriber/ is called if this is true

results.send_receipt

boolean

default:true

Sends receipt when subscription charge succeeds if this is true

string | null

The next page of pagination results. null if there are no more results.

string | null

The previous page of pagination results. null if there was no previous page.

Update a client Create a client

curl --request GET \
  --url https://gate.chip-in.asia/api/v1/billing_templates/{id}/clients/ \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "type": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_on": 1619740800,
      "updated_on": 1619740800,
      "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "inactive",
      "subscription_billing_scheduled_on": "2020-04-30",
      "payment_method_whitelist": [
        "<string>"
      ],
      "send_invoice_on_charge_failure": true,
      "send_invoice_on_add_subscriber": false,
      "send_receipt": true
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Overview

API Reference

Authorizations

Path Parameters

Response