Update a client
Partially update a billing template client by client’s ID.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Object ID (UUID)
Body
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.
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.
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).
Sends invoice when POST /billing_templates/{id}/add_subscriber/ is called if this is true
Sends invoice when subscription charge fails if this is true
Sends receipt when subscription charge succeeds if this is true
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.
pending, inactive, active, subscription_paused Response
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.
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.
Object creation time
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).
Sends invoice when POST /billing_templates/{id}/add_subscriber/ is called if this is true
Sends invoice when subscription charge fails if this is true
Sends receipt when subscription charge succeeds if this is true
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.
pending, inactive, active, subscription_paused If not null, reports the date when the next billing is scheduled for this client.
Object type identifier
Object last modification time