OpenMeter Billing Settings

List billing profiles

Changed on

List billing profiles.

get/openmeter/profiles

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/profiles
  • Auth: none declared

Query parameters

sizeinteger

The number of items to include per page.

numberinteger

The page number.

Determines which page of the collection to retrieve.

sortstring

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

Example:created_at desc

Sort billing profiles returned in the response. Supported sort attributes are:

  • id
  • name
  • created_at (default)

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order.

Filter billing profiles returned in the response.

To filter billing profiles by name add the following query param: filter[name]=my-profile

{
  "id": "01G65Z755AFWAKHE12NY0CQ9FH"
}

Response

Page paginated response.

Example response

{
  "data": [
    {
      "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"
        }
      }
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

Changes

  • v3c4d8e6620898Revision changes
    • info

      added the new optional query request parameter filter

    • info

      added the new optional query request parameter sort

  • v376da282d8974Revision changes
    • info

      added the optional property ///////// to the response with the status