{ "opencollection": "1.0.0", "info": { "name": "Kong Enterprise Admin ACLs OpenMeter Customers API", "version": "3.14.0" }, "request": { "auth": { "type": "apikey", "key": "Kong-Admin-Token", "value": "{{Kong-Admin-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "OpenMeter Customers", "type": "folder" }, "items": [ { "info": { "name": "List customers", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/openmeter/customers", "params": [ { "name": "page", "value": "", "type": "query", "description": "Determines which page of the collection to retrieve." }, { "name": "sort", "value": "", "type": "query", "description": "Sort customers returned in the response.\nSupported sort attributes are:\n- `id`\n- `name` (default)\n- `created_at`\n\nThe `asc` suffix is optional as the default sort order is ascending.\nThe `desc` suffix is used to specify a descending order." }, { "name": "filter", "value": "", "type": "query", "description": "Filter customers returned in the response.\n\nTo filter customers by key add the following query param: filter[key]=my-db-id" } ] }, "docs": "List customers" }, { "info": { "name": "Create customer", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/openmeter/customers", "body": { "type": "json", "data": "{}" } }, "docs": "Create customer" }, { "info": { "name": "Get customer", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/openmeter/customers/:customerId", "params": [ { "name": "customerId", "value": "", "type": "path" } ] }, "docs": "Get customer" }, { "info": { "name": "Upsert customer", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}:{port}{path}/v3/openmeter/customers/:customerId", "params": [ { "name": "customerId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upsert customer" }, { "info": { "name": "Delete customer", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v3/openmeter/customers/:customerId", "params": [ { "name": "customerId", "value": "", "type": "path" } ] }, "docs": "Delete customer" }, { "info": { "name": "Get customer billing data", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/openmeter/customers/:customerId/billing", "params": [ { "name": "customerId", "value": "", "type": "path" } ] }, "docs": "Get customer billing data" }, { "info": { "name": "Update customer billing data", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}:{port}{path}/v3/openmeter/customers/:customerId/billing", "params": [ { "name": "customerId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update customer billing data" }, { "info": { "name": "Update customer billing app data", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}:{port}{path}/v3/openmeter/customers/:customerId/billing/app-data", "params": [ { "name": "customerId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update customer billing app data" }, { "info": { "name": "Create Stripe Checkout Session", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/openmeter/customers/:customerId/billing/stripe/checkout-sessions", "params": [ { "name": "customerId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a [Stripe Checkout Session](https://docs.stripe.com/payments/checkout) for the customer.\n\nCreates a Checkout Session for collecting payment method information from customers.\nThe session operates in \"setup\" mode, which collects payment details without charging\nthe customer immediately. The collected payment method can be used for future\nsubscription billing.\n\nFor hosted checkout sessions, redirect customers to the returned URL. For embedded\nsessions, use the client_secret to initialize St" }, { "info": { "name": "Create Stripe customer portal session", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/openmeter/customers/:customerId/billing/stripe/portal-sessions", "params": [ { "name": "customerId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Stripe Customer Portal Session.\n\nUseful to redirect the customer to the Stripe Customer Portal to manage their payment methods,\nchange their billing address and access their invoice history.\nOnly returns URL if the customer billing profile is linked to a stripe app and customer." } ] } ], "bundled": true }