Sign in
Billing Agreements

Create billing agreement

Changed on

Creates a new billing agreement based on the plan code passed, and cancels the customer's existing agreements

<div> <code>create:billing_agreements</code> </div>
post/api/v1/billing/agreements

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/billing/agreements
  • Auth: HTTP bearer

Request body

customer_idstring required

The ID of the billing customer to create a new agreement for

plan_codestring required

The code of the billing plan the new agreement will be based on

is_invoice_nowboolean

Generate a final invoice for any un-invoiced metered usage.

is_prorateboolean

Generate a proration invoice item that credits remaining unused features.

Example request

{
  "customer_id": "customer_0195ac80a14c2ca2cec97d026d864de0",
  "plan_code": "pro",
  "is_invoice_now": true,
  "is_prorate": true
}

Response

Billing agreement successfully changed

messagestring
codestring

Example response

{
  "message": "Success",
  "code": "OK"
}

Changes