Sign in
OpenMeter Billing Settings

Update a billing profile

Update a billing profile.

put/v3/openmeter/profiles/{id}

Path parameters

idstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

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": "P1M"
        }
      },
      "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"
        }
      }
    }
  }
}

Response

BillingProfile updated 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

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity last update date.

deleted_atstring date-time

An ISO-8601 timestamp representation of entity deletion date.

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": "P1M"
        }
      },
      "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"
    }
  }
}

Changes

Changed in 3 of the 75 revisions of this API.15

  • a2e95e9f6c804See the full diff
    • ○

      api tag OpenMeter Billing Settings added

      api-tag-added

    • ○

      api tag OpenMeter Billing removed

      api-tag-removed

    • ○

      added the new optional request property workflow/invoicing/subscription_end_proration_mode

      new-optional-request-property

    • ○

      added the optional property workflow/invoicing/subscription_end_proration_mode to the response with the 200 status

      response-optional-property-added

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 86981188d91110See the full diff
    • ○

      added the new optional request property workflow/tax/default_tax_config/tax_code

      new-optional-request-property

    • ○

      added the new optional request property workflow/tax/default_tax_config/tax_code_id

      new-optional-request-property

    • ○

      request property workflow/tax/default_tax_config/external_invoicing deprecated

      request-property-deprecated

    • ○

      request property workflow/tax/default_tax_config/stripe deprecated

      request-property-deprecated

    • ○

      added the optional property workflow/tax/default_tax_config/tax_code to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property workflow/tax/default_tax_config/tax_code_id to the response with the 200 status

      response-optional-property-added

    • ○

      the response property created_at became required for the status 200

      response-property-became-required

    • ○

      the response property updated_at became required for the status 200

      response-property-became-required

    • ○

      response property workflow/tax/default_tax_config/external_invoicing deprecated

      response-property-deprecated

    • ○

      response property workflow/tax/default_tax_config/stripe deprecated

      response-property-deprecated

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d5eb242b4c931See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog