Kinde Billing Entitlements API

openapi: 3.2.0
info:
  version: '1'
  title: Kinde Management Billing Entitlements API
  description: 'Provides endpoints to manage your Kinde Businesses.


    ## Intro


    ## How to use


    1. Set up and authorize a machine-to-machine (M2M) application.


    2. Generate a test access token


    3. Test request any endpoint using the test token'
  termsOfService: https://docs.kinde.com/trust-center/agreements/terms-of-service/
  contact:
    name: Kinde Support Team
    email: support@kinde.com
    url: https://docs.kinde.com
servers:
- url: https://{subdomain}.kinde.com
  variables:
    subdomain:
      default: your_kinde_subdomain
      description: The subdomain generated for your business on Kinde.
tags:
- name: Billing Entitlements
  x-displayName: Billing Entitlements
paths:
  /api/v1/billing/entitlements:
    servers: []
    get:
      tags:
      - Billing Entitlements
      operationId: getBillingEntitlements
      x-scope: read:billing_entitlements
      description: 'Returns all the entitlements a billing customer currently has access to


        read:billing_entitlements'
      summary: Get billing entitlements
      parameters:
      - name: page_size
        in: query
        required: false
        description: Number of results per page. Defaults to 10 if parameter not sent.
        schema:
          type:
          - integer
          - 'null'
      - name: starting_after
        in: query
        required: false
        description: The ID of the billing entitlement to start after.
        schema:
          type:
          - string
          - 'null'
      - name: ending_before
        in: query
        required: false
        description: The ID of the billing entitlement to end before.
        schema:
          type:
          - string
          - 'null'
      - name: customer_id
        in: query
        description: The ID of the billing customer to retrieve entitlements for
        required: true
        schema:
          type: string
      - name: max_value
        in: query
        description: When the maximum limit of an entitlement is null, this value is returned as the maximum limit
        schema:
          type:
          - string
          - 'null'
      - name: expand
        in: query
        description: 'Additional plan data to include in the response. Allowed value: "plans".'
        required: false
        schema:
          type:
          - string
          - 'null'
          enum:
          - plans
      responses:
        '200':
          description: Billing entitlements successfully retrieved.
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/get_billing_entitlements_response'
            application/json:
              schema:
                $ref: '#/components/schemas/get_billing_entitlements_response'
        '400':
          description: Invalid request.
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/error_response'
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: Invalid credentials.
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/error_response'
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '429':
          description: Request was throttled.
      security:
      - kindeBearerAuth: []
components:
  schemas:
    error_response:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/error'
    get_billing_entitlements_response:
      type: object
      properties:
        code:
          type: string
          description: Response code.
          example: OK
        message:
          type: string
          description: Response message.
          example: Success
        has_more:
          description: Whether more records exist.
          type: boolean
        entitlements:
          type: array
          description: A list of entitlements
          items:
            type: object
            properties:
              id:
                type: string
                description: The friendly id of an entitlement
                example: entitlement_0195ac80a14e8d71f42b98e75d3c61ad
              fixed_charge:
                type: integer
                description: The price charged if this is an entitlement for a fixed charged
                example: 35
              price_name:
                type: string
                description: The name of the price associated with the entitlement
                example: Pro gym
              unit_amount:
                type: integer
                description: The price charged for this entitlement in cents
              feature_code:
                type: string
                description: The feature code of the feature corresponding to this entitlement
                example: CcdkvEXpbg6UY
              feature_name:
                type: string
                description: The feature name of the feature corresponding to this entitlement
                example: Pro Gym
              entitlement_limit_max:
                type: integer
                description: The maximum number of units of the feature the customer is entitled to
              entitlement_limit_min:
                type: integer
                description: The minimum number of units of the feature the customer is entitled to
        plans:
          type: array
          description: A list of plans.
          items:
            type: object
            properties:
              code:
                type: string
                description: The plan code the billing customer is subscribed to
              subscribed_on:
                type: string
                format: date-time
                example: '2024-11-18T13:32:03+11'
    error:
      type: object
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Error message.
  securitySchemes:
    kindeBearerAuth:
      description: 'Requires an access token obtained using the client_credentials flow.

        '
      type: http
      scheme: bearer
      bearerFormat: JWT