Sign in
Billing Agreements

Get billing agreements

Changed on

Returns all the agreements a billing customer currently has access to

<div> <code>read:billing_agreements</code> </div>
get/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

Query parameters

page_sizeinteger nullable

Number of results per page. Defaults to 10 if parameter not sent.

starting_afterstring nullable

The ID of the billing agreement to start after.

ending_beforestring nullable

The ID of the billing agreement to end before.

customer_idstring required

The ID of the billing customer to retrieve agreements for

feature_codestring nullable

The feature code to filter by agreements only containing that feature

Response

Billing agreements successfully retrieved.

codestring

Response code.

messagestring

Response message.

has_moreboolean

Whether more records exist.

Example response

{
  "code": "OK",
  "message": "Success",
  "agreements": [
    {
      "id": "agreement_0195ac80a14c2ca2cec97d026d864de0",
      "expires_on": "2024-11-18T13:32:03+11",
      "billing_group_id": "sbg_0195abf6773fdae18d5da72281a3fde2",
      "current_period_start": "2026-08-06T12:53:57Z",
      "current_period_end": "2026-09-06T12:53:57Z",
      "entitlements": [
        {
          "feature_code": "CcdkvEXpbg6UY",
          "entitlement_id": "entitlement_0195ac80a14e8d71f42b98e75d3c61ad"
        }
      ]
    }
  ]
}

Changes

  • 3557b4b818eaRevision changes
    • breaking

      the response property // became nullable for the status (media type: application/json; charset=utf-8)

    • breaking

      the response property // became nullable for the status (media type: application/json)

    • breaking

      the response property // became nullable for the status (media type: application/json; charset=utf-8)

    • breaking

      the response property // became nullable for the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: application/json; charset=utf-8)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: application/json; charset=utf-8)

    • info

      added the optional property // to the response with the status (media type: application/json)

  • 0c5023c4d856Revision changes
    • info

      endpoint added