Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-03101355448.4 KB
OpenMeter Billing Settings

Create a new billing profile

Create a new billing profile.

Billing profiles contain the settings for billing and controls invoice generation. An organization can have multiple billing profiles defined. A billing profile is linked to a specific app. This association is established during the billing profile's creation and remains immutable.

post/openmeter/profiles

Request body

namestring required

Display name of the resource.

Between 1 and 256 characters.

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

labelsLabels

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

defaultboolean required

Whether this is the default profile.

Example request

{
  "labels": {
    "env": "test"
  },
  "supplier": {
    "key": "019ae40f-4258-7f15-9491-842f42a7d6ac",
    "addresses": {
      "billing_address": {
        "country": "US"
      }
    }
  },
  "workflow": {
    "collection": {
      "alignment": {
        "recurring_period": {
          "anchor": "2023-01-01T01:01:01.001Z",
          "interval": "P1Y"
        }
      },
      "interval": "P1D"
    },
    "invoicing": {
      "draft_period": "P1D"
    },
    "payment": {
      "due_after": "P30D"
    },
    "tax": {
      "default_tax_config": {
        "stripe": {
          "code": "txcd_10000000"
        },
        "tax_code_id": "01G65Z755AFWAKHE12NY0CQ9FH",
        "tax_code": {
          "id": "01G65Z755AFWAKHE12NY0CQ9FH"
        }
      }
    }
  },
  "apps": {
    "tax": {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH"
    },
    "invoicing": {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH"
    },
    "payment": {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH"
    }
  }
}

Response

BillingProfile created response.

idstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

namestring required

Display name of the resource.

Between 1 and 256 characters.

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

labelsLabels

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

created_atstring date-time required

RFC3339 formatted date-time string in UTC.

updated_atstring date-time required

RFC3339 formatted date-time string in UTC.

deleted_atstring date-time

RFC3339 formatted date-time string in UTC.

defaultboolean required

Whether this is the default profile.

Example response

{
  "id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "labels": {
    "env": "test"
  },
  "created_at": "2023-01-01T01:01:01.001Z",
  "updated_at": "2023-01-01T01:01:01.001Z",
  "deleted_at": "2023-01-01T01:01:01.001Z",
  "supplier": {
    "key": "019ae40f-4258-7f15-9491-842f42a7d6ac",
    "addresses": {
      "billing_address": {
        "country": "US"
      }
    }
  },
  "workflow": {
    "collection": {
      "alignment": {
        "recurring_period": {
          "anchor": "2023-01-01T01:01:01.001Z",
          "interval": "P1Y"
        }
      },
      "interval": "P1D"
    },
    "invoicing": {
      "draft_period": "P1D"
    },
    "payment": {
      "due_after": "P30D"
    },
    "tax": {
      "default_tax_config": {
        "stripe": {
          "code": "txcd_10000000"
        },
        "tax_code_id": "01G65Z755AFWAKHE12NY0CQ9FH",
        "tax_code": {
          "id": "01G65Z755AFWAKHE12NY0CQ9FH"
        }
      }
    }
  },
  "apps": {
    "tax": {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH"
    },
    "invoicing": {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH"
    },
    "payment": {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH"
    }
  }
}